GitHub Action
Generate changelog with git-chglog
Github Action for creating a CHANGELOG.md file based on semver and conventional commits.
Create a workflow .yml file in your repositories .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.
Further more you need to have git-chlog configured and have the configuration added to your git repository.
next_version
: Next version numberconfig_dir
: git-chglog configuration directory. Default:.ghglog
filename
: Filename to write the changelog to. Default:CHANGELOG.md
tag
: Optional, Generate changelog only for this tag.
changelog
: Changelog content if nofilename
input is empty
On every push
to master
generate a CHANGELOG.md file.
name: Build and release
on:
push:
branches:
- master
pull_request:
branches:
- master
jobs:
package:
runs-on: ubuntu-latest
steps:
- uses: nuuday/[email protected]
with:
next_version: "1.0.0"
The scripts and documentation in this project are released under the MIT License
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Steffen F. Qvistgaard - Initial work - ssoerensen
See also the list of contributors who participated in this project.