Skip to content

Commit 1d43473

Browse files
committed
ci: fold the docs drift assertion into the codegen check
1 parent 40eb1d1 commit 1d43473

1 file changed

Lines changed: 4 additions & 8 deletions

File tree

.github/workflows/ci.yml

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,17 @@ jobs:
2020

2121
# Hermetic: regenerates from the committed spec, so this verifies that the committed
2222
# generated code still reproduces from it, with no network dependency. Refreshing the
23-
# spec itself is the release workflow's job.
23+
# spec itself is the release workflow's job. `generate` also runs sync-docs (see
24+
# tools/roxygen/main.go), so the docs are asserted in the same diff rather than by a
25+
# second identical run.
2426
- name: Codegen drift check
2527
env:
2628
ROXYAPI_SPEC_FILE: specs/openapi.json
2729
run: |
2830
go run ./tools/roxygen generate
29-
git diff --exit-code -- specs/openapi.json roxyapi.gen.go roxy.gen.go \
31+
git diff --exit-code -- specs/openapi.json roxyapi.gen.go roxy.gen.go README.md AGENTS.md docs/llms-full.txt \
3032
|| { echo 'codegen drift: run "go run ./tools/roxygen generate" and commit the result'; exit 1; }
3133
32-
- name: Docs drift check
33-
run: |
34-
go run ./tools/roxygen sync-docs
35-
git diff --exit-code -- README.md AGENTS.md docs/llms-full.txt \
36-
|| { echo 'docs drift: run "go run ./tools/roxygen sync-docs" and commit the result'; exit 1; }
37-
3834
- name: gofmt
3935
run: test -z "$(gofmt -l .)" || { echo 'run gofmt -w .'; gofmt -l .; exit 1; }
4036

0 commit comments

Comments
 (0)