Add release checklist

This commit is contained in:
Dan Yeaw 2020-12-03 22:21:26 -05:00 committed by GitHub
parent ea47ae663f
commit 4265e1e13e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

18
RELEASE_CHECKLIST.md Normal file
View File

@ -0,0 +1,18 @@
Although we strive to make releases as automated as possible, there are a few steps that we need to take to release a new version.
- [ ] Ensure all of the PRs since the last release are labeled with chore, fix, feature, or skip-changelog.
All of the items in the draft release should be under the Features, Bug Fixes, or Maintenance headings.
- [ ] Test the previous build packages in Windows and macOS to ensure they launch successfully.
- [ ] Bump the version by updating it in the `pyproject.toml` file or by running `poetry version X.X.X`.
- [ ] Go to the release, click on edit draft. Add a summary to the title in the draft release.
- [ ] In the draft release, update the version tag to the correct version (remove the v in front). Click on Publish Release.
- [ ] Wait for the build to finish and the release artifacts to be uploaded. The PyPI release is made automatically during
the build.
- [ ] In the https://github.com/flathub/org.gaphor.Gaphor repo, create a new branch. Run `make update VERSION=X.X.X`.
Commit your changes and create a PR.
- [ ] Wait for the build to finish, install the test build using the instructions, and ensure that it launches using
`flatpak run org.gaphor.Gaphor`.
- [ ] Merge the PR.
- [ ] In the https://github.com/gaphor/gaphor.github.io repo, edit the `_config.yml` file and set the `gaphor_version` to the
updated version.
- [ ] Announce the new version on Twitter. :tada: