Skip to content

New Release Version Bump Workflow

Workflow Overview

Scicat Backend controls new releases with the GitHub-tag-and-release GitHub Action. This workflow is triggered by push events to the release branch. It automates the version bumping and release processes based on semantic commit messages. Full documentation of the action package can be found on github-tag-action

The image below shows visualized workflow. image

Workflow Trigger Condition

[!Caution]
Any push to the release branch initiates the workflow.

Versioning and Release Strategy

Semantic Versioning:

  • The version is automatically bumped according to the semantic PR titles, using the semantic-release conventions:

  • fix: prefixed titles generate a patch release.

  • feat: prefixed titles generate a minor release.
  • BREAKING CHANGE: in the commit message triggers a major release.

Auto-generated Release Notes:

The release log is automatically populated with all commit messages since the last tag, providing a detailed changelog for the release. By default semantic-release uses Angular Commit Message Conventions.