Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 1.57 KB

RELEASE.md

File metadata and controls

27 lines (22 loc) · 1.57 KB
Raw

Steps when releasing actinia-api:

0. Steps for major updates

  • If the release is a major update, it needs to be prepared like described in the WIKI.

1. Prepare release and version

  • Run in terminal 
    ESTIMATED_VERSION=3.0.1

gh api repos/mundialis/actinia-api/releases/generate-notes -f tag_name="$ESTIMATED_VERSION" -f target_commitish=main -q .body
  • Go to https://github.com/mundialis/actinia-api/releases/new
  • Copy the output of terminal command to the release description
  • Change heading ## What's Changed to ### Changed, ### Fixed, ### Added or what applicable and sort list amongst these headings.
  • 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/mundialis/actinia-api/releases/generate-notes -f tag_name="$ESTIMATED_VERSION" -f target_commitish=main -q .body" and replace $ESTIMATED_VERSION with the actual version.
  • DO NOT click "save" yet!!

2. Update pyproject.toml

3. Release

  • Now you can save the release