playbook/brooks-lint/docs/github-action-example.yml

28 lines
984 B
YAML

name: Brooks-Lint PR Review
on:
pull_request:
types: [opened, synchronize, reopened]
jobs:
brooks-lint:
name: Code Quality Review
runs-on: ubuntu-latest
permissions:
pull-requests: write # required to post PR comments
# security-events: write # uncomment to upload SARIF to Code Scanning (sarif-file)
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # needed for git diff main...HEAD
- uses: hyhmrright/brooks-lint/.github/actions/brooks-lint@main
with:
mode: review
anthropic-api-key: ${{ secrets.ANTHROPIC_API_KEY }}
fail-below: 70 # fail the check if Health Score drops below 70
# fail-on: critical # fail on any Critical finding (none | warning | critical)
# fail-on-regression: true # fail if the Health Score dropped vs the last run
# sarif-file: brooks-lint.sarif # also upload findings to GitHub Code Scanning