-
Notifications
You must be signed in to change notification settings - Fork 24
New Release
Alon Grinberg Dana edited this page Jul 31, 2019
·
2 revisions
To make a new ARC release, do the following:
- On GitHub, click
releases- give the tag version, e.g.,
1.1.0 - give a release title, e.g.,
ARC Version 1.1.0 - Give a full description of changes since the last release, including PR numbers.
Use the following headers to separate changes:
New features,Bug Fixes,Documentation,Miscellaneous,Backward incompatible changes,New dependencies. - (don't actually release yet...)
- give the tag version, e.g.,
- Create a new branch (e.g., release1.1.0), and commit the following changes:
- Increase the version in common.py (
VERSION) - Add the above release notes to the
release.rstin the documentation (note that rst requires line breaks between different list levels). Under ARC/docs typemake htmland make sure all changes look good.
- Increase the version in common.py (
- Push the branch, wait for tests, merge.
- Publish the release on GitHub (should include the latest version increase commit)
- If you'd like to issue a new DOI for this release, go to zenodo.org, click
Upload, review the changes (make sure all authors appear and their names and ORCIDs are correct) and clickPublish. - Increase the version in
README.md(in the release badge link) and update the DOI badge link. - Modify the
How to cite ARCsection of the documentation, possibly as a new PR.