feat(doc): surface the docs preview artifact in the PR job summary - #314
Merged
Minipada merged 2 commits intoAug 10, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## jazzy #314 +/- ##
=======================================
Coverage 40.50% 40.50%
=======================================
Files 82 82
Lines 5094 5094
=======================================
Hits 2063 2063
Misses 3031 3031
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
doc.yaml already uploaded the built book as a workflow artifact on every run, including PRs, but finding it meant digging into the run's Artifacts section. Capture the upload step's artifact-url output and write a direct download link to $GITHUB_STEP_SUMMARY on PR runs, so the preview is one click from the PR's Checks tab. Stays artifact-only rather than a hosted deploy: this repo has no preview host configured (#184), and reaching one from a fork PR would need pull_request_target plus a deploy token exposed to untrusted PR code. pull_request keeps this safe for fork PRs since the default GITHUB_TOKEN there is read-only, which is all an artifact upload needs. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BxvjR5XyyaEPBBpwGfUK9W Signed-off-by: David Bensoussan <d.bensoussan@proton.me>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BxvjR5XyyaEPBBpwGfUK9W Signed-off-by: David Bensoussan <d.bensoussan@proton.me>
Minipada
force-pushed
the
feature/135-publish-a-documentation-preview-from-pr
branch
from
August 10, 2026 09:36
09f9a4f to
81c41ce
Compare
Minipada
deleted the
feature/135-publish-a-documentation-preview-from-pr
branch
August 16, 2026 14:12
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.
Summary
doc.yaml(#252) already uploaded the built mdbook site as a workflow artifact (doc-site) on every run, including PRs — nothing restricted that step topush. What #135 actually needed was discoverability: the artifact was buried in the run's Artifacts section, several clicks past where a reviewer lands from the PR's Checks tab.Upload the built sitestep anidand, onpull_requestruns, read itsartifact-urloutput (available immediately post-upload since upload-artifact v4) into an env var and write a Markdown download link to$GITHUB_STEP_SUMMARY— the same page "Details" on a PR check opens.pull_request_targetplus a deploy token — secrets exposed to untrusted PR code.pull_requestkeeps this safe; its defaultGITHUB_TOKENis read-only, which is all an artifact upload needs, so fork PRs get the same preview link as same-repo PRs.Acceptance criteria (from #135)
pull_requesttrigger, no secrets, documented in the workflow headerTest plan
pre-commit run --files .github/workflows/doc.yaml—check-yamlpasses; thebuild-dochook (realstrictdoc export+mdbook build) passes unaffectedartifact-urloutput and$GITHUB_STEP_SUMMARYare documented, stable GitHub Actions featuresCloses #135
Co-Authored-By: Claude Sonnet 5 noreply@anthropic.com
https://claude.ai/code/session_01BxvjR5XyyaEPBBpwGfUK9W