postman-cs/Postman Onboarding: TDD Preview

Generate a PR-scoped Postman TDD contract collection from a PR OpenAPI spec and run it against the PR implementation. On failure, publishes a check-run with per-packet annotations, a JUnit XML report (.postman-tdd/junit.xml), and a machine-consumable AgentFailureDocument. Opt-in agent dispatch templates live under .postman-template/workflows/agents/. Repair pushes use the postman-tdd-fix-<pr-number> branch convention.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
modeAction mode. Use validate for setup checks, run for PR preview, cleanup for PR close cleanup, or repair for automated implementation repair. In validate mode, an optional agent harness lint runs when opted in via tdd.harness.enabled or a root AGENTS.md file; harness lint errors are imperative 'To fix:' remediation instructions surfaced in validation-summary.norun
onboarding-config-pathPath to .postman-template/onboarding.yml.no.postman-template/onboarding.yml
project-nameOptional service project name override. Defaults to service.name from onboarding config.no
spec-pathOptional OpenAPI spec path override. Defaults to spec.path from onboarding config.no
pr-numberOptional PR number override. Defaults to the pull_request event number.no
postman-api-keyPostman API key used for workspace, spec, and collection operations. Required unless mode=validate.no
postman-access-tokenPostman access token. Required by mode=repair when the resolved repair provider is postman-agent-mode; optional otherwise.no
openai-api-keyOpenAI API key used by mode=repair when the resolved repair provider is openai-responses.no
anthropic-api-keyAnthropic API key used by mode=repair when the resolved repair provider is anthropic-messages.no
github-tokenGitHub token used for PR comments and config writeback. Required unless mode=validate.no
repair-github-tokenOptional token used by mode=repair for pushing repair commits. Prefer a PAT or GitHub App token so pushed commits trigger follow-up workflows.no
repair-providerOptional repair provider guard for mode=repair. When omitted, tdd.repair.provider from onboarding config is used. If set, it must be one of openai-responses, anthropic-messages, or postman-agent-mode and must match onboarding config.no
repair-modelModel used by mode=repair. Defaults to gpt-5.5 for openai-responses, claude-sonnet-5 for anthropic-messages, and GPT_5 for postman-agent-mode.no
repair-max-attemptsMaximum accepted implementation patch attempts in mode=repair.no3
repair-max-tool-roundsPer-attempt provider tool-round budget in mode=repair. Integer between 1 and 50.no12
repair-breaker-thresholdConsecutive identical failure fingerprint count that triggers a repeated_failure circuit breaker in mode=repair. Integer >= 2.no2
repair-escalation-modelOptional stronger model for the escalation rung in mode=repair. Same provider, one extra attempt after budget exhaustion. Defaults to tdd.repair.escalationModel from onboarding config when unset.no
repair-commit-messageCommit message used when mode=repair pushes a passing implementation change.noPostman TDD repair
immutable-state-signing-keyOptional HMAC signing key for immutable spec baselines. When set, previous sticky comment baselines must have a valid signature.no
workspace-team-idNumeric Postman sub-team ID for org-mode workspace creation.no
config-write-modeHow workspace ID bootstrap should write back onboarding config. One of commit-and-push, commit-only, none.nocommit-and-push
committer-nameGit committer name for workspace ID writeback commits.noPostman
committer-emailGit committer email for workspace ID writeback commits.nosupport@postman.com
postman-regionPostman data residency region. One of us or eu.nous
postman-stackPostman stack profile. Leave prod unless Postman support directs otherwise.noprod
namedescription
statuspassed, failed, skipped, or cleaned-up.
failure-phasenone, config, workspace, asset_upsert, immutable_state_tampered, immutable_spec, service_startup, health_check, collection_run, test_ratchet, or cleanup. Add the `postman-tdd-allow-ratchet-removal` label to a PR to intentionally remove/weaken a previously-passing contract packet without a `test_ratchet` block.
workspace-idShared TDD preview workspace ID.
spec-idPR-scoped TDD Spec Hub ID.
tdd-collection-idPR-scoped TDD contract collection ID.
agent-context-dirAgent context directory path.
agent-task-pathAgent task markdown path.
failures-json-pathAgent failure JSON path.
ledger-pathPath to the local verification ledger JSON (.postman-tdd/ledger.json).
junit-pathPath to the local JUnit XML report of the contract run (.postman-tdd/junit.xml).
agent-context-artifactWorkflow artifact containing agent-task.md, failures.json, and immutable-spec-guard.mjs.
agent-context-artifact-idGitHub Actions artifact ID for the agent context, when uploaded.
agent-context-artifact-digestSHA-256 digest for the uploaded agent context artifact, when available.
config-commit-shaCommit SHA produced by workspace ID config writeback, if any.
pr-comment-idGitHub PR comment ID for the sticky TDD preview comment.
repair-statusrepaired, blocked, skipped, or failed.
repair-blocked-reasonMachine-readable reason when repair-status is blocked. Includes budget_exhausted, repeated_failure, owner_action_required, agent_blocked, agent_no_change, stale_failure, fork_pr, and others.
repair-escalatedWhether the escalation model rung was attempted (true or false).
repair-attemptsNumber of accepted implementation patch attempts.
repair-commit-shaCommit SHA pushed by the repair worker after a green local collection run.
repair-summary-pathPath to the local repair summary JSON.
validation-error-countNumber of setup validation errors found by mode=validate.
validation-warning-countNumber of setup validation warnings found by mode=validate.
validation-summaryMultiline setup validation summary from mode=validate.