From 0307de0e2f4d84a5671c2af2fd2166327903d483 Mon Sep 17 00:00:00 2001 From: tx_haggis <13982343+adbancroft@users.noreply.github.com> Date: Fri, 1 Nov 2024 14:38:59 -0500 Subject: [PATCH] Additional release process details. --- doc/RELEASE.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/RELEASE.md b/doc/RELEASE.md index 8c3728f..05f7737 100644 --- a/doc/RELEASE.md +++ b/doc/RELEASE.md @@ -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.