This action will generate a Github tag when a new version is detected.
graph LR
e[Detect/Extract<br/>Semantic Version]
e-->c[Compare<br/>to Existing Tags]
c-->d{Newer?}
d-.->|No|done[Done]
d-.->|Yes|p[Create Tag]
There are several "detection strategies" to choose from:
- package: Extract from
package.json. - composer: Extract from
composer.json. - docker: Extract from
Dockerfile, in search of aLABEL version=x.x.xvalue. - regex: Use a JavaScript regular expression with any file for your own custom extraction.
- manual: Manually supply the version number (no need to specify this strategy, just specify the version).
When a new version is detected, it is compared to the current tags in the Github repository. If the version is newer than other tags (or if no tags exist yet), the version will be used to create a new tag.
This action works well in combination with:
- actions/create-release (Auto-release)
- author/action-publish (Auto-publish JavaScript/Node modules)
- author/action-rollback (Auto-rollback releases on failures)
The following is an example .github/workflows/main.yml that will execute when a push to the master branch occurs.
name: Create Tag
on:
push:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: butlerlogic/action-autotag@stable
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"To make this work, the workflow must have the checkout action before the autotag action.
This order is important!
- uses: actions/checkout@v2
- uses: butlerlogic/action-autotag@stableIf the repository is not checked out first, the autotagger cannot find the source files.
The GITHUB_TOKEN must be provided. Without this, it is not possible to create a new tag. Make sure the autotag action looks like the following example:
- uses: butlerlogic/action-autotag@stable
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"The action will automatically extract the token at runtime. DO NOT MANUALLY ENTER YOUR TOKEN. If you put the actual token in your workflow file, you'll make it accessible (in plaintext) to anyone who ever views the repository (it will be in your git history).
There are several options to customize how the tag is created.
This is the strategy used to identify the version number/tag from within the code base.
- uses: butlerlogic/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
strategy: <your_choice>- package: Search
package.jsonfor new versions. Use this for JavaScript projects based on Node/Deno/Bun modules (npm, yarn, etc). - composer: Same as package, but uses
composer.jsoninstead of package.json. - docker: Search a
Dockerfilefor aLABEL version=x.x.xvalue. Use this for container projects. - regex*: Use a JavaScript regular expression with any file for your own custom extraction.
EXCEPTION: This property is not required if the
regex_patternproperty (below) is defined, because it is assumed to be "regex".
Depending on the selected strategy, autotagger will look for the confgured identify file (i.e. package.json, composer.json, Dockerfile, etc) in the project root. If the file is located in a subdirectory, this option can be used to point to the correct file.
Using the package (or composer) strategy:
- uses: butlerlogic/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
strategy: package # Optional, since "package" is the default strategy
root: "/path/to/subdirectory"The version number would be extracted from /path/to/subdirectory/package.json.
Using the docker strategy:
- uses: butlerlogic/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
strategy: docker
root: "/path/to/subdirectory"The version number would be extracted from /path/to/subdirectory/Dockerfile, specifically looking for the LABEL version=x.x.x line within the file.
Using the regex strategy:
- uses: butlerlogic/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
strategy: regex # Optional since regex_pattern is defined
root: "/path/to/subdirectory/my.file"
regex_pattern: "version=([0-9\.])"The version will be extracted by scanning the content of /path/to/subdirectory/my.file for a string like version=1.0.0. See the regex_pattern option for more details.
An optional attribute containing the regular expression used to extract the version number.
- uses: butlerlogic/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
regex_pattern: "version=([0-9\.]{5}([-\+][\w\.0-9]+)?)"This attribute is used as the first argument of a RegExp object. The first "group" (i.e. what's in the main set of parenthesis/the whole version number) will be used as the version number. For an example, see this working example.
The pattern described in this example is a simplistic one. If you need a more explicit one the complete semver pattern is:
^((0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?)$
As of 1.1.2, JavaScript named patterns are supported, where the group named version will be used to populate the tag. For example:
- uses: butlerlogic/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
regex_pattern: "(version=)(?<version>[\d+\.]{3}([-\+][\w\.0-9]+)?)"By default, semantic versioning is used, such as 1.0.0. A prefix can be used to add text before the tag name. For example, if tag_prefix is set to v, then the tag would be labeled as v1.0.0.
- uses: butlerlogic/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
tag_prefix: "v"Text can be applied to the end of the tag by setting tag_suffix. For example, if tag_suffix is (beta), the tag would be 1.0.0 (beta). Please note this example violates semantic versioning and is merely here to illustrate how to add text to the end of a tag name if you really want to.
- uses: butlerlogic/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
tag_suffix: " (beta)"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 current reference (HEAD). Setting this option will override the message.
- uses: butlerlogic/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
tag_message: "Custom message goes here."By default, a changelog is generated, containing the commit messages since the last release. The message is generated by applying a commit message template to each commit's data attributes.
- uses: butlerlogic/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
commit_message_template: "({{sha}} by {{author}}) {{message}}"Optional data points:
numberThe commit number (relevant to the overall list)messageThe commit message.authorThe author of the commit.shaThe SHA value representing the commit.
The default is {{number}}) {{message}} ({{author}})\nSHA: {{sha}}\n.
Example output:
1) Update README.md (coreybutler)
(SHA: c5e09fc45106a4b27b8f4598fb79811b589a4684)
2) Added metadoc capability to introspect the shell/commands. (coreybutler)
(SHA: b690be366a5636d51b1245a1b39c86102ddb8a81)
Explicitly set the version instead of using automatic detection (forces "manual" strategy).
Useful for projects where the version number may be output by a previous action.
- uses: butlerlogic/[email protected]
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
version: "${{ steps.previous_step.outputs.version }}"Set the minimum version which would be used to create a tag.
The default value (0.0.1) prevents a 0.0.0 from being created. This can also be used when introducing Autotag to a repository which already has tags.
For example, if the version 0.1.0 is already published, set the minVersion to the next patch to prevent a duplicate tag for that version.
- uses: butlerlogic/[email protected]
with:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
min_version: "0.1.1"If this value is true, the tag will not be pushed.
You can check for duplicate versions when creating a pull request.
- uses: butlerlogic/[email protected]
with:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
dry_run: trueIf you are building an action that runs after this one, be aware this action produces several outputs:
tagnamewill be empty if no tag was created, or it will be the value of the new tag.tagrequested: The name of the requested tag. This will be populated even if the tag is not created. This will usually be the same astagnameand/orversionfor successful executions. This output is typically used for rollbacks/notifications when the creation of a tag fails.tagsha: The SHA of the new tag.taguri: The URI/URL of the new tag reference.tagmessage: The message applied to the tag reference (this is what shows up on the tag screen on Github).tagcreated:yesorno.versionwill be the extracted/provided version.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.
This action was written and is primarily maintained by Corey Butler.
This project has had great contributions from these wonderful people. Additional gratitude goes to Jaliborc, who came up with the idea and original implementation for a pattern-based tag extraction (the Regex strategy).
Active Sponsors
These sponsors are helping make this project possible.
 |
 |
If you use this or find value in it, please consider contributing in one or more of the following ways:
- Click the "Sponsor" button at the top of the page and make a contribution.
- Star it!
- Tweet about it!
- Fix an issue.
- Add a feature (post a proposal in an issue first!).
Copyright © 2020-2023 Butler Logic, Corey Butler, and Contributors.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent