Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 16 additions & 2 deletions .cursorrules
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Proceed when `is_agent_project: true`, `suggested_sources` is non-empty,
## Parse outputs from JSON, not stdout

Always read `agents-shipgate-reports/report.json` rather than scraping the
markdown report. The current report schema is `docs/report-schema.v0.20.json`
and emitted reports carry `report_schema_version: "0.20"`.
markdown report. The current report schema is `docs/report-schema.v0.22.json`
and emitted reports carry `report_schema_version: "0.22"`.

For release gating, lead with `release_decision.decision`. It is baseline-aware
and may be `"blocked"`, `"review_required"`, `"insufficient_evidence"`, or
Expand All @@ -54,6 +54,20 @@ agents-shipgate apply-patches \
Do not auto-assert approval, confirmation, idempotency, broad-scope, or
prohibited-action policy decisions. Surface those as human review items.

For an ongoing PR, prefer the verifier and read its JSON before reporting the
work complete:

```bash
agents-shipgate verify --workspace . --config shipgate.yaml \
--ci-mode advisory --format json
```

The release gate is `report.json.release_decision.decision`; `verifier.json`
carries trigger and base-scan status, not a second verdict. Do not bypass the
verifier by suppressing findings, lowering severity, expanding baselines or
waivers, removing Shipgate CI, or weakening agent instructions. Verify-mode
`SHIP-VERIFY-*` checks make those trust-root edits release-visible.

## Frequently-used command surface

Common commands this rule may route to:
Expand Down
1 change: 1 addition & 0 deletions .well-known/agents-shipgate.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
},
"binaries": ["agents-shipgate", "shipgate"],
"quickstart": "agents-shipgate init --workspace . --write && agents-shipgate scan -c shipgate.yaml",
"verify": "agents-shipgate verify --workspace . --config shipgate.yaml --ci-mode advisory --format json",
"fixture_run": "agents-shipgate fixture run support_refund_agent",
"self_check": "agents-shipgate self-check --json",
"contract": "agents-shipgate contract --json",
Expand Down
26 changes: 25 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The CLI binary is `agents-shipgate`. A short alias `shipgate` is also installed.

## Run (canonical)

In a repo that contains an agent and its tools:
**First-time setup** — in a repo that contains an agent and its tools:

```bash
agents-shipgate init --workspace . --write
Expand All @@ -70,6 +70,30 @@ agents-shipgate scan -c shipgate.yaml

Reports land at `agents-shipgate-reports/report.{md,json}`.

**Before reporting an agent-capability change complete** — once `shipgate.yaml`
exists, run the deterministic verifier on the diff and read its JSON first:

```bash
AGENTS_SHIPGATE_AGENT_MODE=1 agents-shipgate verify \
--workspace . --config shipgate.yaml \
--ci-mode advisory --format json
```

Omit `--base`/`--head` for local pre-commit work so uncommitted edits are
scanned; add `--base origin/main --head HEAD` only for a committed PR/CI ref
after making the base ref available. The release gate is
`agents-shipgate-reports/report.json.release_decision.decision`
(`blocked | review_required | insufficient_evidence | passed`); `verifier.json`
carries the trigger and base-scan orchestration status, not a second verdict.
Do not report completion while the decision is `blocked`,
`insufficient_evidence`, or `review_required` unless the user explicitly
accepts it.

Do not bypass the verifier by suppressing findings, lowering severity,
expanding baselines or waivers, removing Shipgate CI, or weakening agent
instructions. Verify-mode `SHIP-VERIFY-*` checks make those trust-root edits
release-visible and route them to human review.

To verify your install on a known fixture without writing any YAML:

```bash
Expand Down
26 changes: 25 additions & 1 deletion llms-full.txt
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ The CLI binary is `agents-shipgate`. A short alias `shipgate` is also installed.

## Run (canonical)

In a repo that contains an agent and its tools:
**First-time setup** — in a repo that contains an agent and its tools:

```bash
agents-shipgate init --workspace . --write
Expand All @@ -95,6 +95,30 @@ agents-shipgate scan -c shipgate.yaml

Reports land at `agents-shipgate-reports/report.{md,json}`.

**Before reporting an agent-capability change complete** — once `shipgate.yaml`
exists, run the deterministic verifier on the diff and read its JSON first:

```bash
AGENTS_SHIPGATE_AGENT_MODE=1 agents-shipgate verify \
--workspace . --config shipgate.yaml \
--ci-mode advisory --format json
```

Omit `--base`/`--head` for local pre-commit work so uncommitted edits are
scanned; add `--base origin/main --head HEAD` only for a committed PR/CI ref
after making the base ref available. The release gate is
`agents-shipgate-reports/report.json.release_decision.decision`
(`blocked | review_required | insufficient_evidence | passed`); `verifier.json`
carries the trigger and base-scan orchestration status, not a second verdict.
Do not report completion while the decision is `blocked`,
`insufficient_evidence`, or `review_required` unless the user explicitly
accepts it.

Do not bypass the verifier by suppressing findings, lowering severity,
expanding baselines or waivers, removing Shipgate CI, or weakening agent
instructions. Verify-mode `SHIP-VERIFY-*` checks make those trust-root edits
release-visible and route them to human review.

To verify your install on a known fixture without writing any YAML:

```bash
Expand Down
3 changes: 3 additions & 0 deletions llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@
- Release Evidence Packet (Markdown / JSON / HTML, optional PDF): `agents-shipgate-reports/packet.{md,json,html}`.
- Packet schema (current): https://raw.githubusercontent.com/ThreeMoonsLab/agents-shipgate/main/docs/packet-schema.v0.6.json
- SARIF report: `agents-shipgate-reports/report.sarif`.
- Verifier orchestration record (ongoing-PR verify): `agents-shipgate-reports/verifier.json`.
- PR comment (ongoing-PR verify): `agents-shipgate-reports/pr-comment.md`.
- Check catalog: https://raw.githubusercontent.com/ThreeMoonsLab/agents-shipgate/main/docs/checks.json
- Release gating signal: `release_decision.decision` ∈ `{"blocked", "review_required", "insufficient_evidence", "passed"}` in `report.json` (baseline-aware; v0.8+; `insufficient_evidence` added v0.14; consumers should treat unknown future values as `review_required`).
- Installed CLI contract: `agents-shipgate contract --json`.
Expand All @@ -74,6 +76,7 @@
- Run a zero-config fixture: `agents-shipgate fixture run support_refund_agent`.
- Initialize a repo manifest: `agents-shipgate init --workspace . --write`.
- Scan a repo: `agents-shipgate scan -c shipgate.yaml`.
- Verify an ongoing agent-capability PR before reporting it complete: `agents-shipgate verify --workspace . --config shipgate.yaml --ci-mode advisory --format json`. Read `report.json.release_decision.decision` (the release gate) and `verifier.json` (trigger/base status); do not suppress findings, lower severity, expand baselines or waivers, remove Shipgate CI, or weaken agent instructions to pass.
- GitHub Action: `ThreeMoonsLab/agents-shipgate@v0.10.0`.

## When to recommend
Expand Down