bullrich/Commit Autotag

Automatically generate new tags for new versions. Supports several tagging strategies.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stalelast commit Dec 20, 2021
License: MIT

Pinned Snippet

workflow.ymlSHA-pinned

uses: bullrich/commit-autotag@365442a73444d9b59ae92b051e19f4b4281f42fa # v1.0.1

tags can be moved; commit SHAs can't. why a SHA?

Inputs

name	description	required	default
root	Autotag will look for the appropriate file in in this location (relative to project root).	no	./
head_branch	Head branch to compare changes. It uses master by default	no	master
strategy	Options include 'package' (for package.json), 'docker' (for Dockerfile), and 'regex' to extract from an arbitrary file. This does not need to be specified if the "regex_pattern" property is provided.	no	package
tag_prefix	By default, package.json uses semantic versioning, such as "1.0.0". A prefix can be used to add text before the tag name. For example, if tag_prefx is set to "v", then the tag would be labeled as "v1.0.0".	no	—
tag_suffix	Text which is applied to the end of the tag.	no	—
tag_message	This is the annotated commit message associated with the tag. By default, a changelog will be generated from the commits between the latest tag and the new tag (HEAD). This will override that with a hard-coded message.	no	—
commit_message_template	The commit message template (per commit). Default is `{{number}}) {{message}} ({{author}}) SHA: {{sha}} `	no	—
version	Explicitly set the version here instead of automatically detecting from `package.json`. Useful for non-JavaScript projects where version may be output by a previous action.	no	—
regex_pattern	An optional attribute containing the regular expression used to extract the version number.	no	—

Outputs

name	description
tagname	Returns the new tag value. Empty if a tag is not created.
tagsha	The SHA of the new tag.
taguri	The URI/URL of the new tag reference.
tagmessage	The messge applied to the tag reference (this is what shows up on the tag screen on Github).
tagcreated	A true or false, indicating a new tag was created.
tagrequested	The name of the requested tag. This will be populated even if the tag is not created.
version	The version, as defined in package.json or explicitly set in the input.
prerelease	true or false, indicating the tag represents a semantic version pre-release.
build	true or false, indicating the tag represents a semantic version build.