sourcegraph/dev/pr-auditor
2023-12-13 15:32:31 +01:00
..
batch-changes dev/pr-auditor: run on pull_request_target (#38259) 2022-07-05 15:14:23 -07:00
testdata/pull_request_body pr-auditor: support test plans in poorly formatted markdown (#33624) 2022-04-07 21:25:50 +00:00
BUILD.bazel [chore] Use consistent go-github versioning (#57391) 2023-10-06 10:48:18 +02:00
check_test.go dev/pr-auditor: use labels to exempt from review (#49656) 2023-03-18 00:17:05 -07:00
check-pr.sh pr-auditor: test plan checks and audit trail for exceptions (#30278) 2022-02-14 13:18:17 -08:00
check.go [chore] Use consistent go-github versioning (#57391) 2023-10-06 10:48:18 +02:00
issue_test.go pr-auditor: add a flag to pass additional context (#37122) 2022-06-13 13:13:57 +00:00
issue.go [chore] Use consistent go-github versioning (#57391) 2023-10-06 10:48:18 +02:00
main.go dev: add a --skip-status flag to pr auditor (#58959) 2023-12-13 15:32:31 +01:00
README.md dev: add a --skip-status flag to pr auditor (#58959) 2023-12-13 15:32:31 +01:00
webhook.go dev/pr-auditor: use labels to exempt from review (#49656) 2023-03-18 00:17:05 -07:00

pr-auditor pr-auditor

pr-auditor is a tool designed to operate on some GitHub Actions pull request events in order to check for SOC2 compliance. Owned by the DevInfra team.

Learn more: Testing principles and guidelines

Usage

This action is primarily designed to run on GitHub Actions, and leverages the pull request event payloads extensively.

The optional -protected-branch flag defines a base branch that always opens a PR audit issue to track all pull requests made to it.

GITHUB_EVENT_PATH="/path/to/json/payload.json"
GITHUB_TOKEN="personal-access-token"

# run directly
go run ./dev/pr-auditor/ check \
  -github.payload-path="$GITHUB_EVENT_PATH" \
  -github.token="$GITHUB_TOKEN" \
  -protected-branch="release"

# run using wrapper script
./dev/buildchecker/check-pr.sh

Deployment

pr-auditor can be deployed to repositories using the available batch changes.