Merge branch 'main' into add.test.skip

.github/pull_request_template.md

@@ -8,7 +8,7 @@
 
 As the author of this PR, please check off the items in this checklist:
 
-- [ ] Has the [primer doc](https://github.com/cdevents/spec/blob/main/primer/_index.md) been updated if a design decision is involved
-- [ ] Have the [JSON schemas](https://github.com/tektoncd/community/blob/main/standards.md#tests) been updated if the specification changed
-- [ ] Has spec version and event versions been updated according to the [versioning policy](https://github.com/cdevents/spec/blob/main/primer/_index.md#versioning)
-- [ ] Meets the [CDEvents contributor standards](https://github.com/cdevents/.github/blob/main/docs/CONTRIBUTING.md)
+- [ ] Has the [primer doc](https://github.com/cdevents/cdevents.dev/blob/main/content/en/docs/primer/_index.md) been updated if a design decision is involved
+- [ ] Have the [JSON schemas](https://github.com/cdevents/spec/tree/main/schemas) been updated if the specification changed
+- [ ] Has spec version and event versions been updated according to the [versioning policy](https://cdevents.dev/docs/primer/#versioning)
+- [ ] Meets the [CDEvents contributor standards](https://github.com/cdevents/.github/blob/main/docs/CONTRIBUTING.md)

continuous-deployment.md

@@ -47,7 +47,7 @@ A `service` can represent for example a binary that is running, a daemon, an app
 
 ## Events
 
-### `environment created`
+### [`environment created`](examples/environment_created.json)
 
 This event represents an environment that has been created. Such an environment can be used to deploy services in.
 
@@ -63,7 +63,7 @@ This event represents an environment that has been created. Such an environment
 | name | `String` | Name of the environment | `dev`, `staging`, `production`, `ci-123`| |
 | url | `String` | URL to reference where the environment is located | `https://my-cluster.zone.my-cloud-provider`| |
 
-### `environment modified`
+### [`environment modified`](examples/environment_modified.json)
 
 This event represents an environment that has been modified.
 
@@ -79,7 +79,7 @@ This event represents an environment that has been modified.
 | name | `String` | Name of the environment | `dev`, `staging`, `production`, `ci-123`| |
 | url | `String` | URL to reference where the environment is located | `https://my-cluster.zone.my-cloud-provider`| |
 
-### `environment deleted`
+### [`environment deleted`](examples/environment_deleted.json)
 
 This event represents an environment that has been deleted.```
 
@@ -94,7 +94,7 @@ This event represents an environment that has been deleted.```
 | type | `String` | See [type](spec.md#type-subject) | `environment` | |
 | name | `String` | Name of the environment | `dev`, `staging`, `production`, `ci-123`| |
 
-### `service deployed`
+### [`service deployed`](examples/service_deployed.json)
 
 This event represents a new instance of a service that has been deployed
 
@@ -110,7 +110,7 @@ This event represents a new instance of a service that has been deployed
 | environment | `Object` ([`environment`](#environment)) | Reference for the environment where the service runs | `{"id": "1234"}`, `{"id": "maven123, "source": "tekton-dev-123"}` | ✅ |
 | artifactId | `Purl` | Identifier of the artifact deployed with this service |  `0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `927aa808433d17e315a258b98e2f1a55f8258e0cb782ccb76280646d0dbe17b5`, `six-1.14.0-py2.py3-none-any.whl` | ✅ |
 
-### `service upgraded`
+### [`service upgraded`](examples/service_upgraded.json)
 
 This event represents an existing instance of a service that has been upgraded to a new version
 
@@ -126,7 +126,7 @@ This event represents an existing instance of a service that has been upgraded t
 | environment | `Object` ([`environment`](#environment)) | Reference for the environment where the service runs | `{"id": "1234"}`, `{"id": "maven123, "source": "tekton-dev-123"}` | ✅ |
 | artifactId | `Purl` | Identifier of the artifact deployed with this service |`pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` | ✅ |
 
-### `service rolledback`
+### [`service rolledback`](examples/service_rolledback.json)
 
 This event represents an existing instance of a service that has been rolled back to a previous version
 
@@ -142,7 +142,7 @@ This event represents an existing instance of a service that has been rolled bac
 | environment | `Object` ([`environment`](#environment)) | Reference for the environment where the service runs | `{"id": "1234"}`, `{"id": "maven123, "source": "tekton-dev-123"}` | ✅ |
 | artifactId | `Purl` | Identifier of the artifact deployed with this service |  `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` | ✅ |
 
-### `service removed`
+### [`service removed`](examples/service_removed.json)
 
 This event represents the removal of a previously deployed service instance and is thus not longer present in the specified environment
 
@@ -157,7 +157,7 @@ This event represents the removal of a previously deployed service instance and
 | type | `String` | See [type](spec.md#type-subject) | `service` | |
 | environment | `Object` ([`environment`](#environment)) | Reference for the environment where the service runs | `{"id": "1234"}`, `{"id": "maven123, "source": "tekton-dev-123"}` | ✅ |
 
-### `service published`
+### [`service published`](examples/service_published.json)
 
 This event represents an existing instance of a service that has an accessible URL for users to interact with it. This event can be used to let other tools know that the service is ready and also available for consumption.
 

continuous-integration.md

@@ -50,7 +50,7 @@ An `artifact` is usually produced as output of a build process. Events need to b
 
 ## Events
 
-### `build queued`
+### [`build queued`](examples/build_queued.json)
 
 This event represents a Build task that has been queued; this build process usually is in charge of producing a binary from source code.
 
@@ -64,7 +64,7 @@ This event represents a Build task that has been queued; this build process usua
 | source | `URI-Reference` | See [source](spec.md#source-subject) | | |
 | type | `String` | See [type](spec.md#type-subject) | `build` | |
 
-### `build started`
+### [`build started`](examples/build_started.json)
 
 This event represents a Build task that has been started; this build process usually is in charge of producing a binary from source code.
 
@@ -78,7 +78,7 @@ This event represents a Build task that has been started; this build process usu
 | source | `URI-Reference` | See [source](spec.md#source-subject) | | |
 | type | `String` | See [type](spec.md#type-subject) | `build` | |
 
-### `build finished`
+### [`build finished`](examples/build_finished.json)
 
 This event represents a Build task that has finished. This event will eventually contain the finished status, success, error or failure
 
@@ -93,7 +93,7 @@ This event represents a Build task that has finished. This event will eventually
 | type | `String` | See [type](spec.md#type-subject) | |
 | artifactId | `Purl` | Identifier of the artifact produced by the build | `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` | `build` | |
 
-### `artifact packaged`
+### [`artifact packaged`](examples/artifact_packaged.json)
 
 The event represents an artifact that has been packaged for distribution; this artifact is now versioned with a fixed version.
 
@@ -108,7 +108,7 @@ The event represents an artifact that has been packaged for distribution; this a
 | type | `String` | See [type](spec.md#type-subject) | `artifact` | |
 | change | `object`        | The change (tag, commit, revision) of the repository which was used to build the artifact" | `{"id": "527d4a1aca5e8d0df24813df5ad65d049fc8d312", "source": "my-git.example/an-org/a-repo"}`, `{"id": "feature1234", "source": "my-git.example/an-org/a-repo"}` | ✅ |
 
-### `artifact published`
+### [`artifact published`](examples/artifact_published.json)
 
 The event represents an artifact that has been published and it can be advertised for others to use.
 
@@ -122,7 +122,7 @@ The event represents an artifact that has been published and it can be advertise
 | source | `URI-Reference` | See [source](spec.md#source-subject) | | |
 | type | `String` | See [type](spec.md#type-subject) | `artifact` | |
 
-### `artifact signed`
+### [`artifact signed`](examples/artifact_signed.json)
 
 The event represents an artifact that has been signed. The signature is included in the events itself.
 An artifact may be signed after it has been packaged or sometimes after it has published, depending on the tooling being used and the type of artifact.

continuous-operations.md

@@ -36,7 +36,7 @@ An `incident` represents a problem in a production environment.
 
 ## Events
 
-### `incident detected`
+### [`incident detected`](examples/incident_detected.json)
 
 This event represents an incident that has been detected by a system or human.
 
@@ -54,7 +54,7 @@ This event represents an incident that has been detected by a system or human.
 | service | `Object` ([`service`](./continuous-deployment.md#service)) | Reference to the service | `{"id": "service123"}`, `{"id": "service123", "source": "region1/k8s/namespace"}` | |
 | artifactId | `Purl` | Identifier of the artifact deployed with this service |  `0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `927aa808433d17e315a258b98e2f1a55f8258e0cb782ccb76280646d0dbe17b5`, `six-1.14.0-py2.py3-none-any.whl` | |
 
-### `incident reported`
+### [`incident reported`](examples/incident_reported.json)
 
 This event represents an incident that has been reported through a ticketing system. Compared to the `detected` predicated, it introduces a ticket URI.
 
@@ -73,7 +73,7 @@ This event represents an incident that has been reported through a ticketing sys
 | service | `Object` ([`service`](./continuous-deployment.md#service)) | Reference to the service | `{"id": "service123"}`, `{"id": "service123", "source": "region1/k8s/namespace"}` | |
 | artifactId | `Purl` | Identifier of the artifact deployed with this service |  `0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `927aa808433d17e315a258b98e2f1a55f8258e0cb782ccb76280646d0dbe17b5`, `six-1.14.0-py2.py3-none-any.whl` | |
 
-### `incident resolved`
+### [`incident resolved`](examples/incident_resolved.json)
 
 This event represents an incident that has been resolved, meaning that the problem identified by the incident has been solved or recalled.
 
@@ -91,4 +91,4 @@ This event represents an incident that has been resolved, meaning that the probl
 | service | `Object` ([`service`](./continuous-deployment.md#service)) | Reference to the service | `{"id": "service123"}`, `{"id": "service123", "source": "region1/k8s/namespace"}` | |
 | artifactId | `Purl` | Identifier of the artifact deployed with this service |  `0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `927aa808433d17e315a258b98e2f1a55f8258e0cb782ccb76280646d0dbe17b5`, `six-1.14.0-py2.py3-none-any.whl` | |
 
-[incident]: https://csrc.nist.gov/glossary/term/incident
+[incident]: https://csrc.nist.gov/glossary/term/incident

core.md

@@ -36,7 +36,7 @@ track the build and release progress on a particular software artifact.
 | source | `URI-Reference` | See [source](spec.md#source-subject) | |
 | type | `String` | See [type](spec.md#type-subject) | `pipelineRun` |
 | pipelineName  | `String` | The name of the pipeline | `MyPipeline`, `Unit tests for my repo` |
-| outcome | `Enum` | outcome of a finished `pipelineRun` | `success`, `error` or `failure`|
+| outcome | `String` | outcome of a finished `pipelineRun` | `success`, `error` or `failure`|
 | url | `URI` | url to the `pipelineRun` | `https://dashboard.org/namespace/pipelinerun-1234`, `https://api.cdsystem.com/namespace/pipelinerun-1234` |
 | errors | `String` | In case of error or failed pipeline, provides details about the failure | `Invalid input param 123`, `Timeout during execution`, `pipelineRun cancelled by user`, `Unit tests failed`|
 
@@ -56,13 +56,13 @@ associated, in which case it is acceptable to generate only taskRun events.
 | type | `String` | See [type](spec.md#type-subject) | `taskRun` |
 | taskName  | `String` | The name of the pipeline | `MyPipeline`, `Unit tests for my repo` |
 | pipelineRun | `Object` ([`pipelineRun`](#pipelinerun)) | The `pipelineRun` that this `taskRun` belongs to. | `{"id": "namespace/pipelinerun-1234"}`|
-| outcome | `Enum` | outcome of a finished `taskRun` | `success`, `error` or `failure`|
+| outcome | `String` | outcome of a finished `taskRun` | `success`, `error` or `failure`|
 | url | `URI` | url to the `taskRun` | `https://dashboard.org/namespace/taskrun-1234`, `https://api.cdsystem.com/namespace/taskrun-1234` |
 | errors | `String` | In case of error or failed pipeline, provides details about the failure | `Invalid input param 123`, `Timeout during execution`, `taskRun cancelled by user`, `Unit tests failed`|
 
 ## Events
 
-### `pipelineRun queued`
+### [`pipelineRun queued`](examples/pipelinerun_queued.json)
 
 Due the dynamic nature of Pipelines, most of actual work needs to be queued to
 happen in a distributed way, hence queued events are added. Adopters can choose
@@ -80,7 +80,7 @@ to ignore these events if they don't apply to their use cases.
 | pipelineName  | `String` | The name of the pipeline | `MyPipeline`, `Unit tests for my repo` | |
 | url | `URI` | url to the `pipelineRun` | `https://dashboard.org/namespace/pipelinerun-1234`, `https://api.cdsystem.com/namespace/pipelinerun-1234` | |
 
-### `pipelineRun Started`
+### [`pipelineRun Started`](examples/pipelinerun_started.json)
 
 A pipelineRun has started and it is running.
 
@@ -96,7 +96,7 @@ A pipelineRun has started and it is running.
 | pipelineName  | `String` | The name of the pipeline | `MyPipeline`, `Unit tests for my repo` | |
 | url | `URI` | url to the `pipelineRun` | `https://dashboard.org/namespace/pipelinerun-1234`, `https://api.cdsystem.com/namespace/pipelinerun-1234` | |
 
-### `pipelineRun Finished`
+### [`pipelineRun Finished`](examples/pipelinerun_finished.json)
 
 A pipelineRun has finished, successfully or not.
 
@@ -111,10 +111,10 @@ A pipelineRun has finished, successfully or not.
 | type | `String` | See [type](spec.md#type-subject) | `pipelineRun` | |
 | pipelineName  | `String` | The name of the pipeline | `MyPipeline`, `Unit tests for my repo` | |
 | url | `URI` | url to the `pipelineRun` | `https://dashboard.org/namespace/pipelinerun-1234`, `https://api.cdsystem.com/namespace/pipelinerun-1234` | |
-| outcome | `Enum` | outcome of a finished `pipelineRun` | `success`, `error` or `failure`| |
+| outcome | `String (enum)` | outcome of a finished `pipelineRun` | `success`, `error` or `failure`| |
 | errors | `String` | In case of error or failed pipeline, provides details about the failure | `Invalid input param 123`, `Timeout during execution`, `pipelineRun cancelled by user`, `Unit tests failed`| |
 
-### `taskRun Started`
+### [`taskRun Started`](examples/taskrun_started.json)
 
 A taskRun has started and it is running.
 
@@ -131,7 +131,7 @@ A taskRun has started and it is running.
 | pipelineRun | `Object` ([`pipelineRun`](#pipelinerun)) | The `pipelineRun` that this `taskRun` belongs to. | `{"id": "namespace/pipelinerun-1234"}`| |
 | url | `URI` | url to the `taskRun` | `https://dashboard.org/namespace/taskrun-1234`, `https://api.cdsystem.com/namespace/taskrun-1234` | |
 
-### `taskRun Finished`
+### [`taskRun Finished`](examples/taskrun_finished.json)
 
 A taskRun has finished, successfully or not.
 
@@ -147,5 +147,5 @@ A taskRun has finished, successfully or not.
 | taskName  | `String` | The name of the pipeline | `MyPipeline`, `Unit tests for my repo` | |
 | pipelineRun | `Object` ([`pipelineRun`](#pipelinerun)) | The `pipelineRun` that this `taskRun` belongs to. | `{"id": "namespace/pipelinerun-1234"}`| |
 | url | `URI` | url to the `taskRun` | `https://dashboard.org/namespace/taskrun-1234`, `https://api.cdsystem.com/namespace/taskrun-1234` | |
-| outcome | `Enum` | outcome of a finished `taskRun` | `success`, `error` or `failure`| |
+| outcome | `String (enum)` | outcome of a finished `taskRun` | `success`, `error` or `failure`| |
 | errors | `String` | In case of error or failed pipeline, provides details about the failure | `Invalid input param 123`, `Timeout during execution`, `taskRun cancelled by user`, `Unit tests failed`| |

examples/change_created.json

@@ -3,18 +3,19 @@
     "version": "0.4.0-draft",
     "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
     "source": "/event/source/123",
-    "type": "dev.cdevents.change.created.0.1.2",
+    "type": "dev.cdevents.change.created.0.2.0",
     "timestamp": "2023-03-20T14:27:05.315384Z"
   },
   "subject": {
     "id": "mySubject123",
     "source": "/event/source/123",
     "type": "change",
     "content": {
+      "description": "This PR address a bug from a recent PR",
       "repository": {
         "id": "TestRepo/TestOrg",
         "source": "https://example.org"
       }
     }
   }
-}
+}

schemas/changecreated.json

@@ -20,9 +20,9 @@
         "type": {
           "type": "string",
           "enum": [
-            "dev.cdevents.change.created.0.1.2"
+            "dev.cdevents.change.created.0.2.0"
           ],
-          "default": "dev.cdevents.change.created.0.1.2"
+          "default": "dev.cdevents.change.created.0.2.0"
         },
         "timestamp": {
           "type": "string",
@@ -60,6 +60,10 @@
         },
         "content": {
           "properties": {
+            "description": {
+              "type": "string",
+              "minLength": 1
+            },
             "repository": {
               "properties": {
                 "id": {
@@ -112,4 +116,4 @@
     "context",
     "subject"
   ]
-}
+}