tripss/Conventional Changelog Action

Bump version, tag commit and generates changelog with conventional commits.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
github-tokenGithub tokenno${{ github.token }}
git-messageCommit message to usenochore(release): {version}
git-user-nameThe git user.name to use for the commitnoConventional Changelog Action
git-user-emailThe git user.email to use for the commitnoconventional.changelog.action@github.com
git-pull-methodThe git pull method used when pulling all changes from remoteno--ff-only
git-pushShould all the git changes be pushnotrue
git-branchThe git branch to be pushedno${{ github.ref }}
presetThe preset from Conventional Changelog to usenoangular
tag-prefixPrefix that is used for the git tagnov
input-fileRead the changelog from this file. This will prepend the newly generated changelogs to the file's contentno
output-fileFile to output the changelog tonoCHANGELOG.md
release-countNumber of releases to preserve in changelog. Default `5`, use `0` to regenerate all. This input has no effect if input-file is usedno5
version-fileThe path to the file that contains the version to bump (supports comma-separated list of file paths)no./package.json
version-pathThe place inside the version file to bumpnoversion
skip-git-pullDo not pull the repo before tagging. Ensure you full cloned the repo in the first place to get tagsnofalse
skip-on-emptyDo nothing when the changelog from the latest release is emptynotrue
skip-version-fileDo not update the version filenofalse
skip-commitDo create a release commitnofalse
skip-tagDo not tag the release. Helpful for using action to check if a release is going to be madenofalse
pre-commitPath to the pre-commit script fileno
fallback-versionThe fallback version, if no older one can be detected, or if it is the first oneno
config-file-pathPath to the conventional changelog config file. If set, the preset setting will be ignoredno
pre-changelog-generationPath to the pre-changelog-generation script fileno
git-urlGit Urlnogithub.com
git-pathPath filter for the logs and version. If set, only commits that match the path filter will be consideredno""
skip-ciAdds [skip ci] to commit message, to avoid triggering a new buildnotrue
create-summaryAdds the generated changelog as Action Summarynofalse
pre-releaseMarks the release as pre-releasenofalse
pre-release-identifierThe identifier to use for pre-releasesnorc
pre-release-smart-bumpIf a pre-release is already targeting the same release type, only the pre-release counter is incremented.nofalse
skip-bumpPrevents the action from bumping the versionnofalse
no-verifyRun git commit with `no-verify` option.nofalse
namedescription
changelogThe generated changelog for the new version
clean_changelogThe generated changelog for the new version without the version name in it
versionThe new version
tagThe name of the generated tag
skippedboolean to check if this step have been skipped