Evidence and release gates / JSON Schema

RapidKit Release Readiness Evidence

Defines the versioned release readiness v1 boundary used by Workspai and its consumers.

Schema version: release-readiness-v1 | v1
Contract path: contracts/release-readiness.v1.json
Publication: embedded-type
Defined fields: 15
Artifact bindings: 1

Why this contract exists

Architecture role

Carries structured evidence, findings, and verdicts across governance boundaries.

Consumption boundary

• Workspai CLI
• CI and release automation
• Developers

Related commands

Commands are linked only when the runtime contract identifies a direct production relationship. Supporting contracts may be consumed without having a single producer command.

workspai readiness

Produced artifacts

These durable files are emitted by registered commands and validated against this contract.

Artifact path	Schema	Producer
.workspai/reports/release-readiness-last-run.json	release-readiness-v1	workspai readiness --json

Field reference

Every declared schema property or published capability path is listed here. Required means the contract declares or publishes that field at the shown boundary.

Field path	Type	Required	Meaning	Constraints
action	enum	No	Defines the action value at this contract boundary.	enum: dev, test, build, start, lint, format
blocking	boolean	Yes	Defines the blocking value at this contract boundary.	—
blockingReasons	array	Yes	Defines the blockingreasons value at this contract boundary.	—
evidencePath	string	No	Defines the evidencepath value at this contract boundary.	—
gates	array	Yes	Defines the gates value at this contract boundary.	—
gates[].details	array	Yes	Defines the details value at this contract boundary.	—
gates[].evidencePath	string	No	Defines the evidencepath value at this contract boundary.	—
gates[].gate	enum	Yes	Defines the gate value at this contract boundary.	enum: env, doctor, analyze, verify, dependency
gates[].status	enum	Yes	Defines the status value at this contract boundary.	enum: pass, warn, fail
gates[].summary	string	Yes	Defines the summary value at this contract boundary.	—
generatedAt	string	Yes	Defines the generatedat value at this contract boundary.	format: date-time
overallStatus	enum	Yes	Defines the overallstatus value at this contract boundary.	enum: pass, warn, fail
projectPath	string	Yes	Defines the projectpath value at this contract boundary.	minLength: 1
schemaVersion	enum	Yes	Defines the schemaversion value at this contract boundary.	enum: release-readiness-v1, v1
workspacePath	string	Yes	Defines the workspacepath value at this contract boundary.	minLength: 1

Canonical machine-readable definition

The raw synchronized contract remains authoritative. The educational sections above are projections of this definition.

Show raw JSON

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://getrapidkit.com/schemas/release-readiness.v1.json",
  "title": "RapidKit Release Readiness Evidence",
  "type": "object",
  "required": [
    "schemaVersion",
    "generatedAt",
    "workspacePath",
    "projectPath",
    "overallStatus",
    "blocking",
    "blockingReasons",
    "gates"
  ],
  "properties": {
    "schemaVersion": {
      "enum": [
        "release-readiness-v1",
        "v1"
      ]
    },
    "generatedAt": {
      "type": "string",
      "format": "date-time"
    },
    "workspacePath": {
      "type": "string",
      "minLength": 1
    },
    "projectPath": {
      "type": "string",
      "minLength": 1
    },
    "action": {
      "enum": [
        "dev",
        "test",
        "build",
        "start",
        "lint",
        "format"
      ]
    },
    "overallStatus": {
      "enum": [
        "pass",
        "warn",
        "fail"
      ]
    },
    "blocking": {
      "type": "boolean"
    },
    "blockingReasons": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "gates": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "gate",
          "status",
          "summary",
          "details"
        ],
        "properties": {
          "gate": {
            "enum": [
              "env",
              "doctor",
              "analyze",
              "verify",
              "dependency"
            ]
          },
          "status": {
            "enum": [
              "pass",
              "warn",
              "fail"
            ]
          },
          "summary": {
            "type": "string"
          },
          "details": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "evidencePath": {
            "type": "string"
          }
        },
        "additionalProperties": true
      }
    },
    "evidencePath": {
      "type": "string"
    }
  },
  "additionalProperties": true
}