Skip to content

fix: bootstrap MkDocs in release preflight - #180

Merged
soulteary merged 1 commit into
mainfrom
fix/release-preflight-mkdocs
Sep 6, 2026
Merged

soulteary merged 1 commit into
mainfrom
fix/release-preflight-mkdocs

Conversation

@soulteary

Copy link
Copy Markdown
Owner

Summary

  • stop requiring a globally installed mkdocs command before release preflight can start
  • use an existing mkdocs when available
  • otherwise require Python 3, create a temporary virtual environment, install the pinned requirements-docs.txt, run the strict documentation build, and clean up automatically
  • document the fallback and its first-run network requirement in English and Chinese
  • add a regression test for the documentation-tool bootstrap contract

Why

The documented 7.3.0 sequence currently stops immediately with:

release preflight failed: missing required command: mkdocs

MkDocs is only needed for the documentation validation stage and should not require a global Python installation. This keeps the release checkout clean while preserving the strict build.

No 7.3.0 tag or GitHub Release exists, so this fix can be merged before continuing the release.

Validation

  • exercised the fallback with no global mkdocs: temporary venv creation, pinned dependency install, and mkdocs build --strict all passed
  • go test .
  • bash -n scripts/release-preflight.sh
  • Actionlint v1.7.7 on the Release workflow
  • git diff --check

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 6, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-06T14:14:54.123436Z 34751b0 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@soulteary
soulteary merged commit e9644d8 into main Sep 6, 2026
11 checks passed
@soulteary
soulteary deleted the fix/release-preflight-mkdocs branch September 21, 2026 15:49
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.

1 participant