Autotag Pub projects
This action will read a pubspec.yaml
file and compare the version
attribute to the project's known tags. If a corresponding tag does not exist, it will be created.
Usage
The following is an example .github/workflows/main.yml
that will execute when a push
to the main
branch occurs.
name: Create Tag
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: ricardodalarme/action-autotag@latest
with:
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@v3
- uses: ricardodalarme/action-autotag@latest
If the repository is not checked out first, the autotagger cannot find the pubspec.yaml file.
Configuration
The GITHUB_TOKEN
must be passed in. Without this, it is not possible to create a new tag. Make sure the autotag action looks like the following example:
- uses: ricardodalarme/action-autotag@latest
with:
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).
Optional Configurations
There are several options to customize how the tag is created.
-
package_root
By default, autotag will look for the
pubspec.yaml
file in the project root. If the file is located in a subdirectory, this option can be used to point to the correct file.- uses: ricardodalarme/action-autotag@latest with: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" package_root: "/path/to/subdirectory"
-
tag_prefix
By default in flutter, the version number is three numbers separated by dots, followed by an optional build number separated by a +, such as
1.2.21+7
. The optional build number is ignored when the tag is created. A prefix can be used to add text before the tag name. For example, iftag_prefix
is set tov
, then the tag would be labeled asv1.0.0
.- uses: ricardodalarme/action-autotag@latest with: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" tag_prefix: "v"
-
tag_suffix
Text can also be applied to the end of the tag by setting
tag_suffix
. For example, iftag_suffix
is(beta)
, the tag would be1.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: ricardodalarme/action-autotag@latest with: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" tag_suffix: " (beta)"
-
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). Setting this option will override it witha custom message.
- uses: ricardodalarme/action-autotag@latest with: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" tag_message: "Custom message goes here."
-
changelog_structure
Provide a custom changelog format when not using
tag_message
. This can interpolate strings, supported strings are{{message}}
,{{messageHeadline}}
,{{author}}
and{{sha}}
. Defaults to**{{message}}** {{sha}})\n
.- uses: ricardodalarme/action-autotag@latest with: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" changelog_structure: "**{{messageHeadline}}** {{author}}\n"
-
version
Explicitly set the version instead of automatically detecting from
pubspec.yaml
. Useful for non-Flutter projects where version may be output by a previous action.- uses: ricardodalarme/action-autotag@latest with: GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" version: "${{ steps.previous_step.outputs.version }}"
Developer Notes
If you are building an action that runs after this one, be aware this action produces several outputs:
tagname
will be empty if no tag was created, or it will be the value of the new tag.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).version
will be the version attribute found in thepubspec.yaml
file.
Credits
- Ricardo Dalarme (Package maintainer)
- Klemensas (Original project creator)