Steps when releasing:
- Option 1:
- Go to new release
- set dummy-tag -> click
Generate release notes
- Option 2:
- run in terminal
ESTIMATED_VERSION=1.0.4 REPO_NAME=mundialis/github-workflows gh api repos/$REPO_NAME/releases/generate-notes -f tag_name="$ESTIMATED_VERSION" -f target_commitish=main -q .body - Go to new release
- Copy the output of terminal command to the release description
- 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_NAMEand$ESTIMATED_VERSIONwith the actual version.
- run in terminal
- You can compare manually if all changes are included. If changes were pushed directly to main branch, they are not included.
- Check if
ESTIMATED_VERSIONincrease still fits - we follow Semantic Versioning. - Fill in tag and release title with this 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