Compare commits

...

2 commits

Author SHA1 Message Date
780d6888d7 docs(readme): fix typo about where mirror is hosted
All checks were successful
Test / checks (map[name:stable]) (push) Successful in 1m32s
Test / checks (map[name:nightly]) (push) Successful in 4m15s
2024-11-13 09:17:36 +00:00
b151f72019 docs(readme): add note about using the latest
All checks were successful
Test / checks (map[name:nightly]) (push) Successful in 1m51s
Test / checks (map[name:stable]) (push) Successful in 4m7s
2024-11-13 09:17:33 +00:00

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) (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 ## code.forgejo.org Mirror
Main development takes place on [git.kemitix.net](https://git.kemitix.net/kemitix/forgejo-todo-checker). 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). There is a mirror on code.forgejo.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 ## Usage
@ -25,9 +29,9 @@ jobs:
- name: Check TODOs - name: Check TODOs
# Original: # 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: # Codeberg mirror:
uses: kemitix/todo-checker@v1.0.0 uses: kemitix/todo-checker@${LATEST}
``` ```
## Comments Format ## Comments Format