build: Use codeberg mirror to self-test todo action
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:
parent
297e6de9d2
commit
673ff94759
2 changed files with 31 additions and 14 deletions
|
@ -27,9 +27,12 @@ jobs:
|
|||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Check TODOs
|
||||
- name: Check TODOs (Origin)
|
||||
uses: https://git.kemitix.net/kemitix/forgejo-todo-checker@v1.0.0
|
||||
|
||||
- name: Check TODOs (Codeberg mirror)
|
||||
uses: kemitix/todo-checker@v1.0.0
|
||||
|
||||
- name: Machete
|
||||
uses: https://git.kemitix.net/kemitix/rust@v2.1.0
|
||||
with:
|
||||
|
|
40
README.md
40
README.md
|
@ -6,6 +6,30 @@ A ForgeJo Action.
|
|||
|
||||
(Inspired by https://woodpecker-ci.org/plugins/TODO-Checker)
|
||||
|
||||
## Codeberg 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://codeberg.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
|
||||
|
||||
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.
|
||||
|
||||
## Example Use as a ForgeJo Action Step
|
||||
|
||||
```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
|
||||
```
|
||||
## Example Output
|
||||
|
||||
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!
|
||||
Repo: kemitix/my-projext
|
||||
Prefix: (#|//)\s*(TODO|FIXME)
|
||||
Issues: ( |)(\(|\(#)(?P<ISSUE_NUMBER>\d+)(\))
|
||||
Issues: \(#?(?P<ISSUE_NUMBER>\d+)\)
|
||||
- Issue number missing: src/main.rs#38:
|
||||
// TODO: implement this cool feature and get rich!
|
||||
- Closed/Invalid Issue: (19) README.md#12:
|
||||
// TODO: (#19) This is the comment
|
||||
>> 1 error in src/model/line.rs
|
||||
|
||||
Error: Invalid or closed TODO/FIXMEs found
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue