tgcs-ecp/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
Runtime
Deprecated runtime
namedescriptionrequireddefault
github-tokenGithub tokenno
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
presetThe preset from Conventional Changelog to usenoangular
tag-prefixPrefix that is used for the git tagnov
output-fileFile to output the changelog tonoCHANGELOG.md
release-countNumber of releases to preserve in changelogno5
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
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 oneno0.1.0
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
commit-pathGenerate a changelog scoped to a specific directoryno
skip-tagSkip creating the git tagnofalse
version-from-gitTry getting the version from `git` tags instead of using the version filenofalse
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