From 440361df48b9eec48ccb67de08a77251d30fbac8 Mon Sep 17 00:00:00 2001 From: Graeme A Stewart Date: Fri, 3 May 2024 16:52:29 +0200 Subject: [PATCH] Updated release notes Add more specific git commands for certain stages --- doc/RELEASE_PROCEDURE.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/doc/RELEASE_PROCEDURE.md b/doc/RELEASE_PROCEDURE.md index 8a7c1a0..fc7b2d6 100644 --- a/doc/RELEASE_PROCEDURE.md +++ b/doc/RELEASE_PROCEDURE.md @@ -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 ` + - 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