Install the GitHub App
Click Install on GitHub, pick the repository, and approve — no CI wiring, no runners. The App requests these scopes:
- Contents: Read-only — to read your repository's Terraform files (
.tf,.tf.json,.tfvars,.tfvars.json) and CloudFormation templates. audytx reads beyond the diff, because cross-resource reasoning needs the unchanged files too. - Pull requests: Read and write — to post the comment.
- Metadata: Read-only — required by GitHub for every App.
- Code scanning alerts: Read and write — for SARIF upload (when enabled).
- Checks: Read and write — for the audytx check run and its Re-run button.
- Issues: Read-only — to see the
/audytx rescancomment.
Subscribed events: pull_request (opened,
synchronize, reopened), check_run
(rerequested), and issue_comment
(created). Other actions (labels, edits, etc.) are ignored to
keep noise down.
Re-run a scan
Two ways to scan a pull request again without pushing a commit. Each re-scan of a pull request is billed as one scan, the same way as a scan after a push.
- Click Re-run on the audytx check in the pull request's Checks tab. This is not available for pull requests opened from a fork, because GitHub does not link a fork's check run to the pull request.
- Comment
/audytx rescanon the pull request's Conversation tab, as the whole comment. A comment inside a review or on the diff is not read. Only people with write, maintain, or admin access to the repository can trigger it. Any other comment is ignored, and audytx never replies to one.