|
1 | 1 | --- |
2 | 2 | name: Release checklist |
3 | 3 | about: '[for maintainer use]' |
4 | | -title: 'Release 5.4.0' |
| 4 | +title: 'Release 6.0.0' |
5 | 5 | labels: '' |
6 | | -assignees: 'joaander' |
7 | 6 |
|
8 | 7 | --- |
9 | 8 |
|
10 | | -Minor and major releases: |
| 9 | +To make a new HOOMD-blue release: |
11 | 10 |
|
12 | | -- [ ] Update tutorial submodule. |
| 11 | +- [ ] Make a new `release-{X.Y.Z}` branch (where `{X.Y.Z}` is the new version). |
| 12 | + |
| 13 | +On that branch, take the following steps (committing after each step when needed): |
| 14 | + |
| 15 | +- [ ] Run `prek autoupdate` |
13 | 16 | - [ ] Check for new or duplicate contributors since the last release: |
14 | 17 | `comm -13 (git log $(git describe --tags --abbrev=0) --format="%aN <%aE>" | sort | uniq | psub) (git log --format="%aN <%aE>" | sort | uniq | psub)`. |
15 | 18 | Add entries to `.mailmap` to remove duplicates. |
| 19 | +- [ ] Update tutorial submodule. |
16 | 20 | - [ ] Ensure that added features have Sybil examples. |
| 21 | +- [ ] Review `CHANGELOG.rst` and revise if needed. |
| 22 | +- [ ] Run `bump-my-version bump {type}`. Replace `{type}` with: |
| 23 | + - `patch` when this release *only* includes bug fixes. |
| 24 | + - `minor` when this release includes new features and possibly bug fixes. |
| 25 | + - `major` when this release includes API breaking changes. |
| 26 | +- [ ] Push the branch and open a pull request. |
| 27 | +- [ ] Check that readthedocs builds the docs correctly in the pull request checks. |
| 28 | +- [ ] Merge the pull request after all tests pass. |
| 29 | +- [ ] Make a new tag on the trunk branch: |
| 30 | + ``` |
| 31 | + git switch trunk |
| 32 | + git pull |
| 33 | + git tag -a v{X.Y.Z} |
| 34 | + git push origin --tags |
| 35 | + ``` |
| 36 | + |
| 37 | +> [!IMPORTANT] |
| 38 | +> Make sure to **include** `v` in the tag name! |
| 39 | +
|
| 40 | +- [ ] Add a blank release notes entry for the next release: |
| 41 | + ``` |
| 42 | + Next release |
| 43 | + ^^^^^^^^^^^^^^^^^^^^ |
| 44 | +
|
| 45 | + *Added* |
| 46 | +
|
| 47 | + *Changed* |
| 48 | +
|
| 49 | + *Deprecated* |
| 50 | +
|
| 51 | + *Removed* |
| 52 | +
|
| 53 | + *Fixed* |
| 54 | + ``` |
| 55 | + |
| 56 | +> [!NOTE] |
| 57 | +> Paste `Next release` exactly as shown. `bump-my-version` will replace that |
| 58 | +> string with the version number and date. |
| 59 | +
|
| 60 | +GitHub Actions will trigger on the tag and create a GitHub release. After a few |
| 61 | +hours, the conda-forge autotick bot will submit a PR for the new release. |
| 62 | + |
| 63 | +- [ ] Check that the GitHub release posted correctly: https://github.com/glotzerlab/hoomd-blue/releases |
| 64 | +- [ ] Merge the conda-forge recipe, updating it first if necessary (e.g. when adding dependencies). |
| 65 | +- [ ] Update *glotzerlab-software*. Build the new version on: |
| 66 | + - [ ] Great Lakes |
| 67 | + - [ ] Anvil |
| 68 | + - [ ] Delta |
| 69 | + - [ ] Frontier |
| 70 | + - [ ] Andes |
| 71 | + |
| 72 | +For major and minor releases: |
| 73 | + |
| 74 | +- [ ] Test *hoomd-component-template* against the new version. |
| 75 | +- Sync those changes with: |
| 76 | + - [ ] *hoomd-md-pair-template*. |
| 77 | + - [ ] *hoomd-hpmc-shape-template*. |
| 78 | + - [ ] *hpmc-energy-template*. |
17 | 79 | - [ ] Run [hoomd-benchmarks](https://github.com/glotzerlab/hoomd-benchmarks), check for performance |
18 | 80 | regressions with the previous release, and post the tables in the release pull request. |
19 | 81 | - [ ] Run [hoomd-validation](https://github.com/glotzerlab/hoomd-validation). |
20 | | - |
21 | | -All releases: |
22 | | - |
23 | | -- [ ] Run `prek autoupdate` |
24 | | -- [ ] Run *bump-my-version*. |
25 | | -- [ ] Review change log. |
26 | | -- [ ] Check readthedocs build, especially change log formatting. |
27 | | -- [ ] Tag and push. |
28 | | -- [ ] Update conda-forge recipe. |
29 | | -- [ ] Update *glotzerlab-software*. |
30 | | -- [ ] Update *hoomd-component-template*. |
31 | | -- [ ] Update *hoomd-md-pair-template*. |
32 | | -- [ ] Update *hoomd-hpmc-shape-template*. |
33 | | -- [ ] Update *hpmc-energy-template*. |
|
0 commit comments