Issuing Releases

Last Updated: December 2018

This article provides an overview of the procedure that should be followed to issue new releases of Tethys Platform.

1. Checkout Release Candidate Commit

Checkout the commit that will be used for the release (often the HEAD of master).

1. Update Version References

1. Setup.py

Update the version parameter in the setup.py file if it was not done already.

2. Documentation

Update the version number in the docs/conf.py and all documentation pages that are applicable (e.g.: docs/index.rst). Do a search for the version number on the entire docs directory to find other places where the version number needs updating or phrasing needs to be changed to refer to the older version in past tense.

3. README

Update the version number in the README if necessary.

Note

You may only need to update the version in one place since we started using pbr.

1. Commit and Tag

Commit the version changes and tag the commit using pattern X.Y.Z.

1. Push to new branch and submit PR to release

Push the tagged commit to a new branch (not master) and then submit a PR to the release branch.

1. Merge

Once checks have finished and concerns have been resolved, merge into release.