ci: gate PR manual preview on user guide changes#765
ci: gate PR manual preview on user guide changes#765ejgallego wants to merge 1 commit intoleanprover:mainfrom
Conversation
|
Preview for this PR is ready! 🎉 |
ejgallego
force-pushed
the
feat/ci-userguide-deploy
branch
from
5419f04 to
63827a0
Compare
ejgallego
changed the title
ejgallego
force-pushed
the
feat/ci-userguide-deploy
branch
from
63827a0 to
a257ccb
Compare
ejgallego
changed the title
Reduce noise only for pull requests by restricting PR preview deploys/comments to changes under doc/UsersGuide/. This keeps production deployment behavior unchanged: - pushes/merges to main still always deploy the manual Implementation details: - keep first-party actions/github-script check in ci.yml (with inline supply-chain rationale) for PR changed-files detection - upload `html-manual-for-deploy` only when UsersGuide files changed - in pr-deploy.yml, remove duplicated path-check logic and gate deploy/comment directly on whether that artifact exists (`found_artifact`) Small downside: PRs that only change Verso rendering internals will not get preview deployment/comments.
ejgallego
force-pushed
the
feat/ci-userguide-deploy
branch
from
a257ccb to
9c64958
Compare
|
This would have made it more difficult to review the dark mode PR (#641), for example. What's the major benefit here? How do the comments hurt anything? |
I agree.
The main source of noise is that I now get a comment notification for all PRs in the GitHub web interface due to the bot. Unfortunately there seems no way to filter those. |
|
What if we rejigger the CI so that it creates a deployment instead of posting a comment? If we can do that, then it may solve the issue. |
I didn't know about GH deployment, that seems a great idea, thanks! |
2 participants
Summary
doc/UsersGuide/**changedmainstill always deploy the manualpr-deploy.ymlartifact-drivenImplementation
ci.yml, use first-partyactions/github-script(with inline supply-chain rationale) to detect UsersGuide changes on PRshtml-manual-for-deploywhen that predicate is truepr-deploy.yml, always attempt artifact download withif_no_artifact_found: ignore, and gate deploy/comment onsteps.manual-artifact.outputs.found_artifact == 'true'Tradeoff