Skip to content

Commit

Permalink
Add release guide (#186)
Browse files Browse the repository at this point in the history
  • Loading branch information
schmoelder committed Dec 3, 2024
1 parent bd71fe2 commit 6ca1553
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/release.md
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/]

0 comments on commit 6ca1553

Please sign in to comment.