aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--release-checklist.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/release-checklist.md b/release-checklist.md
new file mode 100644
index 0000000..fcce6b0
--- /dev/null
+++ b/release-checklist.md
@@ -0,0 +1,13 @@
+# Checklist for New Releases
+
+- [ ] Update the version
+ - [ ] `pyproject.toml`
+ - [ ] `CHANGELOG.rst`
+- [ ] Generate an update script: `fietsupdate revision -c development.ini vX.Y.Z`
+- [ ] Commit those changes (`git add ... && git commit -m 'bump version to X.Y.Z'`)
+- [ ] Make sure the directory is clean (no uncommited changes)
+- [ ] Make sure the tests & lints pass
+ - [ ] Make sure they also do so on **Python 3.7** (current minimum version)
+- [ ] Create a new git tag: `git tag -a vX.Y.Z`
+- [ ] Push the tag to the remote repositories
+- [ ] Publish to PyPI: `poetry publish`