Fix documentation deployment for MyST v2 #411
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MyST v2 'myst build --html' starts a development server that doesn't exit, causing CI to hang. This change: - Runs the build command in background - Waits 10 seconds for files to be generated - Kills the server process - Ensures _build/html directory is created for GitHub Pages deployment
Contributor
Author
|
/check-pr |
The timeout command is available in Ubuntu CI and provides a cleaner way to handle MyST v2's server behavior.
The strict token requirement was breaking CI for PRs from forks since GitHub doesn't provide secrets to fork PRs for security reasons. This change makes the token optional, allowing the download to attempt without authentication (which may work for public repos or fail gracefully for private ones).
This allows PRs from forks to run CI without failing on private data access. The downloads are skipped with a warning message when the token is not available.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
docs/_build/htmldirectory doesn't existmyst build --htmlstarts a development server that doesn't exit, causing CI to hangChanges
documentationtarget in Makefile to:timeout 10 myst build --html || true_build/htmldirectory is created for GitHub Pages deploymentTest
Tested locally - the HTML files are successfully generated in
docs/_build/htmlNote
The PR test is failing on "Download data inputs" which is an unrelated issue that's also affecting the main branch push CI. This PR specifically addresses the documentation deployment issue.
Fixes the push CI documentation deployment failure.