Skip to content

[codex] validate GitHub Pages docs payload in CI#96

Merged
promptexecutionerr merged 6 commits into
mainfrom
codex/validate-pages-docs-ci
May 13, 2026
Merged

[codex] validate GitHub Pages docs payload in CI#96
promptexecutionerr merged 6 commits into
mainfrom
codex/validate-pages-docs-ci

Conversation

@elasticdotventures
Copy link
Copy Markdown
Member

@elasticdotventures elasticdotventures commented May 12, 2026

Summary

  • Validates the exact GitHub Pages docs payload in CI (`just docgen-pages-check`)
  • Wires `mdbook-admonish` preprocessor for mdBook 0.5 compatibility
  • Renames `MDBOOK_` env vars to `TOOL_` prefix to avoid mdBook config injection
  • fix(docker): adds `COPY kani-proofs ./kani-proofs` to both planner and builder stages — was causing `cargo chef prepare` to fail with "No such file or directory"
  • fix(release): removes invalid `ignore_fixup_commits` field from `cog.toml` — was blocking `cog bump`; confirmed `cog bump --minor --dry-run` → `v1.9.0`
  • fix(ci): resolves workflow validation failures on every push — moved secret-conditional gates from job-level `if:` to step-level `env:` in publish.yml; replaced `runner.temp` at workflow-level env in wrkflw-docgen.yml
  • Adds `just build` recipe + `wrkflw-ci-build.yml` to prove Docker fix locally without Docker

Test plan

  • `just build` passes locally
  • `Validate GitHub Pages docs build` job passes
  • No workflow validation failures on latest push
  • `test-and-build` (cargo test + Docker build) — in progress
  • `Kani model checking` — in progress
  • After merge: `just release minor` → v1.9.0

🤖 Generated with Claude Code

@promptexecutionerr promptexecutionerr force-pushed the codex/validate-pages-docs-ci branch from 3ed28e3 to 1381a38 Compare May 12, 2026 12:40
@promptexecutionerr promptexecutionerr force-pushed the codex/validate-pages-docs-ci branch from 1381a38 to 19013ec Compare May 12, 2026 12:59
Claude Sonnet (coordinator) and others added 5 commits May 12, 2026 23:10
…ility

- Add [preprocessor.admonish] to book/book.toml via mdbook-admonish install
- Refresh mdbook-admonish.css to v1.20.0 assets
- Install mdbook-admonish from padamson/mdbook-admonish@feat/mdbook-0.5-compat
  (tommilligan/mdbook-admonish#235) in CI and docs workflows — released v1.20.0
  was built against mdbook 0.4.x and fails on 0.5's null config fields
- Add admonish presence check and install instructions to Justfile docgen recipe
- Add smoke-test admonish blocks (note/warning/tip) to book/src/intro.md

TODO: pin to a released version once #235 merges upstream

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…fig injection

mdbook 0.5 reads MDBOOK_* env vars as config key overrides (strips prefix,
lowercases, replaces _ with -). MDBOOK_MERMAID_VERSION was being injected as
the unknown config key `mermaid-version`, causing `ERROR invalid key` on every
docs build. MDBOOK_VERSION had the same risk with `version`.

Renaming to TOOL_MDBOOK_VERSION / TOOL_MDBOOK_MERMAID_VERSION avoids the prefix
match entirely.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
cargo chef prepare failed because kani-proofs was a workspace member
but was not copied into the Docker context before the planner stage ran.
Adds COPY to both planner (before cargo chef prepare) and builder.

Adds wrkflw-ci-build.yml workflow and `just build` recipe to prove the
fix locally without Docker: runs cargo chef prepare + ledgerr-mcp build
via wrkflw emulation mode, asserting kani-proofs appears in the recipe.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Field was rejected by cocogitto at runtime, blocking cog bump.
Removed; merge-commit skipping is handled by ignore_merge_commits.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Two workflows were failing GitHub's parse-time validation on every push:

- publish.yml: secrets context is not available during job-level `if:`
  evaluation. Moved CRATES_IO_TOKEN/PYPI_API_TOKEN to job-level env vars
  and gated each step with `if: ${{ env.TOKEN != '' }}` instead.

- wrkflw-docgen.yml: `runner.temp` is a job-execution context, not
  available in workflow-level `env:` blocks. Replaced with `/tmp/sccache`
  (always correct in emulation mode where wrkflw runs on the host).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@promptexecutionerr promptexecutionerr marked this pull request as ready for review May 13, 2026 09:31
@promptexecutionerr promptexecutionerr merged commit ef819ea into main May 13, 2026
4 of 5 checks passed
@promptexecutionerr promptexecutionerr deleted the codex/validate-pages-docs-ci branch May 13, 2026 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants