tormak9970/reliable-changelog

A reliable action for generating changelogs for commitlint commits.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
Runtime
Deprecated runtime
namedescriptionrequireddefault
github-tokenGithub tokenno${{ github.token }}
git-messageCommit message to usenochore(release): {version}
git-user-nameThe git user.name to use for the commitnoReliable Changelog Action
git-user-emailThe git user.email to use for the commitnoreliable.changelog.action@github.com
git-pull-methodThe git pull method used when pulling all changes from remoteno--ff-only
git-branchThe git branch to push changes tono${{ github.ref }}
git-urlGit Urlnogithub.com
tag-prefixPrefix to use for the new git tagnov
current-versionThe current version, or a relative path to a version file. Supported formats: "json", "toml", and "yaml".no./package.json
version-pathPath to the version property seperated by "."s. (**Note:** The version should be in the form `X.X.X`)noversion
strip-commit-prefixWhether to strip the commit prefixes (fix:, feat:, etc)notrue
major-release-commit-messageThe commit message used to signify a new major release.nofeat: major release
included-typesA string of comma separated commit types to include.nofeat,fix,build
minor-commit-typesComma seperated list of commit types that trigger minor version changes (0.X.0)nofeat
minor-version-bump-intervalThe number of minor version commits needed to bump the version past 1 in a single release.no5
patch-commit-typesComma seperated list of commit types that trigger patch version changes (0.0.X)nofix,build,docs,ci,perf,refactor,revert,style,test
patch-version-bump-intervalThe number of patch version commits needed to bump the version past 1 in a single release.no5
feat-section-labelThe label for the feat commits section.noNew Features
fix-section-labelThe label for the fix commits section.noBug Fixes
build-section-labelThe label for the build commits section.noBuild Pipeline Improvements
docs-section-labelThe label for the docs commits section.noDocumentation Changes
ci-section-labelThe label for the ci commits section.noCI Changes
perf-section-labelThe label for the perf commits section.noPerformance Improvements
refactor-section-labelThe label for the refactor commits section.noRefactoring
revert-section-labelThe label for the revert commits section.noReverted Changes
style-section-labelThe label for the style commits section.noStyling Changes
test-section-labelThe label for the test commits section.noTesting Changes
namedescription
changelogA tidied version of the generated changelog.
tagThe tag for the new release.
versionThe version for the new release.