Add docs preview deployment and PR comment link to CI#322
Draft
Add docs preview deployment and PR comment link to CI#322
Conversation
Co-authored-by: JohnGriffiths <397826+JohnGriffiths@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add GitHub Actions for viewing built docs on CI
Add docs preview deployment and PR comment link to CI
Mar 19, 2026
JohnGriffiths
approved these changes
Mar 19, 2026
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.
The docs workflow built documentation on every PR but provided no way to view the output. This adds PR preview deployments with an automatic bot comment linking to the live preview.
Changes to
.github/workflows/docs.ymltypes: [opened, synchronize, reopened, closed]— triggers cleanup when PRs closecontents: write(push togh-pages) andpull-requests: write(post PR comments)if: github.event.action != 'closed'— only cleanup runs on PR closedocs-{sha}artifact after each successful build, downloadable from the Actions runrossjrw/pr-preview-action@v1): Deploys built HTML togh-pages/pr-preview/pr-{number}/and posts a bot comment on the PR with the preview URLrossjrw/pr-preview-action@v1): Cleans up thegh-pagessubdirectory when the PR is closed/mergedThe existing master-branch deployment via
peaceiris/actions-gh-pagesis unchanged. Preview URLs follow the pattern:✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.