|
||
---|---|---|
.github/workflows | ||
src | ||
.gitignore | ||
LICENSE | ||
README.md | ||
action.yml | ||
package.json | ||
yarn.lock |
README.md
Conventional Changelog action
This action will bump version, tag commit and generate a changelog with conventional commits.
Inputs
- Required
github-token
: Github token. - Optional
git-message
: Commit message that is used when committing the changelog. - Optional
preset
: Preset that is used from conventional commits. Defaultangular
. - Optional
tag-prefix
: Prefix for the git tags. Defaultv
. - Optional
output-file
: File to output the changelog to. DefaultCHANGELOG.md
. - Optional
changelog-release-count
: Number of releases to preserve in changelog. Default5
, use0
to regenerate all.
Example usage
- name: Conventional Changelog Action
uses: TriPSs/conventional-changelog-action@v1.2.0
with:
github-token: ${{ secrets.github_token }}
git-message: 'chore(release): {version}'
preset: 'angular'
tag-prefix: 'v'
output-file: 'CHANGELOG.md'
changelog-release-count: 5