Skip to content

Latest commit

 

History

History
20 lines (17 loc) · 1.07 KB

RELEASE.md

File metadata and controls

20 lines (17 loc) · 1.07 KB
Raw

Release and version

Steps when releasing:

  • Run in terminal 
    ESTIMATED_VERSION=1.0.0
REPO_NAME=mundialis/v.example

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
  • You can compare manually 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.
  • 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