-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
514cb45
commit 418133f
Showing
1 changed file
with
18 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
## Workflow to release a new version `vX.Y.Z` | ||
This is a checklist for a new release. | ||
It assumes a - [ ] Push and open PR (base onto `master`). Also push tag: `git push origin --tag` | ||
|
||
- [ ] Create new branch `vX.Y.Z` from `dev` | ||
- [ ] Bump version in `CADETProcess/__init__.py` | ||
- [ ] Bump version in `.zenodo.json` and update authors | ||
- [ ] Add release notes in `docs/source/release_notes/vX.Y.Z.md` | ||
- [ ] General description | ||
- [ ] Deprecations / other changes | ||
- [ ] Closed Issues / PRs | ||
- [ ] Add entry in `index.md` | ||
- [ ] When ready, rebase again onto `dev` (in case changes were made) | ||
- [ ] Commit with message `vX.Y.Z` | ||
- [ ] Add tag (`git tag 'vX.Y.Z'`) and push tag: (`git push origin --tag`) | ||
- [ ] Merge into master | ||
- [ ] Make release on GitHub using tag and release notes. | ||
- [ ] Check that workflows automatically publish to PyPI and [https://cadet-process.readthedocs.io/] |