fix: overhaul docs build process #103
Merged
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
Fixes the documentation build failure caused by attempting to checkout a non-existent gh-pages branch. Changes: - Simplified tools/build_docs.py to remove gh-pages branch dependency - Removed version management complexity (redirect logic, version spec) - Updated .github/workflows/docs.yml to use modern GitHub Pages workflow: - Split into separate build and deploy jobs - Use actions/upload-pages-artifact@v4 instead of deprecated artifact methods - Use actions/deploy-pages@v4 for deployment - Added proper permissions (pages: write, id-token: write) - Added github-pages environment configuration - Removed release asset upload workflow Resolves: https://github.com/litestar-org/sqlspec/actions/runs/18332513028
cofin
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Fixes the documentation build failure caused by attempting to checkout a non-existent
gh-pagesbranch.This PR modernizes the documentation build and deployment workflow to use GitHub's current best practices for GitHub Pages deployment (2025).
The previous workflow tried to checkout a
gh-pagesbranch that doesn't exist, causing this error:References