https://github.com/endbug/latest-tag

:octocat: Automatically generate & update a "latest" tag for your releases
https://github.com/endbug/latest-tag

actions ci github github-actions hacktoberfest latest tagging tags versioning

Last synced: 4 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/endbug/latest-tag
• Owner: EndBug
• License: mit
• Created: 2019-09-17T19:26:47.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-02T15:48:14.000Z (3 months ago)
• Last Synced: 2024-12-11T01:04:21.020Z (15 days ago)
• Topics: actions, ci, github, github-actions, hacktoberfest, latest, tagging, tags, versioning
• Language: TypeScript
• Homepage:
• Size: 592 KB
• Stars: 56
• Watchers: 2
• Forks: 13
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Latest tag

[![All Contributors](https://img.shields.io/github/all-contributors/EndBug/latest-tag)](#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:

```yaml

- 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"](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)

## License

This action is distributed under the MIT license, check the [license](LICENSE) for more info.

## Similar actions

[actions-tagger](https://github.com/marketplace/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](https://allcontributors.org/docs/en/emoji-key)):

  

    

      
Federico Grandi
💻 📖

      
Kslr
💻

      
Lukáš Doležal
💻

      
ziyangczi
🤔

      
James Smith
🤔 💻

      
Sebastian Hoß
💻

      
Tyler Goffinet
💻

    

    

      
Alyssa
🐛

      
Pavel Faltýnek
🚧

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!