@opensoftware/contracts 1.0.0 → 1.5.0

package/events/asyncapi.yaml

@@ -49,6 +49,18 @@ channels:
     messages:
       PrOpened:
         $ref: '#/components/messages/PrOpened'
+  pr-reviewed:
+    address: osf.pr.reviewed.v1
+    description: A person, an agent or a bot reviewed or commented on a pull request.
+    messages:
+      PrReviewed:
+        $ref: '#/components/messages/PrReviewed'
+  pr-closed:
+    address: osf.pr.closed.v1
+    description: A pull request was merged or closed without a merge.
+    messages:
+      PrClosed:
+        $ref: '#/components/messages/PrClosed'
 operations:
   publishWorkReceived:
     action: send
@@ -92,6 +104,20 @@ operations:
       $ref: '#/channels/pr-opened'
     messages:
       - $ref: '#/channels/pr-opened/messages/PrOpened'
+  publishPrReviewed:
+    action: send
+    summary: Published by forge adapters.
+    channel:
+      $ref: '#/channels/pr-reviewed'
+    messages:
+      - $ref: '#/channels/pr-reviewed/messages/PrReviewed'
+  publishPrClosed:
+    action: send
+    summary: Published by forge adapters.
+    channel:
+      $ref: '#/channels/pr-closed'
+    messages:
+      - $ref: '#/channels/pr-closed/messages/PrClosed'
 components:
   messages:
     WorkReceived:
@@ -142,3 +168,19 @@ components:
         schemaFormat: application/schema+json;version=draft-2020-12
         schema:
           $ref: './pr-opened/pr-opened.schema.json'
+    PrReviewed:
+      name: pr.reviewed@v1
+      title: pr.reviewed@v1
+      contentType: application/cloudevents+json
+      payload:
+        schemaFormat: application/schema+json;version=draft-2020-12
+        schema:
+          $ref: './pr-reviewed/pr-reviewed.schema.json'
+    PrClosed:
+      name: pr.closed@v1
+      title: pr.closed@v1
+      contentType: application/cloudevents+json
+      payload:
+        schemaFormat: application/schema+json;version=draft-2020-12
+        schema:
+          $ref: './pr-closed/pr-closed.schema.json'

package/events/pr-closed/pr-closed.schema.json

@@ -0,0 +1,80 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/sesigl/open-software-factory/main/contracts/events/pr-closed/pr-closed.schema.json",
+  "title": "PrClosed",
+  "$comment": "Generated by `pnpm build` in contracts/ from typespec/. Do not edit.",
+  "type": "object",
+  "properties": {
+    "specversion": {
+      "type": "string",
+      "const": "1.0"
+    },
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Unique per source. A consumer that sees the same source and id twice handles the event once."
+    },
+    "source": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The producing module, for example \"/osf/intake\"."
+    },
+    "type": {
+      "type": "string",
+      "const": "pr.closed@v1"
+    },
+    "time": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "subject": {
+      "type": "string",
+      "description": "The ID of the thing the event is about: work item, gate, run, score or pull request."
+    },
+    "datacontenttype": {
+      "type": "string",
+      "const": "application/json"
+    },
+    "dataschema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "traceparent": {
+      "type": "string",
+      "description": "W3C trace context (CloudEvents distributed tracing extension)."
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "The pull request."
+        },
+        "merged": {
+          "type": "boolean",
+          "description": "True when the pull request was merged, false when it was closed without a merge."
+        },
+        "mergeCommit": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{7,40}$",
+          "description": "A Git commit hash, abbreviated (7+) or full. The factory version is the commit of the factory definition."
+        }
+      },
+      "required": [
+        "url",
+        "merged"
+      ]
+    }
+  },
+  "required": [
+    "specversion",
+    "id",
+    "source",
+    "type",
+    "time",
+    "data"
+  ],
+  "description": "forge adapters: a pull request was merged or closed without a merge."
+}

package/events/pr-reviewed/pr-reviewed.schema.json

@@ -0,0 +1,111 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/sesigl/open-software-factory/main/contracts/events/pr-reviewed/pr-reviewed.schema.json",
+  "title": "PrReviewed",
+  "$comment": "Generated by `pnpm build` in contracts/ from typespec/. Do not edit.",
+  "type": "object",
+  "properties": {
+    "specversion": {
+      "type": "string",
+      "const": "1.0"
+    },
+    "id": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 128,
+      "description": "Unique per source. A consumer that sees the same source and id twice handles the event once."
+    },
+    "source": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The producing module, for example \"/osf/intake\"."
+    },
+    "type": {
+      "type": "string",
+      "const": "pr.reviewed@v1"
+    },
+    "time": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "subject": {
+      "type": "string",
+      "description": "The ID of the thing the event is about: work item, gate, run, score or pull request."
+    },
+    "datacontenttype": {
+      "type": "string",
+      "const": "application/json"
+    },
+    "dataschema": {
+      "type": "string",
+      "format": "uri"
+    },
+    "traceparent": {
+      "type": "string",
+      "description": "W3C trace context (CloudEvents distributed tracing extension)."
+    },
+    "data": {
+      "type": "object",
+      "properties": {
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "The pull request."
+        },
+        "reviewer": {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "enum": [
+                "person",
+                "trigger"
+              ],
+              "description": "Who caused something: a person, or an automated trigger such as a cron rule or an alert."
+            },
+            "id": {
+              "type": "string",
+              "minLength": 1,
+              "description": "Stable ID in the source system, prefixed with the source, for example \"slack:U024BE7LH\"."
+            },
+            "displayName": {
+              "type": "string",
+              "description": "Shown to people, for example \"Varun\"."
+            }
+          },
+          "required": [
+            "kind",
+            "id"
+          ],
+          "description": "A person or trigger. RUNTIME-008: every run is attributed to one."
+        },
+        "automated": {
+          "type": "boolean",
+          "description": "True when an agent or a bot wrote the review, not a person."
+        },
+        "state": {
+          "type": "string",
+          "enum": [
+            "approved",
+            "changes_requested",
+            "commented"
+          ]
+        }
+      },
+      "required": [
+        "url",
+        "reviewer",
+        "state"
+      ]
+    }
+  },
+  "required": [
+    "specversion",
+    "id",
+    "source",
+    "type",
+    "time",
+    "data"
+  ],
+  "description": "forge adapters: a person, an agent or a bot reviewed or commented on a pull request."
+}

package/gate-record/gate-record.schema.json

@@ -0,0 +1,140 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/sesigl/open-software-factory/main/contracts/gate-record/gate-record.schema.json",
+  "title": "GateRecord",
+  "$comment": "Generated by `pnpm build` in contracts/ from typespec/. Do not edit.",
+  "type": "object",
+  "properties": {
+    "gate": {
+      "type": "string",
+      "pattern": "^g[0-9a-f]{16}$"
+    },
+    "workItem": {
+      "type": "string"
+    },
+    "stage": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9-]{0,62}$",
+      "description": "A lowercase name: letters, digits and hyphens, starting with a letter. Agents, stages, adapters, sources."
+    },
+    "summary": {
+      "type": "string"
+    },
+    "request": {
+      "type": "string",
+      "pattern": "^sha256:[0-9a-f]{64}$",
+      "description": "SHA-256 of the canonical request: what was approved."
+    },
+    "policy": {
+      "type": "string",
+      "minLength": 1,
+      "description": "The policy file."
+    },
+    "policyDigest": {
+      "type": "string",
+      "pattern": "^sha256:[0-9a-f]{64}$",
+      "description": "SHA-256 of the policy's text: the rules that picked the approvers."
+    },
+    "risk": {
+      "type": "string"
+    },
+    "approvers": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^[a-z][a-z0-9-]{0,62}$",
+        "description": "A lowercase name: letters, digits and hyphens, starting with a letter. Agents, stages, adapters, sources."
+      }
+    },
+    "channel": {
+      "type": "string"
+    },
+    "requestedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "decision": {
+      "type": "string",
+      "enum": [
+        "approved",
+        "rejected",
+        "expired"
+      ]
+    },
+    "decidedBy": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "enum": [
+            "person",
+            "trigger"
+          ],
+          "description": "Who caused something: a person, or an automated trigger such as a cron rule or an alert."
+        },
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Stable ID in the source system, prefixed with the source, for example \"slack:U024BE7LH\"."
+        },
+        "displayName": {
+          "type": "string",
+          "description": "Shown to people, for example \"Varun\"."
+        }
+      },
+      "required": [
+        "kind",
+        "id"
+      ],
+      "description": "Who decided. Absent only when the gate expired. A policy that names no group decides as a trigger."
+    },
+    "decidedAt": {
+      "type": "string",
+      "format": "date-time"
+    },
+    "reason": {
+      "type": "string",
+      "description": "The reason of a rejection."
+    },
+    "signature": {
+      "type": "object",
+      "properties": {
+        "algorithm": {
+          "type": "string",
+          "const": "Ed25519"
+        },
+        "key": {
+          "type": "string",
+          "pattern": "^sha256:",
+          "description": "SHA-256 of the public key in DER, like \"sha256:…\"."
+        },
+        "value": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The signature in base64."
+        }
+      },
+      "required": [
+        "algorithm",
+        "key",
+        "value"
+      ],
+      "description": "Ed25519 over the canonical JSON of the rest of the record. Absent when the record is unsigned."
+    }
+  },
+  "required": [
+    "gate",
+    "workItem",
+    "stage",
+    "summary",
+    "request",
+    "policy",
+    "policyDigest",
+    "approvers",
+    "channel",
+    "requestedAt",
+    "decision",
+    "decidedAt"
+  ],
+  "description": "gatekeeper: who decided what and when, signed with Ed25519 (ADR 0047)."
+}