Skip to content

Commit

Permalink
Merge pull request #82 from OpenFreeEnergy/add_release_template
Browse files Browse the repository at this point in the history
add release checklist
  • Loading branch information
atravitz authored Dec 17, 2024
2 parents ec29fd3 + c73d3ee commit 741cfe8
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/release_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!--
Checklist for releasing a new version of kartograf.
-->

Make the PR:
* [ ] Create a new release-prep branch corresponding to the version name, e.g. `release-prep-v1.2.0`. Note: please follow [semantic versioning](https://semver.org/).
* [ ] Check that all user-relevant updates are included in the `news/` rever `.rst` files. You can backfill any additional items by making a new .rst, e.g. `backfill.rst`
* [ ] Run [rever](https://regro.github.io/rever-docs/index.html#), e.g. `rever 1.2.0`. This will auto-commit `docs/CHANGELOG.md` and remove the `.rst` files from `news/`.
* [ ] Verify that`docs/CHANGELOG.md` looks correct.
* [ ] Make the PR and verify that CI/CD passes.
* [ ] Merge the PR into `main`.

After Merging the PR [follow this guide](https://github.com/OpenFreeEnergy/openfe/wiki/How-to-create-a-new-release)

0 comments on commit 741cfe8

Please sign in to comment.