Add PR Preview Deployments for Documentation
@mgajek-cern is already working on this.
Since Dec 1, 2025.
- Dominant language
- Python
- Stars
- 4
- Forks
- 71
- Avg merge
- 2d 1h
- Merged PRs (30d)
- 11
Description
Context
We build documentation on every PR to catch issues before merge. However, these build artifacts are currently discarded - only main branch builds get deployed.
This is especially problematic for external contributors who cannot easily run the full documentation build locally (requires Docker, rucio/rucio clone, API generation, etc.). Reviewers and contributors currently cannot see how their changes will look when rendered.
Proposal
Reuse PR build artifacts to create preview environments, allowing anyone (especially external contributors without local setup) to see rendered documentation changes.
Potential Solutions
Option 1: GitHub Pages PR Previews (Free, native)
- uses: rossjrw/pr-preview-action@v1
with:
source-dir: website/build
Preview URL: https://rucio.github.io/documentation/pr-preview/pr-123/
Option 2: Netlify Deploy Previews (Free tier, popular in OSS)
- Automatic preview URLs per PR
- Comments preview link on PR automatically
- Works for forks (external contributors)
Option 3: Surge.sh (Simple, free)
- Quick setup, ephemeral deployments
- URL:
rucio-docs-pr-123.surge.sh
Option 4: GitHub Pages PR Previews (Free, native)
- Uses
JamesIves/github-pages-deploy-actiondirectly for cross-repo deployment - Uses
pull_request_targetto support fork PRs with secrets access - Deploys to
gh-pagesbranch underpr-preview/pr-{number}/ - Automatic cleanup when PRs close
- Sticky PR comments with preview URLs
- Scheduled cleanup for orphaned previews
Preview URL: https://rucio.github.io/documentation/pr-preview/pr-123/
Benefits
- 🌍 External contributors can preview their changes without complex local setup
- 📖 Reviewers can see rendered changes instantly
- 🐛 Catch rendering/styling issues before merge
- ⚡ No extra build cost (already building on PRs)
- 🔗 Shareable preview links for feedback
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.