autotag/action.yml

63 lines
3.0 KiB
YAML
Raw Normal View History

name: "Autotagger"
description: "Automatically generate new tags for new versions. Supports several tagging strategies."
author: "Butler Logic"
2019-09-03 04:11:57 +07:00
branding:
icon: "tag"
color: "blue"
2019-09-04 03:08:46 +07:00
inputs:
root:
description: Autotag will look for the appropriate file in in this location (relative to project root).
required: false
default: './'
strategy:
2023-03-31 09:07:57 +07:00
description: 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.
required: false
default: 'package'
2019-10-22 19:40:28 +07:00
tag_prefix:
2019-09-04 03:08:46 +07:00
description: 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".
required: false
tag_suffix:
description: Text which is applied to the end of the tag.
required: false
tag_message:
description: 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.
required: false
commit_message_template:
description: "The commit message template (per commit). Default is `{{number}}) {{message}} ({{author}})\nSHA: {{sha}}\n`"
required: false
version:
description: 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.
required: false
min_version:
2021-01-30 22:10:58 +07:00
description: 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
2021-01-30 22:09:56 +07:00
required: false
default: '0.0.1'
2020-04-02 01:48:54 +07:00
regex_pattern:
description: An optional attribute containing the regular expression used to extract the version number.
required: false
2021-06-02 17:53:21 +07:00
dry_run:
description: If this value is true, the tag will not be pushed.
required: false
2019-09-03 04:11:57 +07:00
outputs:
2019-09-04 03:08:46 +07:00
tagname:
2019-09-03 04:11:57 +07:00
description: Returns the new tag value. Empty if a tag is not created.
2019-09-04 03:08:46 +07:00
tagsha:
description: The SHA of the new tag.
taguri:
description: The URI/URL of the new tag reference.
tagmessage:
description: The messge applied to the tag reference (this is what shows up on the tag screen on Github).
tagcreated:
description: A "yes" or "no", indicating a new tag was created.
tagrequested:
description: The name of the requested tag. This will be populated even if the tag is not created.
version:
description: The version, as defined in package.json or explicitly set in the input.
prerelease:
description: \"yes\" or \"no\", indicating the tag represents a semantic version pre-release.
build:
description: \"yes\" or \"no\", indicating the tag represents a semantic version build.
2019-09-03 03:40:00 +07:00
runs:
using: "node16"
2022-10-13 08:49:37 +07:00
main: "dist/main.js"