docs: document ci coverage
Some checks failed
CI / release-check (push) Has been cancelled
CodeQL / analyze (push) Has been cancelled
CI / deps (push) Has been cancelled
CI / lint (push) Has been cancelled
CI / test (push) Has been cancelled

This commit is contained in:
Vincent Koc 2026-05-05 19:29:38 -07:00
parent f98087df38
commit e061bf481e
No known key found for this signature in database
2 changed files with 9 additions and 0 deletions

View File

@ -2,6 +2,11 @@
## Unreleased
- Replace the single validation workflow with CI jobs for dependencies,
formatting/vet, tests, CLI control-surface smoke checks, and GoReleaser
snapshot builds.
- Add CodeQL analysis on pull requests, `main`, the crawlkit integration branch,
weekly schedule, and manual dispatch.
- Depend on `github.com/vincentkoc/crawlkit v0.4.0` for shared config,
status/control, snapshot, mirror, output, and terminal explorer mechanics.
- Keep Notion API/Desktop parsing, Markdown rendering, page/comment/database

View File

@ -19,6 +19,10 @@ notcrawl doctor --json
notcrawl tui --json --limit 10
```
The CI workflow runs the same control-surface smoke checks, plus dependency
verification, `gofmt`, `go vet`, tests, a GoReleaser snapshot build, and
CodeQL.
If GoReleaser is installed:
```bash