feat: generate a restrict-mode example in the run action's audit report#170
Merged
Conversation
dash14
marked this pull request as ready for review
July 18, 2026 16:38
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.
Summary
The
reportaction's audit-mode Job Summary already includes a ready-to-paste restrict-mode YAML example, generated from the audited hosts viabuildRestrictExample(report/src/lib/build-example.js) — so a workflow author doesn't have to hand-copy hostnames out of the table. Therunaction's own report renderer (run/src/lib/report.js) reads the samereport.sections.auditeddata but never called this, so its audit-mode summary stopped at the audited-hosts table.run/src/main.jsalready computesactionRef/actionRepo(used only for image provenance verification), leaving them ready to reuse.This PR closes that gap. Since
runis a single self-contained step (unlikesetup+report's two-step flow), the generated example is arun@<ref>step withproxy_mode: restrictand the discovered allowlist rules, plus the originalrun:command preserved so the example stays copy-pasteable on its own.Changes
buildRestrictExamplefromreport/src/lib/build-example.jstocore/lib/build-example.jsso bothreportandruncan share itactionName/runCommandoption tobuildRestrictExample—actionNameselectssetup(existing behavior, default) vsrun; whenrun, the example step also includes arun: |block with the original commandrun/src/lib/report.js'sbuildReportMarkdown/writeReport, passingactionRepo/actionRef/runCommandthrough fromrun/src/main.jsdocs/reference.mdto document thatrun's audit-mode Job Summary now includes this example, mirroringreport's description