Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions docs/Development/Release-Process.md
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
Copy link
Member

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?

Copy link
Member Author

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.

Copy link
Contributor

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?

Copy link
Member Author

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.

Copy link
Contributor

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?

Copy link
Member Author

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?


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
Copy link
Member

Choose a reason for hiding this comment

The 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

Copy link
Member Author

Choose a reason for hiding this comment

The 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.