Skip to content

Commit

Permalink
Update RELEASE_HOWTO.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dschwoerer authored Sep 13, 2023
1 parent ebc0051 commit 70c808e
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions manual/RELEASE_HOWTO.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ releases
- [ ] Run `make check-all`
- Raise issues for any tests that fail
- Possibly run `clang-tidy`, `clang-check`, `coverity`, etc.
- [ ] Review pinned pip package versions for Travis
- [ ] Review pinned pip package versions for CI

Before merging PR:

Expand Down Expand Up @@ -50,14 +50,17 @@ Before merging PR:
- [ ] [`manual/doxygen/Doxyfile_readthedocs`][Doxyfile_readthedocs]: `PROJECT_NUMBER`
- [ ] [`manual/doxygen/Doxyfile`][Doxyfile]: `PROJECT_NUMBER`
- [ ] [`CMakeLists.txt`][CMakeLists]: `_bout_previous_version`, `_bout_next_version`
- [ ] [`tools/pylib/_boutpp_build/backend.py`][backend.py]: `_bout_previous_version`, `_bout_next_version`


After PR is merged:

- [ ] Try to summarise the changes!
- [ ] Make [GitHub Release][gh_release], include change summary **NB:** tag should have
leading `v`
- [ ] Make tarball: `cmake -S . -B build && make dist -C build`
- [ ] Check tarball:
- [ ] Is the folder name correct?
- [ ] grep for the version - is always the released version used, not a pre-release?
- [ ] Upload tarball to GitHub Release
- [ ] Upload tarball to Zenodo and publish new version
- [ ] Email BOUT++ User Group mailing list, include change summary
Expand All @@ -72,7 +75,6 @@ After PR is merged:
- [ ] [`manual/doxygen/Doxyfile`][Doxyfile]: `PROJECT_NUMBER`
- [ ] [`CMakeLists.txt`][CMakeLists]: `_bout_previous_version`, `_bout_next_version`
- [ ] [`tools/pylib/_boutpp_build/backend.py`][backend.py]: `_bout_previous_version`, `_bout_next_version`
- [ ] Make tarball: `cmake -S . -B build && make dist -C build`

[Doxyfile]: ../manual/doxygen/Doxyfile
[Doxyfile_readthedocs]: ../manual/doxygen/Doxyfile_readthedocs
Expand Down

0 comments on commit 70c808e

Please sign in to comment.