ietf-tools/Semver Conventional Commits

Calculate the next release version based on conventional commits since latest tag

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
tokenGitHub Tokenyes
branchThe branch to use when fetching list of commits to compare againstnomain
majorListComma-separated commit prefixes, used to bump Major versionno""
minorListComma-separated commit prefixes, used to bump Minor versionnofeat, feature
patchListComma-separated commit prefixes, used to bump Patch versionnofix, bugfix, perf, refactor, test, tests
patchAllIf set to true, will ignore patchList and count any commit as a Patchnofalse
scopeListComma-separated list of scopes to include. When set, only commits whose conventional-commit scope matches one of these values will be considered. Leave empty to consider all scopes.no""
additionalCommitsA list of additional commit messages to parse in order to calculate semver.no
fallbackTagFallback tag to use if no latest tag is found. The fallback tag must exist already.no""
fromTagOverride the tag to use when comparing against the branch in order to fetch the list of commits.no""
maxTagsToFetchMaximum number of tags to fetch from latest.no10
noNewCommitBehaviorWhether to exit with an error, warning or silently when there are no new commits since the latest tag. (error, warn, current, silent)noerror
noVersionBumpBehaviorWhether to exit with an error, warning or silently when none of the commits result in a version bump. (error, warn, current, patch, silent)noerror
prefixA prefix that will be striped when parsing tags (e.g. `foobar/`). Any other prefix will be ignored. The prefix will be added back to the output values.no""
skipInvalidTagsIf set to true, will skip tags that are not valid semver until it finds a proper one (up to maxTagsFetch from latest).nofalse
tagFilterIf defined, only tags matching the regex pattern will be included (e.g. `^[a-f0-9.]+$`). Use a negative lookahead match to exclude tags (e.g. `^(?!abcd).*$`). When used in conjunction with the prefix option, the prefix is striped first, then the filter is applied.no""
namedescription
currentCurrent version number / latest tag.
nextNext version number in format v0.0.0
nextStrictNext version number without the v prefix.
nextMajorNext version major number in format v0
nextMajorStrictNext version major number only.
bumpNext version behavior.