From bcc18e22e9ba53d190dbc6f94372d08f36b3413c Mon Sep 17 00:00:00 2001 From: Andrea Frittoli Date: Thu, 20 Oct 2022 14:21:48 +0100 Subject: [PATCH 1/5] Prepeare for release 0.1.0 Switch all versions from 0.1.0-draft to 0.1.0. Remove mentiones of draft / work-in-progress content. Update the README to mention 0.1.0 as latest release. Signed-off-by: Andrea Frittoli --- README.md | 11 +++---- cloudevents-binding.md | 2 +- continuous-integration-pipeline-events.md | 36 +++++++---------------- core.md | 10 +++---- primer.md | 6 ++-- schemas/artifactpackaged.json | 6 ++-- schemas/artifactpublished.json | 6 ++-- schemas/branchcreated.json | 6 ++-- schemas/branchdeleted.json | 6 ++-- schemas/buildfinished.json | 6 ++-- schemas/buildqueued.json | 6 ++-- schemas/buildstarted.json | 6 ++-- schemas/changeabandoned.json | 6 ++-- schemas/changecreated.json | 6 ++-- schemas/changemerged.json | 6 ++-- schemas/changereviewed.json | 6 ++-- schemas/changeupdated.json | 6 ++-- schemas/environmentcreated.json | 6 ++-- schemas/environmentdeleted.json | 6 ++-- schemas/environmentmodified.json | 6 ++-- schemas/pipelinerunfinished.json | 6 ++-- schemas/pipelinerunqueued.json | 6 ++-- schemas/pipelinerunstarted.json | 6 ++-- schemas/repositorycreated.json | 6 ++-- schemas/repositorydeleted.json | 6 ++-- schemas/repositorymodified.json | 6 ++-- schemas/servicedeployed.json | 10 +++---- schemas/servicepublished.json | 6 ++-- schemas/serviceremoved.json | 6 ++-- schemas/servicerolledback.json | 6 ++-- schemas/serviceupgraded.json | 6 ++-- schemas/taskrunfinished.json | 6 ++-- schemas/taskrunstarted.json | 6 ++-- schemas/testcasefinished.json | 6 ++-- schemas/testcasequeued.json | 6 ++-- schemas/testcasestarted.json | 6 ++-- schemas/testsuitefinished.json | 6 ++-- schemas/testsuitestarted.json | 6 ++-- source-code-version-control.md | 20 ++++++------- spec.md | 6 ++-- 40 files changed, 139 insertions(+), 154 deletions(-) diff --git a/README.md b/README.md index 9bc3571c..64bcac16 100644 --- a/README.md +++ b/README.md @@ -38,18 +38,19 @@ points for metrics. ## CDEvents Specification -The [CDEvents Specification](./spec.md) is available on our -[website](https://cdevents.dev/docs). +The latest release of the specification is +[v0.1](https://github.com/cdevents/spec/tree/0.1.0/spec.md). -The specification is currently draft and not ready for implementation. -We are working towards our -[first release v0.1](https://github.com/orgs/cdevents/projects/1). +You can also preview the ongoing work on the [CDEvents Specification](./spec.md) +on the `main` branch. ## CDEvents SDKs CDEvents is developing as set of SDKs: * [Go](https://github.com/cdevents/sdk-go) +* [Python](https://github.com/cdevents/sdk-python) +* [Java](https://github.com/cdevents/sdk-java) ## Community diff --git a/cloudevents-binding.md b/cloudevents-binding.md index c64b3298..4d0c46f8 100644 --- a/cloudevents-binding.md +++ b/cloudevents-binding.md @@ -104,7 +104,7 @@ Content-Length: nnnn { "context": { - "version" : "0.1.0-draft", + "version" : "0.1.0", "id" : "A234-1234-1234", "source" : "/staging/tekton/", "type" : "dev.cdevents.taskrun.started", diff --git a/continuous-integration-pipeline-events.md b/continuous-integration-pipeline-events.md index 50b7d9e4..8c693b66 100644 --- a/continuous-integration-pipeline-events.md +++ b/continuous-integration-pipeline-events.md @@ -73,7 +73,7 @@ An `artifact` is usually produced as output of a build process. Events need to b This event represents a Build task that has been queued; this build process usually is in charge of producing a binary from source code. -- Event Type: __`dev.cdevents.build.queued.0.1.0-draft`__ +- Event Type: __`dev.cdevents.build.queued.0.1.0`__ - Predicate: queued - Subject: [`build`](#build) @@ -82,13 +82,11 @@ This event represents a Build task that has been queued; this build process usua | id | `String` | Uniquely identifies the subject within the source. | `1234`, `maven123`, `builds/taskrun123` | ✅ | | source | `URI-Reference` | [source](../spec.md#source) from the context | | ⚪ | -🚧 The build model is work in progress. - ### `build started` This event represents a Build task that has been started; this build process usually is in charge of producing a binary from source code. -- Event Type: __`dev.cdevents.build.started.0.1.0-draft`__ +- Event Type: __`dev.cdevents.build.started.0.1.0`__ - Predicate: started - Subject: [`build`](#build) @@ -97,13 +95,11 @@ This event represents a Build task that has been started; this build process usu | id | `String` | Uniquely identifies the subject within the source. | `1234`, `maven123`, `builds/taskrun123` | ✅ | | source | `URI-Reference` | [source](../spec.md#source) from the context | | ⚪ | -🚧 The build model is work in progress. - ### `build finished` This event represents a Build task that has finished. This event will eventually contain the finished status, success, error or failure -- Event Type: __`dev.cdevents.build.finished.0.1.0-draft`__ +- Event Type: __`dev.cdevents.build.finished.0.1.0`__ - Predicate: finished - Subject: [`build`](#build) @@ -113,13 +109,11 @@ This event represents a Build task that has finished. This event will eventually | source | `URI-Reference` | [source](../spec.md#source) from the context | | ⚪ | | artifactId | `Purl` | Identifier of the artifact produced by the build | `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` | ⚪ | -🚧 The build model is work in progress. - ### `testCase queued` This event represents a Test task that has been queued, and it is waiting to be started. -- Event Type: __`dev.cdevents.testcase.queued.0.1.0-draft`__ +- Event Type: __`dev.cdevents.testcase.queued.0.1.0`__ - Predicate: queued - Subject: [`testCase`](#testcase) @@ -128,13 +122,11 @@ This event represents a Test task that has been queued, and it is waiting to be | id | `String` | Uniquely identifies the subject within the source. | `unitest-abc`, `e2e-test1`, `scan-image1` | ✅ | | source | `URI-Reference` | [source](../spec.md#source) from the context | | ⚪ | -🚧 The testCase model is work in progress. - ### `testCase started` This event represents a Test task that has started. -- Event Type: __`dev.cdevents.testcase.started.0.1.0-draft`__ +- Event Type: __`dev.cdevents.testcase.started.0.1.0`__ - Predicate: started - Subject: [`testCase`](#testcase) @@ -143,13 +135,11 @@ This event represents a Test task that has started. | id | `String` | Uniquely identifies the subject within the source. | `unitest-abc`, `e2e-test1`, `scan-image1` | ✅ | | source | `URI-Reference` | [source](../spec.md#source) from the context | | ⚪ | -🚧 The testCase model is work in progress. - ### `testCase finished` This event represents a Test task that has finished. This event will eventually contain the finished status: success, error or failure. -- Event Type: __`dev.cdevents.testcase.finished.0.1.0-draft`__ +- Event Type: __`dev.cdevents.testcase.finished.0.1.0`__ - Predicate: finished - Subject: [`testCase`](#testcase) @@ -158,13 +148,11 @@ This event represents a Test task that has finished. This event will eventually | id | `String` | Uniquely identifies the subject within the source. | `unitest-abc`, `e2e-test1`, `scan-image1` | ✅ | | source | `URI-Reference` | [source](../spec.md#source) from the context | | ⚪ | -🚧 The testCase model is work in progress. - ### `testSuite started` This event represents a Test suite that has been started. -- Event Type: __`dev.cdevents.testsuite.started.0.1.0-draft`__ +- Event Type: __`dev.cdevents.testsuite.started.0.1.0`__ - Predicate: started - Subject: [`testSuite`](#testsuite) @@ -173,13 +161,11 @@ This event represents a Test suite that has been started. | id | `String` | Uniquely identifies the subject within the source. | `unit`, `e2e`, `security` | ✅ | | source | `URI-Reference` | [source](../spec.md#source) from the context | | ⚪ | -🚧 The testSuite model is work in progress. - ### `testSuite finished` This event represents a Test suite that has has finished, the event will contain the finished status: success, error or failure. -- Event Type: __`dev.cdevents.testsuite.finished.0.1.0-draft`__ +- Event Type: __`dev.cdevents.testsuite.finished.0.1.0`__ - Predicate: finished - Subject: [`testSuite`](#testsuite) @@ -188,13 +174,11 @@ This event represents a Test suite that has has finished, the event will contain | id | `String` | Uniquely identifies the subject within the source. | `unit`, `e2e`, `security` | ✅ | | source | `URI-Reference` | [source](../spec.md#source) from the context | | ⚪ | -🚧 The testSuite model is work in progress. - ### `artifact packaged` The event represents an artifact that has been packaged for distribution; this artifact is now versioned with a fixed version. -- Event Type: __`dev.cdevents.artifact.packaged.0.1.0-draft`__ +- Event Type: __`dev.cdevents.artifact.packaged.0.1.0`__ - Predicate: packaged - Subject: [`artifact`](#artifact) @@ -207,7 +191,7 @@ The event represents an artifact that has been packaged for distribution; this a The event represents an artifact that has been published and it can be advertised for others to use. -- Event Type: __`dev.cdevents.artifact.published.0.1.0-draft`__ +- Event Type: __`dev.cdevents.artifact.published.0.1.0`__ - Predicate: published - Subject: [`artifact`](#artifact) diff --git a/core.md b/core.md index 646a31fe..e9384737 100644 --- a/core.md +++ b/core.md @@ -66,7 +66,7 @@ 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 to ignore these events if they don't apply to their use cases. -- Event Type: __`dev.cdevents.pipelinerun.queued.0.1.0-draft`__ +- Event Type: __`dev.cdevents.pipelinerun.queued.0.1.0`__ - Predicate: queued - Subject: [`pipelineRun`](#pipelinerun) @@ -81,7 +81,7 @@ to ignore these events if they don't apply to their use cases. A pipelineRun has started and it is running. -- Event Type: __`dev.cdevents.pipelinerun.started.0.1.0-draft`__ +- Event Type: __`dev.cdevents.pipelinerun.started.0.1.0`__ - Predicate: started - Subject: [`pipelineRun`](#pipelinerun) @@ -96,7 +96,7 @@ A pipelineRun has started and it is running. A pipelineRun has finished, successfully or not. -- Event Type: __`dev.cdevents.pipelinerun.finished.0.1.0-draft`__ +- Event Type: __`dev.cdevents.pipelinerun.finished.0.1.0`__ - Predicate: finished - Subject: [`pipelineRun`](#pipelinerun) @@ -113,7 +113,7 @@ A pipelineRun has finished, successfully or not. A taskRun has started and it is running. -- Event Type: __`dev.cdevents.taskrun.started.0.1.0-draft`__ +- Event Type: __`dev.cdevents.taskrun.started.0.1.0`__ - Predicate: started - Subject: [`taskRun`](#taskrun) @@ -129,7 +129,7 @@ A taskRun has started and it is running. A taskRun has finished, successfully or not. -- Event Type: __`dev.cdevents.taskrun.finished.0.1.0-draft`__ +- Event Type: __`dev.cdevents.taskrun.finished.0.1.0`__ - Predicate: finished - Subject: [`taskRun`](#taskrun) diff --git a/primer.md b/primer.md index 6da645ec..d6276f5f 100644 --- a/primer.md +++ b/primer.md @@ -6,7 +6,7 @@ description: > A CDEvents primer --- --> -# CDEvents Primer - Draft +# CDEvents Primer ## Abstract @@ -187,7 +187,7 @@ The version of an event is included in its type. This allows for easy filtering of events of a specific version, by looking at a single field in the context. Examples of full event versions are: -- `dev.cdevents.build.queued.0.1.0-draft` +- `dev.cdevents.build.queued.0.1.0` - `dev.cdevents.environment.deleted.0.1.0` ### Versioning of the CDEvents specification @@ -207,7 +207,7 @@ format `vMajor.Minor.Patch`. identified by a change in the major version, for instance 0.1.2 -> 2.0.0 While a version of the specification is work in progress, its version is tagged -with an extra `-draft` at the end, for instance 0.1.0-draft. +with an extra `-draft` at the end, for instance 0.1.0. ### Development of a new version diff --git a/schemas/artifactpackaged.json b/schemas/artifactpackaged.json index 832ea4e1..0a681b16 100644 --- a/schemas/artifactpackaged.json +++ b/schemas/artifactpackaged.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/artifact-packaged-event", + "$id": "https://cdevents.dev/0.1.0/schema/artifact-packaged-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/artifactpublished.json b/schemas/artifactpublished.json index 33230cf4..9fb4c25c 100644 --- a/schemas/artifactpublished.json +++ b/schemas/artifactpublished.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/artifact-published-event", + "$id": "https://cdevents.dev/0.1.0/schema/artifact-published-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/branchcreated.json b/schemas/branchcreated.json index 0defa15a..6ce296b1 100644 --- a/schemas/branchcreated.json +++ b/schemas/branchcreated.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/branch-created-event", + "$id": "https://cdevents.dev/0.1.0/schema/branch-created-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/branchdeleted.json b/schemas/branchdeleted.json index d7b9f954..16b9cce4 100644 --- a/schemas/branchdeleted.json +++ b/schemas/branchdeleted.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/branch-deleted-event", + "$id": "https://cdevents.dev/0.1.0/schema/branch-deleted-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/buildfinished.json b/schemas/buildfinished.json index f5c2594a..2b60b72a 100644 --- a/schemas/buildfinished.json +++ b/schemas/buildfinished.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/build-finished-event", + "$id": "https://cdevents.dev/0.1.0/schema/build-finished-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/buildqueued.json b/schemas/buildqueued.json index 8812edc8..ff37f1d0 100644 --- a/schemas/buildqueued.json +++ b/schemas/buildqueued.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/build-queued-event", + "$id": "https://cdevents.dev/0.1.0/schema/build-queued-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/buildstarted.json b/schemas/buildstarted.json index 8a0733c1..01cd9ea6 100644 --- a/schemas/buildstarted.json +++ b/schemas/buildstarted.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/build-started-event", + "$id": "https://cdevents.dev/0.1.0/schema/build-started-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/changeabandoned.json b/schemas/changeabandoned.json index 33a9fbda..b5d2d569 100644 --- a/schemas/changeabandoned.json +++ b/schemas/changeabandoned.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/change-abandoned-event", + "$id": "https://cdevents.dev/0.1.0/schema/change-abandoned-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/changecreated.json b/schemas/changecreated.json index 60daf87e..2b6cd024 100644 --- a/schemas/changecreated.json +++ b/schemas/changecreated.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/change-created-event", + "$id": "https://cdevents.dev/0.1.0/schema/change-created-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/changemerged.json b/schemas/changemerged.json index e7970be2..43762aa1 100644 --- a/schemas/changemerged.json +++ b/schemas/changemerged.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/change-merged-event", + "$id": "https://cdevents.dev/0.1.0/schema/change-merged-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/changereviewed.json b/schemas/changereviewed.json index 0781cd46..e010b79d 100644 --- a/schemas/changereviewed.json +++ b/schemas/changereviewed.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/change-reviewed-event", + "$id": "https://cdevents.dev/0.1.0/schema/change-reviewed-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/changeupdated.json b/schemas/changeupdated.json index 815ceec5..8d0485bd 100644 --- a/schemas/changeupdated.json +++ b/schemas/changeupdated.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/change-updated-event", + "$id": "https://cdevents.dev/0.1.0/schema/change-updated-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/environmentcreated.json b/schemas/environmentcreated.json index 0fd9186e..c0fe4944 100644 --- a/schemas/environmentcreated.json +++ b/schemas/environmentcreated.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/environment-created-event", + "$id": "https://cdevents.dev/0.1.0/schema/environment-created-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/environmentdeleted.json b/schemas/environmentdeleted.json index 064346ef..9b2489e7 100644 --- a/schemas/environmentdeleted.json +++ b/schemas/environmentdeleted.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/environment-deleted-event", + "$id": "https://cdevents.dev/0.1.0/schema/environment-deleted-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/environmentmodified.json b/schemas/environmentmodified.json index 06193968..08a66671 100644 --- a/schemas/environmentmodified.json +++ b/schemas/environmentmodified.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/environment-modified-event", + "$id": "https://cdevents.dev/0.1.0/schema/environment-modified-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/pipelinerunfinished.json b/schemas/pipelinerunfinished.json index 7b93c032..23d12f48 100644 --- a/schemas/pipelinerunfinished.json +++ b/schemas/pipelinerunfinished.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/pipeline-run-finished-event", + "$id": "https://cdevents.dev/0.1.0/schema/pipeline-run-finished-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/pipelinerunqueued.json b/schemas/pipelinerunqueued.json index d184bc14..3f0094da 100644 --- a/schemas/pipelinerunqueued.json +++ b/schemas/pipelinerunqueued.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/pipeline-run-queued-event", + "$id": "https://cdevents.dev/0.1.0/schema/pipeline-run-queued-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/pipelinerunstarted.json b/schemas/pipelinerunstarted.json index 350e357c..96c3b518 100644 --- a/schemas/pipelinerunstarted.json +++ b/schemas/pipelinerunstarted.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/pipeline-run-started-event", + "$id": "https://cdevents.dev/0.1.0/schema/pipeline-run-started-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/repositorycreated.json b/schemas/repositorycreated.json index 63fd5801..53a024cb 100644 --- a/schemas/repositorycreated.json +++ b/schemas/repositorycreated.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/repository-created-event", + "$id": "https://cdevents.dev/0.1.0/schema/repository-created-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/repositorydeleted.json b/schemas/repositorydeleted.json index f18237c7..fa0726b8 100644 --- a/schemas/repositorydeleted.json +++ b/schemas/repositorydeleted.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/repository-deleted-event", + "$id": "https://cdevents.dev/0.1.0/schema/repository-deleted-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/repositorymodified.json b/schemas/repositorymodified.json index 660a07f9..7537bb38 100644 --- a/schemas/repositorymodified.json +++ b/schemas/repositorymodified.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/repository-modified-event", + "$id": "https://cdevents.dev/0.1.0/schema/repository-modified-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/servicedeployed.json b/schemas/servicedeployed.json index 9fa6acc4..f5400382 100644 --- a/schemas/servicedeployed.json +++ b/schemas/servicedeployed.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/service-deployed-event", + "$id": "https://cdevents.dev/0.1.0/schema/service-deployed-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", @@ -96,8 +96,8 @@ "type": "object" }, { - "type": "string", - "contentEncoding": "base64" + "type": "string", + "contentEncoding": "base64" } ] }, diff --git a/schemas/servicepublished.json b/schemas/servicepublished.json index 807b6840..b6561c2f 100644 --- a/schemas/servicepublished.json +++ b/schemas/servicepublished.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/service-published-event", + "$id": "https://cdevents.dev/0.1.0/schema/service-published-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/serviceremoved.json b/schemas/serviceremoved.json index b762b798..1057464a 100644 --- a/schemas/serviceremoved.json +++ b/schemas/serviceremoved.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/service-removed-event", + "$id": "https://cdevents.dev/0.1.0/schema/service-removed-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/servicerolledback.json b/schemas/servicerolledback.json index 7411cead..5a092202 100644 --- a/schemas/servicerolledback.json +++ b/schemas/servicerolledback.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/service-rolledback-event", + "$id": "https://cdevents.dev/0.1.0/schema/service-rolledback-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/serviceupgraded.json b/schemas/serviceupgraded.json index acd3c6ff..e7193f1f 100644 --- a/schemas/serviceupgraded.json +++ b/schemas/serviceupgraded.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/service-upgraded-event", + "$id": "https://cdevents.dev/0.1.0/schema/service-upgraded-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/taskrunfinished.json b/schemas/taskrunfinished.json index 659c4963..ef5b8cdd 100644 --- a/schemas/taskrunfinished.json +++ b/schemas/taskrunfinished.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/task-run-finished-event", + "$id": "https://cdevents.dev/0.1.0/schema/task-run-finished-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/taskrunstarted.json b/schemas/taskrunstarted.json index bba3a83a..c6c6d95e 100644 --- a/schemas/taskrunstarted.json +++ b/schemas/taskrunstarted.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/task-run-started-event", + "$id": "https://cdevents.dev/0.1.0/schema/task-run-started-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/testcasefinished.json b/schemas/testcasefinished.json index 7e97b69c..1f7539fe 100644 --- a/schemas/testcasefinished.json +++ b/schemas/testcasefinished.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/test-case-finished-event", + "$id": "https://cdevents.dev/0.1.0/schema/test-case-finished-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/testcasequeued.json b/schemas/testcasequeued.json index 9eca8418..c6e9cdb7 100644 --- a/schemas/testcasequeued.json +++ b/schemas/testcasequeued.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/test-case-queued-event", + "$id": "https://cdevents.dev/0.1.0/schema/test-case-queued-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/testcasestarted.json b/schemas/testcasestarted.json index c9a35bfc..5aaff2ad 100644 --- a/schemas/testcasestarted.json +++ b/schemas/testcasestarted.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/test-case-started-event", + "$id": "https://cdevents.dev/0.1.0/schema/test-case-started-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/testsuitefinished.json b/schemas/testsuitefinished.json index 0d328800..aba84e7e 100644 --- a/schemas/testsuitefinished.json +++ b/schemas/testsuitefinished.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/test-suite-finished-event", + "$id": "https://cdevents.dev/0.1.0/schema/test-suite-finished-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/schemas/testsuitestarted.json b/schemas/testsuitestarted.json index 4335d20c..190c31e6 100644 --- a/schemas/testsuitestarted.json +++ b/schemas/testsuitestarted.json @@ -1,15 +1,15 @@ { "$schema": "https://json-schema.org/draft/2020-12/schema", - "$id": "https://cdevents.dev/0.1.0-draft/schema/test-suite-started-event", + "$id": "https://cdevents.dev/0.1.0/schema/test-suite-started-event", "properties": { "context": { "properties": { "version": { "type": "string", "enum": [ - "0.1.0-draft" + "0.1.0" ], - "default": "0.1.0-draft" + "default": "0.1.0" }, "id": { "type": "string", diff --git a/source-code-version-control.md b/source-code-version-control.md index be71f79b..b5e5860a 100644 --- a/source-code-version-control.md +++ b/source-code-version-control.md @@ -63,7 +63,7 @@ A `change` identifies a proposed set of changes to the content of a `repository` A new Source Code Repository was created to host source code for a project. -- Event Type: __`dev.cdevents.repository.created.0.1.0-draft`__ +- Event Type: __`dev.cdevents.repository.created.0.1.0`__ - Predicate: created - Subject: [`repository`](#repository) @@ -80,7 +80,7 @@ A new Source Code Repository was created to host source code for a project. A Source Code Repository modified some of its attributes, like location, or owner. -- Event Type: __`dev.cdevents.repository.modified.0.1.0-draft`__ +- Event Type: __`dev.cdevents.repository.modified.0.1.0`__ - Predicate: modified - Subject: [`repository`](#repository) @@ -95,7 +95,7 @@ A Source Code Repository modified some of its attributes, like location, or owne ### `repository deleted` -- Event Type: __`dev.cdevents.repository.deleted.0.1.0-draft`__ +- Event Type: __`dev.cdevents.repository.deleted.0.1.0`__ - Predicate: modified - Subject: [`repository`](#repository) @@ -112,7 +112,7 @@ A Source Code Repository modified some of its attributes, like location, or owne A branch inside the Repository was created. -- Event Type: __`dev.cdevents.branch.created.0.1.0-draft`__ +- Event Type: __`dev.cdevents.branch.created.0.1.0`__ - Predicate: created - Subject: [`branch`](#branch) @@ -126,7 +126,7 @@ A branch inside the Repository was created. A branch inside the Repository was deleted. -- Event Type: __`dev.cdevents.branch.deleted.0.1.0-draft`__ +- Event Type: __`dev.cdevents.branch.deleted.0.1.0`__ - Predicate: deleted - Subject: [`branch`](#branch) @@ -140,7 +140,7 @@ A branch inside the Repository was deleted. A source code change was created and submitted to a repository specific branch. Examples: PullRequest sent to Github, MergeRequest sent to Gitlab, Change created in Gerrit. -- Event Type: __`dev.cdevents.change.created.0.1.0-draft`__ +- Event Type: __`dev.cdevents.change.created.0.1.0`__ - Predicate: created - Subject: [`change`](#change) @@ -154,7 +154,7 @@ A source code change was created and submitted to a repository specific branch. Someone (user) or an automated system submitted an review to the source code change. A user or an automated system needs to be in charge of understanding how many approvals/rejections are needed for this change to be merged or rejected. The review event needs to include if the change is approved by the reviewer, more changes are needed or if the change is rejected. -- Event Type: __`dev.cdevents.change.reviewed.0.1.0-draft`__ +- Event Type: __`dev.cdevents.change.reviewed.0.1.0`__ - Predicate: reviewed - Subject: [`change`](#change) @@ -168,7 +168,7 @@ Someone (user) or an automated system submitted an review to the source code cha A change is merged to the target branch where it was submitted. -- Event Type: __`dev.cdevents.change.merged.0.1.0-draft`__ +- Event Type: __`dev.cdevents.change.merged.0.1.0`__ - Predicate: merged - Subject: [`change`](#change) @@ -182,7 +182,7 @@ A change is merged to the target branch where it was submitted. A tool or a user decides that the change has been inactive for a while and it can be considered abandoned. -- Event Type: __`dev.cdevents.change.abandoned.0.1.0-draft`__ +- Event Type: __`dev.cdevents.change.abandoned.0.1.0`__ - Predicate: abandoned - Subject: [`change`](#change) @@ -196,7 +196,7 @@ A tool or a user decides that the change has been inactive for a while and it ca A Change has been updated, for example a new commit is added or removed from an existing Change. -- Event Type: __`dev.cdevents.change.updated.0.1.0-draft`__ +- Event Type: __`dev.cdevents.change.updated.0.1.0`__ - Predicate: updated - Subject: [`change`](#change) diff --git a/spec.md b/spec.md index cf74d330..36a8e99e 100644 --- a/spec.md +++ b/spec.md @@ -257,7 +257,7 @@ defined in the [vocabulary](#vocabulary): - Type: `String` - Description: The version of the CDEvents specification which the event uses. This enables the interpretation of the context. Compliant event - producers MUST use a value of `0.1.0-draft` when referring to this version of the + producers MUST use a value of `0.1.0` when referring to this version of the specification. For more details see [versioning](primer.md#versioning). - Constraints: @@ -271,7 +271,7 @@ This is an example of a full CDEvent context, rendered in JSON format: ```json { "context": { - "version" : "0.1.0-draft", + "version" : "0.1.0", "id" : "A234-1234-1234", "source" : "/staging/tekton/", "type" : "dev.cdevents.taskrun.started", @@ -356,7 +356,7 @@ The following example shows `context` and `subject` together, rendered as JSON. ```json { "context": { - "version" : "0.1.0-draft", + "version" : "0.1.0", "id" : "A234-1234-1234", "source" : "/staging/tekton/", "type" : "dev.cdevents.taskrun.started", From 920069aa31a922cc8305af1abf629872dbdc9912 Mon Sep 17 00:00:00 2001 From: Andrea Frittoli Date: Thu, 20 Oct 2022 14:39:22 +0100 Subject: [PATCH 2/5] Remove work-in-progress notes Signed-off-by: Andrea Frittoli --- cloudevents-binding.md | 4 ---- continuous-deployment-pipeline-events.md | 2 -- continuous-integration-pipeline-events.md | 2 -- core.md | 2 -- source-code-version-control.md | 2 -- spec.md | 4 ---- 6 files changed, 16 deletions(-) diff --git a/cloudevents-binding.md b/cloudevents-binding.md index 4d0c46f8..a503d996 100644 --- a/cloudevents-binding.md +++ b/cloudevents-binding.md @@ -8,10 +8,6 @@ description: > --> # CloudEvents Binding for CDEvents -__Note:__ This is an __unreleased__, work-in-progress version of the spec, -and is being worked on by members of the CDEvents project. -You are very welcome to [join the work and the discussions](https://github.com/cdevents)! - ## Abstract The CloudEvents Binding for CDEvents defines how CDEvents are mapped to CloudEvents headers and body. diff --git a/continuous-deployment-pipeline-events.md b/continuous-deployment-pipeline-events.md index bc3ca151..0df3effb 100644 --- a/continuous-deployment-pipeline-events.md +++ b/continuous-deployment-pipeline-events.md @@ -8,8 +8,6 @@ description: > --> # Continuous Deployment Events -__Note:__ This is a work-in-progress draft version and is being worked on by members of the Events SIG. You are very welcome to join the work and the discussions! - Continuous Deployment (CD) events are related to continuos deployment pipelines and their target environments. These events can be emitted by environments to report where software artifacts such as services, binaries, daemons, jobs or embedded software are running. ## Subjects diff --git a/continuous-integration-pipeline-events.md b/continuous-integration-pipeline-events.md index 8c693b66..b182c514 100644 --- a/continuous-integration-pipeline-events.md +++ b/continuous-integration-pipeline-events.md @@ -8,8 +8,6 @@ description: > --> # Continuous Integration Events -__Note:__ This is a work-in-progress draft version and is being worked on by members of the Events SIG. You are very welcome to join the work and the discussions! - Continuous Integration (CI) events include the subject and predicates related to CI activities such as building software, producing artifacts and running tests. ## Subjects diff --git a/core.md b/core.md index e9384737..c7dda600 100644 --- a/core.md +++ b/core.md @@ -8,8 +8,6 @@ description: > --> # Continuous Delivery Core Events -__Note:__ This is a work-in-progress draft version and is being worked on by members of the Events SIG. You are very welcome to join the work and the discussions! - Continuous Delivery Core Events include the subjects and predicates related to orchestration of execution required to deterministically and continuously delivery software to users. Core events are at the lower level of abstraction in the dictionary: they describe the status of an execution, but they don't include any semantic about the function of the execution itself. These events are generated by [pipeline orchestration engines](https://landscape.cd.foundation/card-mode?category=ci-pipeline-orchestration&grouping=category). diff --git a/source-code-version-control.md b/source-code-version-control.md index b5e5860a..2587c54d 100644 --- a/source-code-version-control.md +++ b/source-code-version-control.md @@ -8,8 +8,6 @@ description: > --> # Source Code Version Control Events -__Note:__ This is a work-in-progress draft version and is being worked on by members of the Events SIG. You are very welcome to join the work and the discussions! - Source Code Version Control events includes the subjects and predicates related to changes in Source Code repositories that are relevant from a Continuous Delivery perspective. ## Subjects diff --git a/spec.md b/spec.md index 36a8e99e..5b81d31c 100644 --- a/spec.md +++ b/spec.md @@ -8,10 +8,6 @@ description: > --> # CDEvents -__Note:__ This is an __unreleased__, work-in-progress version of the spec, -and is being worked on by members of the CDEvents project. -You are very welcome to [join the work and the discussions](https://github.com/cdevents)! - ## Abstract CDEvents is a common specification for Continuous Delivery events. From eb3de840751a4ba6373c84f80afd17f1d030ae9e Mon Sep 17 00:00:00 2001 From: Andrea Frittoli Date: Thu, 20 Oct 2022 14:50:14 +0100 Subject: [PATCH 3/5] Add notes about SIG interop terms Signed-off-by: Andrea Frittoli --- primer.md | 28 ++++++++++++++++++++++------ 1 file changed, 22 insertions(+), 6 deletions(-) diff --git a/primer.md b/primer.md index d6276f5f..8fb9399d 100644 --- a/primer.md +++ b/primer.md @@ -377,11 +377,6 @@ new tool. A single consumer may receive events from heterogenous sources. -## Acknowledgments - -The initial structure of the CDEvents specification format was based on the -specification of the [CloudEvents](https://github.com/cloudevents/spec) project. - ## Use Cases There are two root use cases that we are considering: @@ -409,6 +404,17 @@ There are two root use cases that we are considering: - Lead time for changes: the amount of time it takes a commit to get into production - Deployment frequency: how often an organization successfully releases to production +## Terminology + +The [CDF Interoperability Special Interest Group][sig-interop] has produced a +[table of the terms][tool-terms] used by different CI/CD tools and how they +related to each other. The SIG is also working on distilling a recommended +[shared terminology][shared-terms]. CDEvents strives to adopt to the shared +terminology and collaborate with the SIG Interoperability. + +Work to align terms to those identified by the SIG will continue in upcoming +CDEvents releases. + ## Design Decisions ### Keys, Values and Types @@ -454,6 +460,11 @@ audience of DevOps Engineers, Project Managers/Directors, CTOs, and Cloud Architects who are interested in learning more about CDEvents, why it was created and its mission. +## Acknowledgments + +The initial structure of the CDEvents specification format was based on the +specification of the [CloudEvents](https://github.com/cloudevents/spec) project. + [workstream]: https://github.com/cdfoundation/sig-interoperability/tree/master/workstreams/archived/events_in_cicd [sig-interop]: https://github.com/cdfoundation/sig-interoperability [sig-events]: https://github.com/cdfoundation/sig-events/ @@ -464,4 +475,9 @@ created and its mission. https://github.com/package-url/purl-spec/blob/master/PURL-SPECIFICATION.rst [sig-interop-vocabulary]: https://github.com/cdfoundation/sig-interoperability/blob/main/docs/vocabulary.md -[dora]: https://cloud.google.com/blog/products/devops-sre/using-the-four-keys-to-measure-your-devops-performance \ No newline at end of file +[dora]: + https://cloud.google.com/blog/products/devops-sre/using-the-four-keys-to-measure-your-devops-performance +[tool-terms]: + https://github.com/cdfoundation/sig-interoperability/blob/main/docs/tools-terminology.md +[shared-terms]: + https://github.com/cdfoundation/sig-interoperability/blob/main/docs/pipelines-terminology.md From 0591d3f207b9c3d6898e7e6149ff076e833fcd21 Mon Sep 17 00:00:00 2001 From: Andrea Frittoli Date: Fri, 21 Oct 2022 11:31:16 +0100 Subject: [PATCH 4/5] Updates based on review feedback Signed-off-by: Andrea Frittoli --- README.md | 6 ++---- primer.md | 12 ++++++------ 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 64bcac16..adabbf1f 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,9 @@ points for metrics. ## CDEvents Specification The latest release of the specification is -[v0.1](https://github.com/cdevents/spec/tree/0.1.0/spec.md). - -You can also preview the ongoing work on the [CDEvents Specification](./spec.md) -on the `main` branch. +[v0.1.0](https://github.com/cdevents/spec/tree/0.1.0/spec.md), and you can continuously follow the latest updates +The concepts and ideas that have formed the current specification are outlined in the [CDEvents Primer](./primer.md). ## CDEvents SDKs CDEvents is developing as set of SDKs: diff --git a/primer.md b/primer.md index 8fb9399d..7381983c 100644 --- a/primer.md +++ b/primer.md @@ -187,7 +187,7 @@ The version of an event is included in its type. This allows for easy filtering of events of a specific version, by looking at a single field in the context. Examples of full event versions are: -- `dev.cdevents.build.queued.0.1.0` +- `dev.cdevents.build.queued.0.1.0-draft` - `dev.cdevents.environment.deleted.0.1.0` ### Versioning of the CDEvents specification @@ -207,7 +207,7 @@ format `vMajor.Minor.Patch`. identified by a change in the major version, for instance 0.1.2 -> 2.0.0 While a version of the specification is work in progress, its version is tagged -with an extra `-draft` at the end, for instance 0.1.0. +with an extra `-draft` at the end, for instance 0.1.0-draft. ### Development of a new version @@ -408,11 +408,11 @@ There are two root use cases that we are considering: The [CDF Interoperability Special Interest Group][sig-interop] has produced a [table of the terms][tool-terms] used by different CI/CD tools and how they -related to each other. The SIG is also working on distilling a recommended -[shared terminology][shared-terms]. CDEvents strives to adopt to the shared -terminology and collaborate with the SIG Interoperability. +relate to each other. The SIG Interoperability is also working on distilling a +recommended [shared terminology][shared-terms]. CDEvents strives to adopt to the +shared terminology and collaborate with the SIG Interoperability. -Work to align terms to those identified by the SIG will continue in upcoming +Work to align terms to those identified by the SIG Interoperability will continue in upcoming CDEvents releases. ## Design Decisions From 2aca2ce2b7142ac0a60f6073a05de208c4660155 Mon Sep 17 00:00:00 2001 From: Andrea Frittoli Date: Fri, 21 Oct 2022 12:24:10 +0100 Subject: [PATCH 5/5] complete sentece Signed-off-by: Andrea Frittoli --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index adabbf1f..24c2f465 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,9 @@ points for metrics. ## CDEvents Specification The latest release of the specification is -[v0.1.0](https://github.com/cdevents/spec/tree/0.1.0/spec.md), and you can continuously follow the latest updates +[v0.1.0](https://github.com/cdevents/spec/tree/0.1.0/spec.md), and you can +continuously follow the latest updates of the specification on [the `main` +branch](./spec.md). The concepts and ideas that have formed the current specification are outlined in the [CDEvents Primer](./primer.md). ## CDEvents SDKs