Skip to content

Commit 210f366

Browse files
committed
Add release checklist and PR template
1 parent 3611bdb commit 210f366

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
### Checklist
3+
- [ ] Pull request details were added to CHANHELOG.rst

.github/release_checklist.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
Release checklist
2+
- [ ] Check outstanding issues on JIRA and Github.
3+
- [ ] Check [latest documentation](https://python-isal.readthedocs.io/en/latest/) looks fine.
4+
- [ ] Create a release branch.
5+
- [ ] Set version to a stable number.
6+
- [ ] Change current development version in `CHANGELOG.rst` to stable version.
7+
- [ ] Merge the release branch into `main`.
8+
- [ ] Create a test pypi package from the main branch. ([Instructions.](
9+
https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives
10+
))
11+
- [ ] Install the packages from the test pypi repository to see if they work.
12+
- [ ] Created an annotated tag with the stable version number. Include changes
13+
from CHANGELOG.rst.
14+
- [ ] Push tag to remote.
15+
- [ ] Push tested packages to pypi.
16+
- [ ] merge `main` branch back into `develop`.
17+
- [ ] Add updated version number to develop.
18+
- [ ] Build the new tag on readthedocs. Only build the last patch version of
19+
each minor version. So `1.1.1` and `1.2.0` but not `1.1.0`, `1.1.1` and `1.2.0`.
20+
- [ ] Create a new release on github.
21+
- [ ] Update the package on conda-forge.

0 commit comments

Comments
 (0)