This GitHub action creates a release with a simple changelog when a tag is pushed and is based on the Automatic Releases action. The changelog is generated out of commits between the current and the latest tag. Commits can optionally be filtered by a regex pattern to only include matching messages. Commit messages are parsed following the Conventional Commits specification.
A workflow using this actions looks as follows:
name: "release-notes"
on:
push:
tags:
- "*"
jobs:
release-notes:
name: "Regex Filtered Release Notes"
runs-on: "ubuntu-latest"
steps:
- uses: "marcantondahmen/release-notes-action@master"
with:
repo_token: "${{ secrets.GITHUB_TOKEN }}"
prerelease: false
draft: false
filter: "^(feat|fix)"
strict: true
The following options are available to configure a workflow.
| Name | Description |
|---|---|
| repo_token | GitHub secret token (required) |
| draft | Release is a draft (false) |
| prerelease | Release is a pre-release (false) |
| filter | Filter the included commit messages by a given regex ("^(feat|fix)") |
| strict | Only include commit messages that follow the conventional commits scheme (true) |
