kemitix/forgejo-todo-checker
1
0
Fork 0
Code Issues 1 Pull requests 1 Releases 2 Activity Actions

docs(readme): add note about using the latest
All checks were successful
Test / checks (map[name:nightly]) (push) Successful in 1m51s
Details
Test / checks (map[name:stable]) (push) Successful in 4m7s
Details

Browse source
This commit is contained in:
Paul Campbell 2024-11-13 09:15:55 +00:00
parent b4af6b576d
commit b151f72019
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -6,13 +6,17 @@ Checks your source files for TODO and FIXME comments, failing your build where t
(Inspired by https://woodpecker-ci.org/plugins/TODO-Checker)
## LATEST version
See [Releases](https://git.kemitix.net/kemitix/forgejo-todo-checker/releases) for the latest version. Replace `${LATEST}` in the examples below with the tag version (include any leading `v`).
## code.forgejo.org Mirror
Main development takes place on [git.kemitix.net](https://git.kemitix.net/kemitix/forgejo-todo-checker).
There is a mirror on Codeberg.org as [kemitix/todo-checker](https://code.forgejo.org/kemitix/todo-checker).
This mirror allows you to refer to the action as simply `kemitix/todo-checker@v1.0.0`.
This mirror allows you to refer to the action as simply `kemitix/todo-checker@${LATEST}`.
## Usage
@ -25,9 +29,9 @@ jobs:
- name: Check TODOs
# Original:
# uses: https://git.kemitix.net/kemitix/forgejo-todo-checker@v1.0.0
# uses: https://git.kemitix.net/kemitix/forgejo-todo-checker@${LATEST}
# Codeberg mirror:
uses: kemitix/todo-checker@v1.0.0
uses: kemitix/todo-checker@${LATEST}
```
## Comments Format