https://github.com/giacomocavalieri/tagref_action
🔖 A GitHub Action to run tagref
https://github.com/giacomocavalieri/tagref_action
documentation github-action
Last synced: 8 months ago
JSON representation
🔖 A GitHub Action to run tagref
- Host: GitHub
- URL: https://github.com/giacomocavalieri/tagref_action
- Owner: giacomocavalieri
- License: apache-2.0
- Created: 2023-09-25T11:35:23.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-04T08:40:45.000Z (over 2 years ago)
- Last Synced: 2025-03-28T17:00:03.931Z (over 1 year ago)
- Topics: documentation, github-action
- Language: Shell
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `tagref` GitHub action
This action runs [`tagref`](https://github.com/stepchowfun/tagref) to check
that all defined tags are referenced at least once and that all references are
valid.
It is the same as running:
```sh
tagref check && tagref list-unused --fail-if-any
```
## Inputs
- `unused_tags`: can be used to change the action's behaviour with regard to unused tags
- `"forbid"` (the default): will make the CI fail if there's any note that's not referenced anywhere
- `"allow"`: will allow tags that have no references
## Example usage
You can use this action as one of your CI steps like this:
```yaml
- name: "check tags are correct"
uses: giacomocavalieri/tagref_action@v1
```