build: Use codeberg mirror to self-test todo action
All checks were successful
Test / checks (map[name:stable]) (push) Successful in 2m19s
Test / checks (map[name:nightly]) (push) Successful in 4m6s

There is now a mirror of this repo at
https://codeberg.org/kemitix/todo-checker

We use both this original repo and that repo to verify
both are working as a valid actions.

Closes kemitix/forgejo-todo-checker#10
This commit is contained in:
Paul Campbell 2024-09-22 08:48:30 +01:00
parent 297e6de9d2
commit 6d2b750b65
2 changed files with 31 additions and 14 deletions

View file

@ -27,9 +27,12 @@ jobs:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Check TODOs - name: Check TODOs (Origin)
uses: https://git.kemitix.net/kemitix/forgejo-todo-checker@v1.0.0 uses: https://git.kemitix.net/kemitix/forgejo-todo-checker@v1.0.0
- name: Check TODOs (Mirror)
uses: kemitix/todo-checker@v1.0.0
- name: Machete - name: Machete
uses: https://git.kemitix.net/kemitix/rust@v2.1.0 uses: https://git.kemitix.net/kemitix/rust@v2.1.0
with: with:

View file

@ -6,6 +6,30 @@ A ForgeJo Action.
(Inspired by https://woodpecker-ci.org/plugins/TODO-Checker) (Inspired by https://woodpecker-ci.org/plugins/TODO-Checker)
## 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`.
## Usage
```yaml
jobs:
tests:
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Check TODOs
# Original:
# uses: https://git.kemitix.net/kemitix/forgejo-todo-checker@v1.0.0
# Codeberg mirror:
uses: kemitix/todo-checker@v1.0.0
```
## Comments Format ## Comments Format
This Action only pays attention to comments in a particular format. e.g: This Action only pays attention to comments in a particular format. e.g:
@ -31,18 +55,7 @@ The `ISSUE_NUMBER` must correspond to an **OPEN** Issue in the repo that the Act
If the issue has been closed or can't be found then the comment is marked as an error and the Check with fail. If the issue has been closed or can't be found then the comment is marked as an error and the Check with fail.
## Example Use as a ForgeJo Action Step ## Example Output
```yaml
jobs:
tests:
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Check TODOs
uses: https://git.kemitix.net/kemitix/forgejo-todo-checker@v1.0.0
```
The output will be similar to the following if there are any errors: The output will be similar to the following if there are any errors:
@ -50,11 +63,12 @@ The output will be similar to the following if there are any errors:
Forgejo TODO Checker! Forgejo TODO Checker!
Repo: kemitix/my-projext Repo: kemitix/my-projext
Prefix: (#|//)\s*(TODO|FIXME) Prefix: (#|//)\s*(TODO|FIXME)
Issues: ( |)(\(|\(#)(?P<ISSUE_NUMBER>\d+)(\)) Issues: \(#?(?P<ISSUE_NUMBER>\d+)\)
- Issue number missing: src/main.rs#38: - Issue number missing: src/main.rs#38:
// TODO: implement this cool feature and get rich! // TODO: implement this cool feature and get rich!
- Closed/Invalid Issue: (19) README.md#12: - Closed/Invalid Issue: (19) README.md#12:
// TODO: (#19) This is the comment // TODO: (#19) This is the comment
>> 1 error in src/model/line.rs
Error: Invalid or closed TODO/FIXMEs found Error: Invalid or closed TODO/FIXMEs found
``` ```