Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
git-pull-request

GitHub Action

SemRelease

v3.1.1

SemRelease

git-pull-request

SemRelease

Publish releases using tags, following sematic versioning

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: SemRelease

              
  uses: btnguyen2k/[email protected]
Learn more about this action in btnguyen2k/action-semrelease

Choose a version

SemRelease

Release Actions Status codecov

GitHub Action to publish releases using tags, following semantic versioning.

Usage

uses: btnguyen2k/action-semrelease@v1
with:
  github-token: ${{ secrets.GITHUB_TOKEN }}

How it works

This action extract release information either from a release notes or changelog file located in the root of the repository; or from commit messages if auto-mode is enabled.

auto-mode is available since version v2.0.0.

Auto-mode is NOT enabled

The release notes or changelog file is expected to be in Markdown, with each release information in a section with the following format:

## 2023-08-07 - v1.0.0

- Publish releases using tags, following semantic versioning.

## 2023-08-06 - v0.9.1

- Minor typo fixed.

👉 The section for the latest release must be at the top of the file. Version string and release notes are automatically extracted from the section title and content.

👉 The version string must follow Semantic Versioning spec, and can be optionally prefixed by letter v.

👉 This action scans the following files, in order, to extract release information: RELEASE-NOTES.md, RELEASE_NOTES.MD, RELEASE-NOTES, RELEASE_NOTES.md, RELEASE_NOTES.MD, RELEASE_NOTES, release-notes.md, release-notes, release_notes.md, release_notes, CHANGELOG.md, CHANGELOG.MD, CHANGELOG, CHANGE-LOG.md, CHANGE-LOG.MD, CHANGE-LOG, CHANGE_LOG.md, CHANGE_LOG.MD, CHANGE_LOG, changelog.md, changelog, change-log.md, change-log, change_log.md, change_log.

Auto-mode is enabled

This action scans commit messages to determine to release a new version. Release notes are automatically compiled from commit messages.

Sample commit message Release version
BREAKING: hash function parameter is no longer optional New major release
Changed hash function from MD5 to SHA1 New major release
Replace function GetRelease() with GetLatestRelease() New major release
Removed: deprecated function GetBranches() New major release
Deprecated: class CommitMessage is now deprecated New minor release
Refactor class HashUtils New minor release
Added new hash function HashUtils::hashSha1() New minor release
New feature: scan commit messages to build new release New minor release
Fixed typo in function HashUtils::hashMd5() New patch release
Patched: function HashUtils::Crc32() now returns correct value New patch release
Improve performance of function HashUtils::hashChain() New patch release
Dependency: bump krypto to v1.2.3 New patch release
Security: fix potential SQLi security vulnerability in class DbUtils New patch release

Inputs

Inputs are supplied via the with block. The following inputs are accepted:

Input Required Default Description
github-token Yes Either a PAT or GITHUB_TOKEN to access the repository.
dry-run No false If true, the action will run in dry-run mode.
tag-major-release No true If true, a major release tag will be created, e.g. v1
tag-minor-release No false If true, a minor release tag will be created, e.g. v1.2
tag-prefix No 'v' Prefix for release tags.
auto-mode [1] No false If true, auto-mode is enabled.
branches No 'main,master' Comma-separated list of branches to scan commit messages (auto-mode only!).

[1] auto-mode is available since version v2.0.0.

Outputs

Output Description
result The result of the action. Possible values: FAILED, SKIPPED, SUCCESS.
releaseVersion The released version string.
releaseNotes The release notes.

License

MIT - See LICENSE.md.