Skip to content

How to release

Bryan W. Weber edited this page Mar 9, 2018 · 6 revisions

This document includes the steps necessary in cutting a new release:

  1. Update the version number in pyked/_version.py
  2. Create a new h2 header (##) and section in CHANGELOG.md and move the list of Unreleased changes there. (Alternatively, copy and paste the Unreleased section so that it is duplicated. Delete the changes from the top copy and update the version number/date of the bottom copy.) Update the links at the bottom of that file.
  3. Bump version in CITATION.md in both citation examples
  4. Add new version to chemked-version list in pyked/schemas/chemked_schema.yaml
  5. Add and commit the changes to these files:
$ git add CHANGELOG.md CITATION.md pyked/_version.py pyked/schemas/chemked_schema.yaml
$ git commit -m ':gem: Release v#.#.#'
  1. Tag the commit, and push:
$ git tag -a v#.#.# -m "v#.#.#"
$ git push upstream --tags
  1. On GitHub, create a new release from the tag you just pushed, by going to Releases -> Tags -> Add release notes, and copy the relevant items from CHANGELOG.md
  2. Bump the version in pyked/_version.py by increasing the patch number and adding a fourth element 'a1'
__version_info__ = (#, #, #+1, 'a1')
                          ^^^  ^^^^
  1. Get the new DOI that Zenodo just minted for you from https://doi.org/10.5281/zenodo.597935
  2. Add this new DOI to the list at the end of CITATION.md
  3. Add the new release to the pyked/docs/releases.rst file, including the documentation link, release link, and Zenodo DOI
  4. Add, commit, and push the changes to these files:
git add CITATION.md pyked/docs/releases.rst pyked/_version.py
git commit -m 'Back to development'
git push upstream
  1. ⚡️ You're done! Enjoy your new version of PyKED!

Notes:

  1. If Travis seems to stop uploading conda packages, check whether the token from anaconda.org has expired
Clone this wiki locally