28 lines
1.5 KiB
YAML
28 lines
1.5 KiB
YAML
name: Documentation
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
paths:
|
|
- "**/*.md"
|
|
- "!internal/docs/templates/**"
|
|
- ".gitea/workflows/docs-check.yml"
|
|
pull_request:
|
|
paths:
|
|
- "**/*.md"
|
|
- "!internal/docs/templates/**"
|
|
- ".gitea/workflows/docs-check.yml"
|
|
jobs:
|
|
docs:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v7.0.1
|
|
- uses: actions/setup-go@v7.0.0
|
|
with:
|
|
go-version-file: go.mod
|
|
cache: false
|
|
- run: go run ./cmd/docs check
|
|
- run: go run go.auvem.com/corestack/cmd/docs@v0.1.0 check
|
|
- name: Require issue URLs in TODO comments
|
|
run: |
|
|
find . -type d \( -name .git -o -name node_modules -o -name vendor -o -name generated -o -name gen -o -name target -o -name dist -o -name build -o -name .svelte-kit -o -name .next \) -prune -o -type f \( -name '*.go' -o -name '*.ts' -o -name '*.tsx' -o -name '*.js' -o -name '*.svelte' -o -name '*.rs' -o -name '*.sql' -o -name '*.sh' -o -name '*.proto' -o -name '*.graphql' -o -name '*.yml' -o -name '*.yaml' -o -name '*.toml' \) -exec awk 'match($0, "((^|[^:])[/][/]|[/][*]|(^|[[:space:]])(#|--)|^[[:space:]]*([*]|<!--))") { comment=substr($0, RSTART + RLENGTH); todo=index(comment, "TO" "DO"); if (todo && substr(comment, todo + 4) !~ "https?:[/][/]") { print FILENAME ":" FNR ":" $0; bad=1 } } END { exit bad }' {} + # shortcut: line-based scan can flag comment-like strings and misses multiline issue links, use a parser when these need accurate coverage
|