Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stevenjdh/action-tagger
Automatically sets semantic tags when releasing a new version of a GitHub action.
https://github.com/stevenjdh/action-tagger
actions release-automation semantic-tags versioning
Last synced: 21 days ago
JSON representation
Automatically sets semantic tags when releasing a new version of a GitHub action.
- Host: GitHub
- URL: https://github.com/stevenjdh/action-tagger
- Owner: StevenJDH
- License: apache-2.0
- Created: 2024-03-14T00:12:53.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-03T21:39:40.000Z (9 months ago)
- Last Synced: 2024-05-01T14:15:05.149Z (8 months ago)
- Topics: actions, release-automation, semantic-tags, versioning
- Language: Shell
- Homepage: https://github.com/marketplace/actions/action-tagger
- Size: 17.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Action Tagger
[](https://github.com/StevenJDH/action-tagger/actions/workflows/bash-action-workflow.yml)
[](https://github.com/search?o=desc&q=StevenJDH+action-tagger+language%3AYAML&s=&type=Code)
[](https://app.codacy.com/gh/StevenJDH/action-tagger/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
Action Tagger automatically sets semantic tags when releasing a new version of a GitHub action. This action adheres to GitHub's [action versioning guide](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#versioning), and removes the tedious task of having to manually set and shift tags like `v1` and `v1.2` to ensure they always point to a newer release. Tags produced and managed by this action will continue to work alongside other methods for referencing a release such as pointing to a branch, SHA, or other tags to meet different needs. In fact, Action Tagger currently manages its own release tags in a very similar way as described further down.
[](https://www.buymeacoffee.com/stevenjdh)
## Features
* Automate the setting and shifting of first and second level semantic tags.
* Optionally set a `latest` tag to use as an alternative to pointing to `main`.
* Tag format is validated during a run to ensure correct conformity.
* Support for running the action in a dry run mode without making actual changes.
* Summary reports are generated after each run.
* Reference outputs of managed tags for additional possibilities.
## Compatibility
Below is a list of GitHub-hosted runners that support jobs using this action.
| Runner | Supported? |
|------------|:----------:|
| [](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) | :white_check_mark: |
| [](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) | :white_check_mark: |
| [](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) | :white_check_mark: |
## Inputs
The following inputs are available:
| Name | Type | Required | Default | Description |
|------------------------------------------------------------------------------|----------|:--------:|:-------------------------------:|---------------------------------------------------------------------|
| [enable‑dry‑run](#enable-dry-run) | `string` | `false` | `false` | Indicates whether or not to perform a dry run without pushing tags. |
| [set‑latest‑tag](#set-latest-tag) | `string` | `false` | `false` | Indicates whether or not to also set the latest tag. |
| [github‑token](#github-token) | `string` | `false` | ${{ github.token }} | Overrides the default GitHub token used to authenticate against a repository for Git context. |
> [!NOTE]
> Enabling dry run will use a dummy version of v1.0.0 regardless of what version tags are available.
## Outputs
The following outputs are available:
| Name | Type | Example | Description |
|-------------------------------------------------------------|----------|---------|--------------------------------------------------|
| [major_release](#major_release) | `string` | v1 | The latest major release version. |
| [minor_release](#minor_release) | `string` | v1.2 | The latest major and feature release version. |
| [full_release](#full_release) | `string` | v1.2.3 | The full release version. |
| [latest_tag](#latest_tag) | `string` | false | Indicates whether of not the latest tag was set. |
## Usage
Implementing this action is relatively simple with just a few steps.
1. Below is a working example of a typical release workflow using Action Tagger. Add this to a file called something like `action-release-workflow.yml`, and place it in the `.github/workflows/` folder. Token permissions have been scoped down to `contents:write` with support for pushing tags.
```yaml
name: action-release-tags
on:
release:
types: [released, edited]
jobs:
action-tagger:
name: action-tagger
runs-on: ubuntu-latest
permissions:
contents: write
environment: releases
steps:
- uses: actions/checkout@v4
with:
# Disabling shallow clone ensures all commits
# and tags are available at checkout.
fetch-depth: 0
- name: Tag Release
id: action-tagger
uses: stevenjdh/action-tagger@v1
with:
set-latest-tag: true
```
2. When it's time to create a release, ensure that the tag being set is using the format `vX.X.X`. For example, `v1.2.3`. This will trigger the process and automate the rest.
3. Done. Feel free to edit the release if a mistake was made, and Action Tagger will reflect the changes for this as well.
## Disclaimer
Action Tagger is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
## Contributing
Thanks for your interest in contributing! There are many ways to contribute to this project. Get started [here](https://github.com/StevenJDH/.github/blob/main/docs/CONTRIBUTING.md).
## Do you have any questions?
Many commonly asked questions are answered in the FAQ:
[https://github.com/StevenJDH/action-tagger/wiki/FAQ](https://github.com/StevenJDH/action-tagger/wiki/FAQ)
## Want to show your support?
|Method | Address |
|---------------:|:------------------------------------------------------------------------------------------|
|PayPal: | [https://www.paypal.me/stevenjdh](https://www.paypal.me/stevenjdh "Steven's Paypal Page") |
|Cryptocurrency: | [Supported options](https://github.com/StevenJDH/StevenJDH/wiki/Donate-Cryptocurrency) |
// Steven Jenkins De Haro ("StevenJDH" on GitHub)