Skip to content

Commit

Permalink
Additional release process details.
Browse files Browse the repository at this point in the history
  • Loading branch information
adbancroft committed Nov 1, 2024
1 parent 7b57396 commit 0307de0
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions doc/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
Releases are semi-automated using GitHub actions:

1. Manually run the [Create draft release](https://github.com/ridiculousfish/libdivide/actions/workflows/prepare_release.yml) workflow/action.
* This does some codebase housekeeping and creates a draft release.
* This updates the version numbers in ```libdivide.h```, ```CMakeLists.txt```, ... and creates a new commit.
* This creates a new git tag of format vX.Y.Z.
2. Follow the output link in the action summary to the generated draft release. E.g. ![image](https://github.com/user-attachments/assets/7e8393f7-f204-4b3a-af37-de5e187479dc)
* Choose the branch to release from (usually ```master```) and the release type (based on [Semantic Versioning](https://semver.org/))
* The action will do some codebase housekeeping and create a draft release:
* Creaters a new commit with updated version numbers in ```libdivide.h```, ```CMakeLists.txt```, ```library.properties```.
* Creates a draft Git tag of format vX.Y.Z.
2. Once the action is complete, follow the output link in the action summary to the generated draft release. E.g. ![image](https://github.com/user-attachments/assets/7e8393f7-f204-4b3a-af37-de5e187479dc)
3. Edit the generated release notes as needed & publish

Note that PRs with the ```ignore-for-release``` label are excluded from the generated release notes.

0 comments on commit 0307de0

Please sign in to comment.