Skip to content

Commit

Permalink
Updated release notes
Browse files Browse the repository at this point in the history
Add more specific git commands for certain stages
  • Loading branch information
graeme-a-stewart committed May 3, 2024
1 parent 69f58c2 commit 440361d
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion doc/RELEASE_PROCEDURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,26 @@
1. On the `main` branch make the last feature commits and ensure that all
tests pass.
2. Update the release number in `CMakeLists.txt` and commit.
- To commit directly, use the command line
3. Update the `stable` branch to this commit in `main`.
- e.g., `git branch -f stable main`
4. Make a tag, following a semantic versioning scheme `vA.B.C`.
- Use an *annotated* tag, add brief release notes in the annotation.
- e.g., `git tag -a v3.1.0`
- This is an *annotated* tag - add brief release notes in the annotation.
5. Push changes to GitHub.
- `git push origin tag v3.1.0`
- Again, from command line to bypass normal branch protection
6. Prepare a binary tarball of the static build to add to the release:
- On AlamaLinux install the packages `glibc-static` and `libstdc++-static`
- `cmake -DBUILD_STATIC=ON <PATH_TO_SOURCES>`
- By hand, strip the `prmon` binary to reduce its size
- `make package`
- Use the `tar.gz` archive.
6. In GitHub go to releases, *Draft a new release*.
7. Select the new tag.
8. Add release notes as needed.
- Github does a good job of generating changelogs now, so just add major
items at the top of the notes
9. Add the binary tarball to the release.

## Zenodo
Expand Down

0 comments on commit 440361d

Please sign in to comment.