Skip to content

docs: document BRANCH and DEBUG, and info as a severity threshold #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joeymussalli wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document BRANCH and DEBUG, and info as a severity threshold #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,15 @@ One scanner (`scan/trustabl-scan.sh`), two integrations:
| `TARGET` | `.` | Path or GitHub URL to scan. |
| `VERSION` | `latest` | trustabl release tag (e.g. `v0.5.0`) or `latest`. |
| `DETECTORS` | _(all)_ | Comma-separated SDK subset (`claude_sdk,openai_sdk,google_adk,...`). |
| `BRANCH` | _(detected)_ | Branch label for the report. **Set this on CodePipeline** — see below. |
| `DEBUG` | `false` | `true` turns on `set -x` command tracing. |
| `STRICT` | `false` | Fail on any finding. |
| `RULES_REF` | _(default)_ | Pin a `trustabl-rules` git ref. |
| `RULES_REPO` | _(default)_ | Override the `trustabl-rules` source repo. |
| `SARIF_FILE` | `trustabl.sarif` | SARIF output path. |
| `JSON_FILE` | `trustabl.json` | JSON ScanResult output path. |
| `RISK_SCORE_THRESHOLD` | `0` | Fail when risk (100 − readiness) >= N. `0` disables. |
| `SEVERITY_THRESHOLD` | `none` | Fail when any finding >= severity (`none/low/medium/high/critical`). |
| `SEVERITY_THRESHOLD` | `none` | Fail when any finding >= severity (`none/info/low/medium/high/critical`). |
| `GITHUB_TOKEN` | _(none)_ | Optional — avoids GitHub's 60 req/hr anonymous rate limit. |

## Outputs
Expand All @@ -34,6 +36,15 @@ One scanner (`scan/trustabl-scan.sh`), two integrations:
(`TRUSTABL_READINESS_SCORE`, `TRUSTABL_RISK_SCORE`, `TRUSTABL_MAX_SEVERITY`,
`TRUSTABL_FINDINGS_COUNT`, `TRUSTABL_EXIT_CODE`).

## Why `BRANCH` matters on CodePipeline

The script tries three ways to work out the branch and repository, and on
CodePipeline all three miss. `CODEBUILD_WEBHOOK_HEAD_REF` is set only for
*webhook* events; `CODEBUILD_SOURCE_REPO_URL` "may be empty" when the build
originates from CodePipeline; and a pipeline source artifact is an unzipped
snapshot with no `.git` for the final fallback. Every report then reads
`Repository: .` / `Branch: unknown`. Set `BRANCH` explicitly to get a real label.

## A note on "AWS Marketplace"

AWS has **no self-serve CI-plugin catalog** like the GitHub/Azure/Bitbucket
Expand Down