Introduce links to CDEvents

This commits introduces the concept of linking events to CDEvents. We take inspiration from Eiffel for certain components, and also outline new APIs and use cases. Signed-off-by: benjamin-j-powell <bjp@apple.com> Cleanup the custom spellcheck dictionary Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com> Fix linting issues Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com> Fix references to link schemas Make the references start with a / and include the whole path relative to the main schema base URL. See https://json-schema.org/understanding-json-schema/structuring#dollarref Schemas from the PR may not be published yet, so adapt the CI job to look for local files instead. Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com> Fix wrong event versions Artifact packaged and artifact published had the wrong event versions. Return to v0.2.0-draft (which was already bumped in this release. Examples already match. Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
cdevents · Mar 6, 2024 · 271e7db · 271e7db
1 parent 699dfa2
commit 271e7db
Show file tree

Hide file tree

Showing 93 changed files with 1,393 additions and 91 deletions.
diff --git a/.spellcheck-en-custom.txt b/.spellcheck-en-custom.txt
@@ -1,15 +1,9 @@
-Auth
-BD
 CDF
 CVE
 Gerrit
 Github
 Gitlab
 JSON
-KH
-KyjITcZXHotdMB
-MEYCIQCBT
-NGua
 NIST
 Notational
 README
@@ -19,85 +13,56 @@ SCM
 SIG
 SRE
 Tekton
-TestRepo
 URI
 UUID
-XiQlc
 american
 br
 cardpane
 cdevent
 cdevents
 ce
-charset
 cloudevents
 contenttype
 customdata
 customdatacontenttype
 datacontenttype
 dataschema
 deterministically
-dev
 emmitted
 english
-enum
 eventdata
 fas
-fc
-geo
 href
 http
-iaas
 img
 interoperable
-jenkins
 json
 lifecycle
 markdownlint
 md
-modelled
-myapp
-mybot
-mydata
-myvalue
-namespace
-namespaceB
-nnnn
 notational
 observability
 param
-pdf
 pipelinerun
 png
 pre
-quicktime
-rfc
 rolledback
 runtime
 sbom
-somewherelse
+schemaUri
 specversion
 src
 subjectid
 taskrun
-tekton
-testEnv
 testcase
 testcaserun
-testkube
 testoutput
-testrunreport
 testsuite
 testsuiterun
 ticketURI
 toc
 typesystem
 uri
 url
-utf
 viewUrl
 wpaper
-xml
-ypDXWCjlNKfzTV
-yshmiPmp
-znnSMNkQIhAJ
diff --git a/.spellcheck.yml b/.spellcheck.yml
@@ -1,15 +1,4 @@
 matrix:
-- name: json
-  aspell:
-    lang: en
-    d: en_US
-    camel-case: true
-    mode: url
-  sources:
-  - "**/*.json|!.github"
-  dictionary:
-    wordlists:
-    - .spellcheck-en-custom.txt
 - name: markdown
   aspell:
     lang: en
@@ -30,8 +19,8 @@ matrix:
       # ```
       # content
       # ```
-      - open: '(?s)^(?P<open> *`{3,})$'
+      - open: '(?s)^(?P<open> *`{3,}.+)$'
         close: '^(?P=open)$'
       # Ignore text between inline back ticks
       - open: '(?P<open>`+)'
-        close: '(?P=open)'
+        close: '(?P=open)'
diff --git a/examples/artifact_packaged.json b/examples/artifact_packaged.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.artifact.packaged.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/artifact_published.json b/examples/artifact_published.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.artifact.published.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/artifact_signed.json b/examples/artifact_signed.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.artifact.signed.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/branch_created.json b/examples/branch_created.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.branch.created.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",
@@ -18,4 +19,4 @@
       }
     }
   }
-}
+}
diff --git a/examples/branch_deleted.json b/examples/branch_deleted.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.branch.deleted.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",
@@ -18,4 +19,4 @@
       }
     }
   }
-}
+}
diff --git a/examples/build_finished.json b/examples/build_finished.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.build.finished.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/build_queued.json b/examples/build_queued.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.build.queued.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/build_started.json b/examples/build_started.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.build.started.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/change_abandoned.json b/examples/change_abandoned.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.change.abandoned.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",
@@ -18,4 +19,4 @@
       }
     }
   }
-}
+}
diff --git a/examples/change_created.json b/examples/change_created.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.change.created.0.3.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/change_merged.json b/examples/change_merged.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.change.merged.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",
@@ -18,4 +19,4 @@
       }
     }
   }
-}
+}
diff --git a/examples/change_reviewed.json b/examples/change_reviewed.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.change.reviewed.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",
@@ -18,4 +19,4 @@
       }
     }
   }
-}
+}
diff --git a/examples/change_updated.json b/examples/change_updated.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.change.updated.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",
@@ -18,4 +19,4 @@
       }
     }
   }
-}
+}
diff --git a/examples/environment_created.json b/examples/environment_created.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.environment.created.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/environment_deleted.json b/examples/environment_deleted.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.environment.deleted.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/environment_modified.json b/examples/environment_modified.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.environment.modified.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/incident_detected.json b/examples/incident_detected.json
@@ -2,6 +2,7 @@
   "context": {
       "version": "0.4.0-draft",
       "id": "F4BD2B55-B6F6-4F44-AF72-BD2D0E7A8708",
+      "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
       "source": "/monitoring/prod1",
       "type": "dev.cdevents.incident.detected.0.2.0-draft",
       "timestamp": "2022-11-11T13:52:20.079Z"

diff --git a/examples/incident_reported.json b/examples/incident_reported.json
@@ -2,6 +2,7 @@
   "context": {
       "version": "0.4.0-draft",
       "id": "F4BD2B55-B6F6-4F44-AF72-BD2D0E7A8708",
+      "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
       "source": "/monitoring/prod1",
       "type": "dev.cdevents.incident.reported.0.2.0-draft",
       "timestamp": "2022-11-11T13:52:20.079Z"

diff --git a/examples/incident_resolved.json b/examples/incident_resolved.json
@@ -2,6 +2,7 @@
   "context": {
       "version": "0.4.0-draft",
       "id": "F4BD2B55-B6F6-4F44-AF72-BD2D0E7A8708",
+      "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
       "source": "/monitoring/prod1",
       "type": "dev.cdevents.incident.resolved.0.2.0-draft",
       "timestamp": "2022-11-11T13:52:20.079Z"

diff --git a/examples/pipelinerun_finished.json b/examples/pipelinerun_finished.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.pipelinerun.finished.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/pipelinerun_queued.json b/examples/pipelinerun_queued.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.pipelinerun.queued.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/pipelinerun_started.json b/examples/pipelinerun_started.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.pipelinerun.started.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/repository_created.json b/examples/repository_created.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.repository.created.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/repository_deleted.json b/examples/repository_deleted.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.repository.deleted.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/repository_modified.json b/examples/repository_modified.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.repository.modified.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/service_deployed.json b/examples/service_deployed.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.service.deployed.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/service_published.json b/examples/service_published.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.service.published.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",

diff --git a/examples/service_removed.json b/examples/service_removed.json
@@ -2,6 +2,7 @@
   "context": {
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "chain_id": "4c8cb7dd-3448-41de-8768-eec704e2829b",
     "source": "/event/source/123",
     "type": "dev.cdevents.service.removed.0.2.0-draft",
     "timestamp": "2023-03-20T14:27:05.315384Z",