Skip to content

Fix release docs checkout trust - #690

Merged
yuecideng merged 1 commit into
mainfrom
codex/fix-release-docs-safe-directory
Sep 24, 2026
Merged

yuecideng merged 1 commit into
mainfrom
codex/fix-release-docs-safe-directory

Conversation

@yuecideng

Copy link
Copy Markdown
Contributor

Description

The v0.3.0 versioned documentation build failed while the architecture extension read Git sources because the container rejected the checkout as a repository with dubious ownership. The regular main documentation job already marks $GITHUB_WORKSPACE as a Git safe directory, but the manual release-doc build did not.

This PR adds the same trust step to docs-pages.yml before Sphinx invokes the Git-backed architecture generator, and adds a workflow contract test that pins its ordering before the docs build.

Failed release docs run: https://github.com/DexForce/EmbodiChain/actions/runs/36023462466

Dependencies: none.

Issue reference: N/A.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (non-breaking change which improves an existing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (existing functionality will not work without user modification)
  • Documentation update

Screenshots

Not applicable.

Validation

  • Red/green workflow contract: the new test failed before the workflow change because Trust checked-out repository was absent, then passed after the fix.
  • black . with Black 26.3.1 — 1 test file reformatted; 1,138 files unchanged.
  • python -m pytest -q tests/ci — 43 passed, 4 skipped.
  • python docs/scripts/check_api_docs.py — 2,273/2,273 exports documented.
  • git diff --check — passed.

Checklist

  • I have run black ..
  • I reviewed affected documentation and agent context; no project-context guidance changes.
  • Public API documentation coverage passes.
  • A focused regression test proves the workflow contract.
  • Dependencies have been reviewed; no changes are required.

@yuecideng yuecideng added bug Something isn't working ci labels Sep 24, 2026
@yuecideng
yuecideng merged commit 67b0285 into main Sep 24, 2026
3 checks passed
@yuecideng
yuecideng deleted the codex/fix-release-docs-safe-directory branch September 24, 2026 15:59
@greptile-apps

greptile-apps Bot commented Sep 24, 2026

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

The PR appears safe to merge.

Summary

The PR adds Git safe-directory configuration to the manual release-docs job and a test that pins it before the docs build.

  • The architecture generator reads the checked-out workspace repository, matching the trusted path.
  • No actionable regression or repository-rule violation was identified.

Reviews (1) · Last reviewed commit: "fix(ci): trust release docs checkout"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working ci

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant