Skip to content

Commit a12c108

Browse files
committed
Move doc to RELEASE.md
1 parent 95acacb commit a12c108

File tree

2 files changed

+12
-132
lines changed

2 files changed

+12
-132
lines changed

doc/Development_Guide.md

Lines changed: 0 additions & 132 deletions
This file was deleted.

doc/RELEASE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## How to do a new libdivide release
2+
3+
Releases are semi-automated using GitHub actions:
4+
5+
1. Manually run the [Create draft release](https://github.com/ridiculousfish/libdivide/actions/workflows/prepare_release.yml) workflow/action.
6+
* This does some codebase housekeeping and creates a draft release.
7+
* This updates the version numbers in ```libdivide.h```, ```CMakeLists.txt```, ... and creates a new commit.
8+
* This creates a new git tag of format vX.Y.Z.
9+
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)
10+
3. Edit the generated release notes as needed & publish
11+
12+
Note that PRs with the ```ignore-for-release``` label are excluded from the generated release notes.

0 commit comments

Comments
 (0)