Skip to content

Add PR docs preview lifecycle via gh-pages#75

Draft
Marius Storhaug (MariusStorhaug) wants to merge 8 commits into
mainfrom
pr-docs-previews
Draft

Add PR docs preview lifecycle via gh-pages#75
Marius Storhaug (MariusStorhaug) wants to merge 8 commits into
mainfrom
pr-docs-previews

Conversation

@MariusStorhaug

Copy link
Copy Markdown
Member

Summary

Implement a full pull-request preview lifecycle for docs changes, including deploy, iterative update, and cleanup.

What changed

  • Reworked .github/workflows/Docs.yml to support:
    • preview deploy/update for PR opened, reopened, and synchronize
    • preview cleanup on PR closed
    • per-PR environment name + URL (pr-preview-<number>) for clickable pipeline links
    • PR comments that publish/update preview URL and update removal status on close
    • gh-pages updates performed through auto-merged PRs (no direct commits to gh-pages)
  • Switched live docs publish flow to branch-based gh-pages updates via PR + auto-merge.
  • Added .github/PR-PREVIEW.md with setup expectations and required Scribbler GitHub App permissions.
  • Updated README.md with preview URL behavior and setup doc link.

Required repo/app setup

See .github/PR-PREVIEW.md for the complete checklist and required Scribbler permissions.

Notes

This assumes:

  • gh-pages already exists and is configured as the GitHub Pages source.
  • gh-pages branch protection enforces PR-only updates.
  • auto-merge is enabled for the repository.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@github-actions

github-actions Bot commented Jul 19, 2026

Copy link
Copy Markdown

Super-linter summary

Language Validation result
CHECKOV Pass ✅
GITHUB_ACTIONS Pass ✅
GITHUB_ACTIONS_ZIZMOR Pass ✅
GITLEAKS Pass ✅
GIT_MERGE_CONFLICT_MARKERS Pass ✅
HTML Pass ✅
JAVASCRIPT_ES Pass ✅
JAVASCRIPT_PRETTIER Pass ✅
MARKDOWN Pass ✅
NATURAL_LANGUAGE Pass ✅
POWERSHELL Pass ✅
PRE_COMMIT Pass ✅
SPELL_CODESPELL Pass ✅
TRIVY Pass ✅
YAML Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant