Skip to content

ci: doc previews for PRs from forks#3625

Merged
ianna merged 5 commits intoscikit-hep:mainfrom
ariostas:docs_preview_workflow
Aug 26, 2025
Merged

ci: doc previews for PRs from forks#3625
ianna merged 5 commits intoscikit-hep:mainfrom
ariostas:docs_preview_workflow

Conversation

@ariostas
Copy link
Copy Markdown
Member

Since we're switching to a fork-based workflow we'll need to adapt the docs preview job so that it works on PRs from forks.

There was a comment saying that it can only be deployed for PRs on host repo, so I'm not sure if something will fail or if it was a self-imposed restriction.

@agoose77
Copy link
Copy Markdown
Collaborator

At the time the deployment failed on forks because we don't provision credentials -- pull_request_target is risky.

@codecov
Copy link
Copy Markdown

codecov bot commented Aug 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.54%. Comparing base (b749e49) to head (80ef4a1).
⚠️ Report is 405 commits behind head on main.

Additional details and impacted files

see 196 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ariostas ariostas marked this pull request as draft August 19, 2025 13:50
@ariostas
Copy link
Copy Markdown
Member Author

ariostas commented Aug 19, 2025

@agoose77 Okay, that makes sense.

We could consider looking for alternatives. For example, we could use Netlify for live previews and GH pages for the "real" documentation. And that way we could ditch AWS.

Netlify has a free tier that seems good. But I'll look at other alternatives.

EDIT: Cloudflare pages looks pretty good. I'll look into that.

@ariostas
Copy link
Copy Markdown
Member Author

I couldn't get it to work with Cloudflare since they don't have doxygen avaliable. I think Netlify could work, but I don't know if the free plan would be limiting.

So I guess let's stick with AWS. I think we can get this to work with workflow_run. We would just need to move the deploy preview job to a workflow with that trigger, and then it can be triggered from the usual docs workflow. It only runs the workflow present on the default branch and has access to secrets, so it gets around the need to use pull_request_target.

@ianna ianna added the pr-next-release Required for the next release label Aug 21, 2025
@ariostas ariostas marked this pull request as ready for review August 26, 2025 14:12
@ianna ianna enabled auto-merge (squash) August 26, 2025 15:45
Copy link
Copy Markdown
Member

@ianna ianna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ariostas - Thanks! This looks great. I'm enabling auto-merge.

@ianna ianna disabled auto-merge August 26, 2025 15:48
@github-actions
Copy link
Copy Markdown

The documentation preview is ready to be viewed at http://preview.awkward-array.org.s3-website.us-east-1.amazonaws.com/PR3625

@ariostas
Copy link
Copy Markdown
Member Author

@ianna can you remove "Deploy Branch Preview" from the required checks? Since that is now in a separate workflow it won't show up here.

@ianna ianna enabled auto-merge (squash) August 26, 2025 16:10
@ianna ianna merged commit db7d12a into scikit-hep:main Aug 26, 2025
46 checks passed
@ariostas ariostas deleted the docs_preview_workflow branch August 26, 2025 16:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr-next-release Required for the next release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants