-
Notifications
You must be signed in to change notification settings - Fork 15
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.md
and move the list ofUnreleased
changes there. (Alternatively, copy and paste theUnreleased
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. - Bump version in
CITATION.md
in both citation examples, and add DOI for prior version to list at the bottom. - Add new version to
chemked-version
list 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
- ⚡️ You're done! Enjoy your new version of PyKED and the associated DOI that Zenodo just minted for you.