-
Notifications
You must be signed in to change notification settings - Fork 16
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:
- Update the version number in
pyked/_version.py - Create a new h2 header (
##) and section inCHANGELOG.mdand move the list ofUnreleasedchanges there. (Alternatively, copy and paste theUnreleasedsection 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. - Bump version in
CITATION.mdin both citation examples - Add new version to
chemked-versionlist inpyked/schemas/chemked_schema.yaml - 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#.#.#'
- Tag the commit, and push:
$ git tag -a v#.#.# -m "v#.#.#"
$ git push upstream --tags
- 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 - Bump the version in
pyked/_version.pyby increasing the patch number and adding a fourth element'a1'
__version_info__ = (#, #, #+1, 'a1')
^^^ ^^^^
- Get the new DOI that Zenodo just minted for you from https://doi.org/10.5281/zenodo.597935
- Add this new DOI to the list at the end of
CITATION.md - Add the new release to the
pyked/docs/releases.rstfile, including the documentation link, release link, and Zenodo DOI - 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
- ⚡️ You're done! Enjoy your new version of PyKED!
Notes:
- If Travis seems to stop uploading conda packages, check whether the token from anaconda.org has expired