Skip to content
MergeRay/ docs

Search documentation

Local documentation search Tab to navigate · Esc to close

GitHub Action

Understand the trusted workflow that turns a pull request into a source review.

On this page Workflow requirementsRequired permissionsKeep the source boundary intactRead the Check and summary

Workflow requirements

The current entry point accepts same-repository pull_request events on github.com. Fork PRs, general push events and GitHub Enterprise are outside this profile.

The service must register the repository identity, caller workflow, Base branch, policy and immutable reusable workflow SHA. An unregistered job cannot authenticate just by requesting an OIDC token.

Required permissions

GitHub publication permissions and the short-lived OIDC service identity serve different purposes.

PermissionPurpose
contents: readRead repository context.
actions: readVerify workflow execution context.
pull-requests: readRead the pull request context.
checks: writePublish the GitHub Check.
id-token: writeRequest the OIDC identity token.

Keep the source boundary intact

Pin the reviewed Action and reusable workflow to immutable commits. Exact Base and raw Head objects must exist locally. Policy comes from trusted Base, never executable Head configuration.

Do not run untrusted install scripts, hooks or application builds while credentials are present. The source-review path does not need to execute the customer application.

Read the Check and summary

The Action returns status, conclusion, delivery and run-id. Findings are published in a GitHub Check and job summary; inline PR review comments are not part of this public entry point.

Analysis outcome and publication delivery are separate. An absent or stale Check cannot be treated as a clean review.

Understand review results