Skip to content

Conversation

@MaxGhenis
Copy link
Contributor

Summary

Fixes the push CI documentation deployment failure where MyST v2's myst build --html starts a development server that doesn't exit, causing CI to hang.

Changes

  • Use timeout 10 myst build --html || true in the documentation Makefile target
    • Runs the build for 10 seconds (enough time to generate HTML files)
    • Then exits cleanly, ensuring CI doesn't hang
    • The || true ensures make doesn't fail even if timeout kills the process
  • Add Makefile to PR workflow paths to ensure CI runs when Makefile changes
  • Document PR branch requirements in CLAUDE.md to prevent future fork PR issues

Test

Tested locally - the HTML files are successfully generated in docs/_build/html

Fixes the push CI documentation deployment failure that was preventing GitHub Pages updates.

- Use timeout command to handle MyST v2's server behavior in CI
- Add Makefile to PR workflow paths to ensure CI runs
- Document PR branch requirements in CLAUDE.md
- Add check-fork job that runs first in PR workflows
- Fails immediately with clear instructions if PR is from a fork
- Prevents wasting CI time on PRs that will fail due to missing secrets
@MaxGhenis MaxGhenis merged commit 49c334c into main Jul 30, 2025
6 checks passed
@nikhilwoodruff nikhilwoodruff deleted the fix-myst-docs-deployment branch August 4, 2025 12: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.

2 participants