-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
anikaweinmann
committed
May 21, 2024
1 parent
84f8ec2
commit 07fc526
Showing
1 changed file
with
20 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Release and version | ||
|
||
Steps when releasing: | ||
|
||
- Run in terminal | ||
``` | ||
ESTIMATED_VERSION=1.0.0 | ||
REPO_NAME=mundialis/grass-gis-helpers | ||
gh api repos/$REPO_NAME/releases/generate-notes -f tag_name="$ESTIMATED_VERSION" -f target_commitish=main -q .body | ||
``` | ||
- Go to [new release](../../releases/new) | ||
- Copy the output of terminal command to the release description | ||
- You can [compare manually](../../compare/1.0.0...main) if all changes are included. If changes were pushed directly to main branch, they are not included. | ||
- Check if `ESTIMATED_VERSION` increase still fits - we follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
- Fill in tag and release title with this version | ||
- At the bottom of the release, add | ||
"generated with `gh api repos/$REPO_NAME/releases/generate-notes -f tag_name="$ESTIMATED_VERSION" -f target_commitish=main -q .body`" and replace `$REPO_NAME` and `$ESTIMATED_VERSION` with the actual version. | ||
- Make sure that the checkbox for "Set as the latest release" is checked so that this version appears on the main github repo page | ||
- Now you can save the release |