-
Notifications
You must be signed in to change notification settings - Fork 15
How to release
Kyle Niemeyer edited this page May 22, 2017
·
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. 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, commit, and push 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#.#.#'
$ git push upstream
- Tag the commit, and push:
$ git tag -a v#.#.# -m "v#.#.#"
$ git push upstream --tags
- Finally, 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.