Skip to content

:octocat: Automatically generate & update a "latest" tag for your releases

License

Notifications You must be signed in to change notification settings

EndBug/latest-tag

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Latest tag

All Contributors

Automatically creates & updates a latest tag pointing to your latest release.

When using GitHub Actions you always have to put a reference for every action you use in your worflows: that means that you either need to choose a specific version or you need to use a branch. If you want to use the latest release of an action you can only hope authors are mantaining a latest tag that they update with every version: although not impossible, it's not that easy to find someone willing to do that.

That's why I made this action: if you're the kind of guy that doesn't like to update tags you can simply use this action and forget about it. You can just put latest in the documentation: your users will get the benefits of using a branch as ref and the security of using only stable versions (as long as you don't make breaking changes).

Usage

Add a step like this to your workflow:

- name: Run latest-tag
  uses: EndBug/latest-tag@latest
  with:
    # You can change the name of the tag or branch with this input.
    # Default: 'latest'
    ref: someCustomTagName

    # If a description is provided, the action will use it to create an annotated tag. If none is given, the action will create a lightweight tag.
    # Default: ''
    description: Description for the tag

    # Force-update a branch instead of using a tag.
    # Default: false
    force-branch: true

    # Directory to use when executing git commands
    # Default: '${{ github.workspace }}'
    git-directory: 'path/to/repo/dir'

Important

Please make sure to set the workflow permissions so that the action runs with the contents: write permission. Visit the GitHub docs to learn more about token permissions: "Automating token authentication"

License

This action is distributed under the MIT license, check the license for more info.

Similar actions

actions-tagger: allows you to create and update both latest and major version tags, even though it doesn't support annotated tags and the major version tag is mandatory (ref v2.0.1).

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Federico Grandi
Federico Grandi

💻 📖
Kslr
Kslr

💻
Lukáš Doležal
Lukáš Doležal

💻
ziyangczi
ziyangczi

🤔
James Smith
James Smith

🤔 💻
Sebastian Hoß
Sebastian Hoß

💻
Tyler Goffinet
Tyler Goffinet

💻
Alyssa
Alyssa

🐛
Pavel Faltýnek
Pavel Faltýnek

🚧

This project follows the all-contributors specification. Contributions of any kind welcome!