Skip to main content
Add MergeGuide to GitHub with the official Action. It runs your policy checks on pushes and pull requests, and can upload SARIF results to GitHub code scanning so findings appear in the Security tab.

Add the Action

Create .github/workflows/mergeguide.yml in your repository:
.github/workflows/mergeguide.yml

Action inputs

Action outputs

Upload to GitHub code scanning

To make findings appear in the repository’s Security tab, write SARIF and upload it. Grant the job security-events: write:
.github/workflows/mergeguide.yml

Block merges on findings

To hold a merge until blocking findings are resolved, add the MergeGuide job to your branch’s required status checks in Settings → Branches. Once required, a pull request can’t merge while the check is failing. See Set up the PR gate.

Next steps

PR gate

Block merges on blocking findings.

CI/CD patterns

Wire MergeGuide into any pipeline.