-
Notifications
You must be signed in to change notification settings - Fork 599
docs: Add release process notes #550
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
josegonzalez
wants to merge
1
commit into
master
Choose a base branch
from
josegonzalez-patch-1
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Release Process | ||
|
||
From early on, Diamond was run as a master is stable release style. The belief was that master should always be stable and ready to deploy to production. This lead to the odd release system we currently have. | ||
|
||
## Version String | ||
|
||
The current version is generated by the bash script at https://github.com/python-diamond/Diamond/blob/master/version.sh | ||
|
||
The major and minor version numbers are generated based on the latest annotated tag. | ||
|
||
Cutting a new major/minor version is done via: | ||
|
||
```shell | ||
git tag -a v4.1 -m "foobar" | ||
git push origin --tags | ||
``` | ||
|
||
From this point forward, the makefile will generate a version starting with 4.1 | ||
|
||
The point release is then generated via the count of the number of commits from the latest tag to HEAD. This gave us a simple, always incrementing version number that allowed us to track back exactly where a package was generated from the origin. | ||
|
||
However, this has caused issues where anyone building a package from a different origin/fork would have mismatched version numbers. This was intended to be fixed via adding the short hash to the version string, however this proved brittle, as RPMs and DEBs failed to build properly with the changed version string. | ||
|
||
Testing the version code can be done via | ||
|
||
```shell | ||
make vertest | ||
``` | ||
|
||
This will build the version.txt file and echo out it's contents | ||
|
||
## pypi | ||
|
||
The pypi package can be found at https://pypi.python.org/pypi/diamond | ||
|
||
Currently the three maintainers are: | ||
|
||
- kormoc | ||
- mattrobenolt | ||
- savant | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could you include me here. I believe I have acce to upload releases There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Will do. |
||
|
||
I am happy to add anyone who should have the ability to cut releases. | ||
|
||
I would use the `make pypi` command to upload a new release. | ||
|
||
This used to run a version update and then `python setup.py sdist upload`. | ||
|
||
Recently mattrobenolt updated the code to use https://pypi.python.org/pypi/twine , which is a much safer solution. | ||
|
||
I believe both still require configuring `~/.pypirc` with something similar to: | ||
|
||
```ini | ||
[distutils] | ||
index-servers = | ||
pypi | ||
|
||
[pypi] | ||
username:foo | ||
password:bar | ||
``` | ||
|
||
Currently once a new version is uploaded, we 'hide' old versions. They can still be reterived by specifying the version directly, however they won't show up as available unless you know the full version string. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we need some guidelines for versioning. How about x.x.x:
Major - Major features, possible backwards incompatible changes, etc.
Minor - New collectors/handlers
Patch - Minor bug fixes, collector tweaks
What do you think? Would the minor number bump up too often with this scheme?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That seems reasonable to me. Will modify the pull request.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As we start splitting up collectors into individual repos, how would that change these versions numbers?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We'd do a major release at that point.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I wasn't clear. If we split up all collectors/handlers into their own repos, what is a minor point release of the core at that point? Or do we bring them all together to package them so it's purely just a code artifact that they're split up?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure how a splitup works, but in theory if we add new - non-breaking - functionality to the core, thats a minor release?