A configurable commit-based changelog generator. It finds commits since the previous release, filters them, then groups them.
Generated changelogs look similar to the changelogs generated by GoReleaser, making this action a great fit for projects where another build tool is used.
| Name | Description | Default |
|---|---|---|
output |
Generated changelog path. | |
path |
Path to the local git repository | "." |
config |
Path to the config file. | .changelog-generator.yaml |
token |
GitHub token used to fetch release assets. | ${{ github.token }} |
install-only |
Installs changelog-generator without running it | "false" |
| Name | Description |
|---|---|
changelog |
The generated changelog markdown. |
name: Release
on:
push:
tags:
- "v*.*.*"
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Generate Changelog
uses: gabe565/changelog-generator-action@v1
id: changelog
- name: Release
uses: softprops/action-gh-release@v2
with:
body: ${{ steps.changelog.outputs.changelog }}Changelog Generator can be configured by committing a file to one of the paths listed below. See the config example for available configuration documentation.
.changelog-generator.yaml.github/changelog-generator.yaml.goreleaser.yaml.
Changelog Generator can also be installed for local generation and previews.
Click to expand
-
If you don't have it already, install the
ca-certificatespackagesudo apt install ca-certificates
-
Add gabe565 apt repository
echo 'deb [trusted=yes] https://apt.gabe565.com /' | sudo tee /etc/apt/sources.list.d/gabe565.list -
Update apt repositories
sudo apt update
-
Install changelog-generator
sudo apt install changelog-generator
Click to expand
-
If you don't have it already, install the
ca-certificatespackagesudo dnf install ca-certificates
-
Add gabe565 rpm repository to
/etc/yum.repos.d/gabe565.repo[gabe565] name=gabe565 baseurl=https://rpm.gabe565.com enabled=1 gpgcheck=0
-
Install changelog-generator
sudo dnf install changelog-generator
Click to expand
Install changelog-generator-bin with your AUR helper of choice.
Click to expand
Install changelog-generator from gabe565/homebrew-tap:
brew install gabe565/tap/changelog-generatorClick to expand
Download and run the latest release binary for your system and architecture.