Fix docs artifact upload paths#332
Merged
Merged
Conversation
Strip query and fragment suffixes from files mirrored from the published docs site so GitHub artifact upload accepts the multi-version Pages artifact.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes GitHub Actions docs artifact uploads by normalizing filenames produced by recursive wget mirroring (e.g., assets saved with query strings like clipboard.min.js?v=...), which are rejected by actions/upload-artifact.
Changes:
- Added
normalize_artifact_paths()to strip URL query/fragment suffixes and replace GitHub-artifact-invalid characters in mirrored filenames. - Applied path normalization after copying/downloading published docs versions into the local multi-version build tree.
- Added regression tests covering both renaming query-suffixed assets and deleting redundant query-string duplicates when the safe filename already exists.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/scripts/merge_published_site.py | Adds and invokes artifact-path normalization during published-site merge/download flows. |
| tests/docs/conftest.py | Re-exports the new normalization helper from the merge script for tests. |
| tests/docs/test_merge_published_site.py | Adds regression tests for query-string filename normalization and duplicate removal. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Description
This PR normalizes files mirrored from the published docs site before uploading the multi-version docs artifact. Recursive
wgetcan save cache-busted URLs as literal filenames such as_static/clipboard.min.js?v=a7894cd8, andactions/upload-artifactrejects?in artifact paths.The fix strips URL query and fragment suffixes from mirrored filenames, replaces other artifact-invalid characters, and removes redundant query-string duplicates when the browser-addressable asset already exists.
Dependencies: none
Fixes the failed CI/CD Pipeline run that could not upload the docs site artifact.
Type of change
Screenshots
N/A
Checklist
black .command to format the code base.Verification
black .pytest tests/docs -q --confcutdir=tests/docs