@opensoftware/contracts 0.0.0-stage → 1.4.0

package/events/gate-requested/gate-requested.schema.json

@@ -0,0 +1,135 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/sesigl/open-software-factory/main/contracts/events/gate-requested/gate-requested.schema.json",
+  "title": "GateRequested",
+  "$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": "gate.requested@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": {
+        "gateId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+        },
+        "workItemId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+        },
+        "runId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+        },
+        "stage": {
+          "type": "string",
+          "pattern": "^[a-z][a-z0-9-]{0,62}$",
+          "description": "The stage that waits."
+        },
+        "policy": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Path to the policy in the factory definition."
+        },
+        "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."
+          },
+          "minItems": 1,
+          "description": "Approver groups picked by the policy."
+        },
+        "summary": {
+          "type": "string",
+          "minLength": 1,
+          "description": "What the approver is asked to decide, shown in the channel."
+        },
+        "links": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "url": {
+                "type": "string",
+                "format": "uri"
+              },
+              "title": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "url"
+            ]
+          }
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time"
+        }
+      },
+      "required": [
+        "gateId",
+        "workItemId",
+        "stage",
+        "policy",
+        "approvers",
+        "summary"
+      ]
+    }
+  },
+  "required": [
+    "specversion",
+    "id",
+    "source",
+    "type",
+    "time",
+    "data"
+  ],
+  "description": "gatekeeper: a decision is needed before a stage starts."
+}

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-opened/pr-opened.schema.json

@@ -0,0 +1,138 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/sesigl/open-software-factory/main/contracts/events/pr-opened/pr-opened.schema.json",
+  "title": "PrOpened",
+  "$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.opened@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"
+        },
+        "repository": {
+          "type": "string",
+          "format": "uri"
+        },
+        "number": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "title": {
+          "type": "string",
+          "minLength": 1
+        },
+        "headBranch": {
+          "type": "string"
+        },
+        "baseBranch": {
+          "type": "string"
+        },
+        "headCommit": {
+          "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."
+        },
+        "author": {
+          "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."
+        },
+        "workItemId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+        },
+        "runId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+        }
+      },
+      "required": [
+        "url",
+        "repository",
+        "number",
+        "title",
+        "headBranch",
+        "baseBranch",
+        "headCommit",
+        "author"
+      ]
+    }
+  },
+  "required": [
+    "specversion",
+    "id",
+    "source",
+    "type",
+    "time",
+    "data"
+  ],
+  "description": "forge adapters: the factory opened a pull request."
+}

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/events/run-completed/run-completed.schema.json

@@ -0,0 +1,163 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://raw.githubusercontent.com/sesigl/open-software-factory/main/contracts/events/run-completed/run-completed.schema.json",
+  "title": "RunCompleted",
+  "$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": "run.completed@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": {
+        "runId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+        },
+        "workItemId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128,
+          "description": "An identifier chosen by the producer. ULIDs are recommended; consumers treat it as opaque."
+        },
+        "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."
+        },
+        "factoryVersion": {
+          "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."
+        },
+        "outcome": {
+          "type": "string",
+          "enum": [
+            "succeeded",
+            "failed",
+            "cancelled"
+          ],
+          "description": "How a run ended."
+        },
+        "startedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "endedAt": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "requester": {
+          "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."
+        },
+        "source": {
+          "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."
+        },
+        "costUsd": {
+          "type": "number",
+          "minimum": 0
+        },
+        "traceId": {
+          "type": "string",
+          "pattern": "^[0-9a-f]{32}$",
+          "description": "An OpenTelemetry trace ID: 32 lowercase hex characters."
+        },
+        "pullRequests": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "format": "uri"
+          }
+        },
+        "evidenceBundle": {
+          "type": "string",
+          "format": "uri"
+        }
+      },
+      "required": [
+        "runId",
+        "workItemId",
+        "factoryVersion",
+        "outcome",
+        "startedAt",
+        "endedAt",
+        "requester",
+        "source"
+      ]
+    }
+  },
+  "required": [
+    "specversion",
+    "id",
+    "source",
+    "type",
+    "time",
+    "data"
+  ],
+  "description": "foreman: a run ended."
+}