From b151f720190804639e4f61b2ea0c6f0204fd2bde Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Wed, 13 Nov 2024 09:15:55 +0000 Subject: [PATCH] docs(readme): add note about using the latest --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 029b5e4..03316a2 100644 --- a/README.md +++ b/README.md @@ -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