CI gate

pipeline_check exits with a non-zero code when the gate fails, so you can wire it directly into a pipeline step and let the pipeline block the merge. The gate has four orthogonal fail conditions plus two subtractive filters; any tripped condition fails the gate (logical OR), and filters run before the conditions are evaluated.

Condition	Flag	Fails when…
Severity	`--fail-on SEV`	any effective finding's severity is ≥ `SEV`
Grade	`--min-grade A\\|B\\|C\\|D`	overall grade is worse than the bar
Count cap	`--max-failures N`	more than `N` effective failing findings
Specific check	`--fail-on-check ID`	a named check is in the effective set (repeat for many)
Named chain	`--fail-on-chain ID`	a named attack chain matched (repeat for many)
Any chain	`--fail-on-any-chain`	any attack chain matched at all

Default gate when no flag is set: equivalent to --fail-on CRITICAL. A single CRITICAL finding fails the gate, everything else passes.

This replaces the earlier "grade == D → fail" fallback, which muddled severity with total-count and let CRITICAL findings pass silently on sparsely-populated repos. Tighten with --fail-on HIGH or loosen by setting any explicit condition (e.g. --max-failures 9999) that takes precedence.

Two subtractive filters narrow what "effective" means:

Filter	Flag	Effect
Baseline	`--baseline PATH`	Drops every current finding that was already failing in a prior JSON report.
Ignore file	`--ignore-file PATH`	Drops hand-curated suppressions. Defaults to `.pipelinecheckignore`.

Exit codes are unchanged: 0 pass, 1 gate fail, 2 scanner error.

📖 Recipes

Block CRITICAL only (lenient rollout)

pipeline_check --pipeline aws --fail-on CRITICAL

Enforce a B-or-better grade

pipeline_check --pipeline aws --min-grade B

Zero-tolerance on specific checks

pipeline_check --pipeline github --gha-path .github/workflows \
    --fail-on-check GHA-002 --fail-on-check GHA-005

Cap total failures while the team pays down debt

pipeline_check --pipeline aws --max-failures 5

Block on named attack chains regardless of severity

# Fail only on a named subset (the team has explicitly opted in to
# blocking these patterns).
pipeline_check --fail-on-chain AC-001 --fail-on-chain AC-007

# Blanket guard: fail if any chain matched at all.
pipeline_check --fail-on-any-chain

Chain gates bypass baseline and ignore-file filtering: a correlated attack path is intrinsically a new finding even when its individual legs were each baselined separately. See attack_chains.md for the registered chain catalog.

Only block on new regressions (baseline diff)

# One-time: capture today's state as the baseline (run on main, store as artifact).
pipeline_check --pipeline aws --write-baseline baseline.json

# Per-PR: fail only on findings not present in the baseline.
pipeline_check --pipeline aws --fail-on HIGH --baseline baseline.json

--write-baseline PATH emits the same JSON shape --output json produces, so the resulting file feeds straight back into --baseline on subsequent runs. It is independent of --output, a CI lane can write the baseline AND emit SARIF for code-scanning in the same run. A [baseline] wrote N failing finding(s) to PATH line on stderr confirms the file landed.

When a finding is in the baseline, it is still reported in the terminal / HTML / SARIF output, the baseline affects only the gate decision, so teams see the whole picture without blocking on it.

Curate accepted tech debt

Create a .pipelinecheckignore file at the repo root:

# Shared secrets are rotated OOB, tracked in INFRA-4123.
CB-001:my-legacy-build-project

# We intentionally use AllAtOnce on this canary-only deployment group.
CD-002:my-canary-dg

# Whole check suppressed: being decommissioned this quarter.
PBAC-001

Lines are CHECK_ID (suppress everywhere) or CHECK_ID:RESOURCE (exact match). # starts a comment.

The file is discovered automatically when present; override with --ignore-file path/to/file.

Expiring suppressions (YAML format)

Pass --ignore-file .pipeline-check-ignore.yml (or any .yml / .yaml extension) to use the structured format:

- check_id: GHA-001
  resource: .github/workflows/release.yml
  expires: 2026-06-30
  reason: waiting on upstream Dependabot config

- check_id: GL-003

expires (ISO date) is optional; past the date the suppression no longer applies and the gate summary emits:

[gate] ignore rule expired on 2026-06-30: GHA-001:.github/workflows/release.yml (no longer suppressing)

Suppressions within 14 days of expiry surface an advance warning in the same place so the team schedules a revisit before the gate flips:

[gate] ignore rule expires in 5 days on 2026-06-30: GHA-001:.github/workflows/release.yml (still suppressing, but plan to revisit)

This forces a review rather than letting suppressions rot silently. reason is free-form metadata for reviewers.

Combine: new findings only, CRITICAL blocks, debt tracked explicitly

pipeline_check --pipeline aws \
    --baseline artifacts/baseline.json \
    --ignore-file .pipelinecheckignore \
    --fail-on CRITICAL

Evaluation order: 1. Failing findings are collected. 2. Baseline suppresses (check_id, resource) pairs already failing there. 3. Ignore file suppresses curated entries. 4. Remaining findings are the effective set. 5. Gate conditions evaluate against that set.

🗂️ Named scan profiles: `--policy`

Real teams run the same scanner with different bars in different lanes: pre-commit needs to be fast and HIGH-only, the PR gate runs the full pack with HIGH-fail, the release gate runs the full pack with MEDIUM-fail and forces attestation rules on. Encoding that as flags balloons the CI YAML, so policies collapse each profile into one named YAML file the repo reviews like any other config:

# policies/pre-merge.yml
description: PR gate -- full pack, HIGH-fail
gate:
  fail_on: HIGH

# policies/release-gate.yml
description: release-only profile, MEDIUM-fail, attestation rules forced
standards: [owasp_cicd_top_10, slsa]
gate:
  fail_on: MEDIUM
overrides:
  ATTEST-001:
    severity: CRITICAL

Then pick one per CI lane:

pipeline_check --policy pre-merge       # PR
pipeline_check --policy release-gate    # release
pipeline_check --list-policies          # enumerate everything discoverable

Files live under ./policies/<name>.yml or ./.pipeline-check/policies/<name>.yml (first directory found wins). A policy can carry any of: checks (whitelist), standards (filter), gate.fail_on / gate.min_grade / gate.max_failures / gate.fail_on_checks, and per-rule overrides. The --policy argument resolves bare names through the search path; an explicit file path bypasses the lookup. Path traversal in the name (.., separators) is rejected at the CLI boundary.

Precedence: policy values are defaults. Anything set by the config file, environment variables, or explicit CLI flags wins over the policy, so --policy pre-merge --max-failures 5 tightens the bar the policy declared without rewriting the YAML.

When a policy loads, a [policy] loaded '<name>' from <path> line prints to stderr so the active profile is visible in CI logs.

📣 Gate summary on stderr

Unless --output json is active (stdout must stay clean), every run prints a short summary to stderr:

[gate] FAIL
        - 3 finding(s) at or above HIGH (CRITICAL, HIGH): --fail-on HIGH
        - 7 failing findings exceed --max-failures 5
[gate] 12 finding(s) suppressed by baseline
[gate] 2 finding(s) suppressed by ignore file

This makes failure diagnosis immediate without parsing the full JSON.

🎛️ How the default interacts with filters

The default --fail-on CRITICAL applies to the effective set, after baseline + ignore-file filtering. So a CRITICAL already in the baseline (or explicitly ignored) does not trip the default gate. Only as-yet-unacknowledged CRITICALs fail CI.

As soon as any of --fail-on, --min-grade, --max-failures, or --fail-on-check is passed, those govern and the implicit default is suppressed.

🔀 Scoping to changed files: `--diff-base`

PR pipelines often only want to scan workflows the PR actually touches. --diff-base REF runs git diff --name-only <REF>...HEAD and filters the workflow/pipeline documents down to the changed set before checks run.

pipeline_check --pipeline github --diff-base origin/main --fail-on HIGH

If git is unavailable or the ref can't be resolved, the flag no-ops and a full scan runs, over-scanning is safer than silently skipping everything in CI.

Provider support:

Workflow providers (github, gitlab, bitbucket, azure), filters the loaded workflow documents to just the changed files.
terraform: filters planned resources to those whose module directory is touched by the diff. A change in modules/vpc/main.tf keeps module.vpc.* resources, drops unrelated modules. A change in a root *.tf file keeps root-level resources.
aws: rejected with a clear error. Live AWS resources aren't bound to git refs; narrow the scope with --target NAME instead.

📌 Baseline from a git ref: `--baseline-from-git REF:PATH`

--baseline reads a JSON report from disk. When baselines are stored in the repo itself (committed artifact) or on a merge-base branch, --baseline-from-git REF:PATH pulls them via git show:

# Gate only on findings not already present on origin/main's baseline.json.
pipeline_check --pipeline github \
    --baseline-from-git origin/main:artifacts/baseline.json \
    --fail-on HIGH

Mirrors --diff-base: a git failure (unreachable ref, missing path) degrades to "no baseline" instead of raising. --baseline (file path) takes precedence if both are set.

🩹 Autofix: `--fix`

For a subset of checks, pipeline_check can emit the exact source edit that would remediate the finding. The output is a standard unified diff on stdout, so it composes with git apply:

pipeline_check --pipeline github --fix | git apply

The tool never modifies files directly by default, review the patch, apply or discard. 111 fixers are registered across every provider covering pinning, credential redaction, timeouts, TLS-bypass commenting, script-injection env-binding, Docker insecure flags, Kubernetes securityContext, and curl-pipe commenting. The full per-check matrix (which rule has a fixer) is rendered as a 🔧 chip in the rules table on each provider's reference page under providers/.

A few representative entries:

Check	Fix
GHA-002 / GL-002 / BB-002 / ADO-002	Adds `persist-credentials: false` under every `actions/checkout` step.
GHA-004	Inserts `permissions: contents: read` at the top of the workflow.
`*-008` (cred literals)	Replaces credential-shaped literals with `"<REDACTED>"` and a `TODO(pipeline-check)` marker. Same fixer wired across GHA / GL / BB / ADO / CC / JF / BK / TKN / ARGO.
`*-016` (curl-pipe)	Comments out the offending `curl ... \\| sh` line and leaves a sibling note.
`*-023` (TLS bypass)	Comments out `--insecure` / `-k` / `--no-check-certificate` invocations across Docker / Maven / Gradle / AWS CLI.
K8S `securityContext`	Backfills `runAsNonRoot`, `readOnlyRootFilesystem`, drops `ALL` capabilities.

Fixers are idempotent, re-running against already-remediated content emits nothing for that finding. A broken fixer logs to stderr and is skipped; the rest of the run continues.

Applying patches directly: `--fix --apply`

When you trust the fixer catalog, skip the git apply round-trip:

pipeline_check --pipeline github --fix --apply
# [autofix] 3 file(s) modified.

--apply is opt-in (dry-run by default), only valid with --fix, and reports the modified-file count on stderr. Stdout is untouched by --apply so the rest of the report (terminal / JSON / SARIF) still behaves the same.

When --output is json, sarif, html, or both, patches from plain --fix (without --apply) route to stderr automatically so the machine-readable stream on stdout stays valid.

🎯 Selecting checks: globs

--checks accepts glob patterns (fnmatch syntax), not just exact IDs:

# All secret-scanning checks across every provider
pipeline_check --pipeline github --checks '*-008'

# Every GitHub check
pipeline_check --pipeline github --checks 'GHA-*'

# A range
pipeline_check --pipeline gitlab --checks 'GL-00[12]'

Exact IDs (--checks GHA-001) still work unchanged.

🔐 Custom secret patterns

The secret-scanning checks (GHA-008, GL-008, BB-008, ADO-008, JF-008, CC-008, DR-004, …) ship with 46 named vendor-token detectors. Sample of the catalog:

Detector	Matches
`aws_access_key`	`AKIA…` / `ASIA…` (16 trailing chars)
`github_token`	`ghp_` / `gho_` / `ghu_` / `ghs_` / `ghr_` (36+ trailing)
`slack_token`	`xoxa-` / `xoxb-` / `xoxp-` / `xoxr-` / `xoxs-`
`jwt`	`eyJ…` three-segment header.payload.signature
`stripe_secret`	`sk_live_` / `sk_test_` / `rk_live_` / `rk_test_` (24+ payload)
`google_api_key`	`AIza…` (35 trailing chars)
`pypi_token`	`pypi-AgEIcHlwaS5vcmc…` (50+ trailing)
`docker_hub_pat`	`dckr_pat_…` (20+ trailing)
`gitlab_pat`	`glpat-…` (20 trailing)
`anthropic_api_key`	`sk-ant-api03-…` (90+ trailing)
`openai_api_key`	`sk-…` / `sk-proj-…` (40+ trailing)
`digitalocean_token`	`dop_v1_…` (64 hex)
`hashicorp_vault`	`hvs.…` (24+ trailing)
`terraform_cloud_token`	`<14-alnum>.atlasv1.<60+>`
`cohere_api_key`	`co_pat_…` (40+ trailing)
`replicate_token`	`r8_…` (40 trailing)
`asana_pat`	`1/<account-id>:<32-hex>`
`square_access_token`	`sq0(atp\\|csp)-…`
`…`	plus 28 more (Twilio, Mailchimp, Shopify, Databricks, HuggingFace, Linear, PlanetScale, New Relic, Grafana, Telegram, Atlassian, GitLab Runner / CI, Supabase, Fly, Pulumi, Doppler, Netlify, Railway, Render, Prefect, Neon, age, …)

Plus a multi-line private_key detector that fires on any -----BEGIN PRIVATE KEY----- block (RSA, DSA, EC, OPENSSH, PGP, and the PKCS#8 ENCRYPTED PRIVATE KEY form, still a leak even when the body is password-protected: offline brute-force is cheap once the file has left the perimeter).

Each hit is labeled with the matched detector, finding descriptions read like aws_access_key:AKIA…LE, stripe_secret:sk_l…23 so operators can write targeted ignore rules per-detector instead of suppressing the whole *-008 check.

Placeholder suppression: tokens containing obvious documentation markers (<your-key>, XXXXX, replace_me, dummy_key, …) are silently skipped before reaching the user. The canonical AWS docs example AKIAIOSFODNN7EXAMPLE is deliberately NOT suppressed, if it shows up in a real workflow it almost always means someone copy-pasted from docs and forgot to substitute.

Add org-specific patterns with --secret-pattern REGEX (repeat for multiple) or a secret_patterns: list in the config file. User patterns share a single custom: label:

pipeline_check --pipeline github \
    --secret-pattern '^acme_[a-f0-9]{32}$' \
    --secret-pattern '^xoxo-[A-Z0-9]{20,}$'

Patterns are Python regex syntax; anchor with ^...$ to whole-token match. Tokens are extracted from every string in the workflow, split on whitespace and common shell separators. See config.md for the config-file form.

Shannon-entropy fallback (`--detect-entropy`)

For credentials with no public prefix (an internal Snowflake token, a custom JWT issuer secret, an opaque session token), opt in to a second pass that flags high-entropy values (>= 3.5 bits/char, length >= 20) appearing in YAML key contexts that suggest a credential (API_KEY, apiToken, database-password, …) and that the deterministic detectors haven't already matched:

pipeline_check --detect-entropy

Off by default, turning it on can introduce new findings on previously-clean scans, so the upgrade is opt-in only. Layered false-positive suppression keeps signal high (key-context vocabulary match, length floor, token-shape filter, deterministic-detector overlap, placeholder markers). Hits are labeled entropy:<redacted> so operators can write targeted ignore rules per-class.