Skip to content

Latest commit

 

History

History
24 lines (15 loc) · 744 Bytes

RELEASING.md

File metadata and controls

24 lines (15 loc) · 744 Bytes
Raw

Releasing

Releases are automatically created from added tags using GitHub Actions.

A tag needs to be in the form of v{major}.{minor}.{patch}.

Release preparation

  1. Create a release branch of from main branch with this pattern:

    • release/{major}.{minor}/prepare-{major}.{minor}.{patch}

  2. Update CHANGELOG.md by creating a new Unreleased section and change current unreleased to release version

  3. Update the latest release badge

Release

For a release, we use GitHub releases:

  1. Create a new release
  2. Set the tag
  3. Set the title
  4. Add a description in form of a changelog
  5. Publish when ready