butlerlogic/Autotagger
Automatically generate new tags for new versions. Supports several tagging strategies.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| root | Autotag will look for the appropriate file in in this location (relative to project root). | no | ./ |
| strategy | Options include 'package' (for package.json), 'composer' (for composer.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 | — |
| min_version | Minimum version required to create a tag. By default it will prevent a version `0.0.0` from being tagged. Also useful when introducing Autotag to an existing repo, to start auto-tagging from a specific version | no | 0.0.1 |
| regex_pattern | An optional attribute containing the regular expression used to extract the version number. | no | — |
| dry_run | If this value is true, the tag will not be pushed. | 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 "yes" or "no", 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 | \"yes\" or \"no\", indicating the tag represents a semantic version pre-release. |
| build | \"yes\" or \"no\", indicating the tag represents a semantic version build. |