Adds testcaserun skipped event

Adds "skipped" as a new predicate for testcaserun events. A final outcome of "skip" is common for many test frameworks, so adding it as a possible outcome will improve interoperability. See further discussion in #140. Signed-off-by: Daniel Han <[email protected]>
cdevents · Mar 1, 2024 · 8fa164a · 8fa164a
1 parent 6120974
commit 8fa164a
Show file tree

Hide file tree

Showing 27 changed files with 831 additions and 105 deletions.
diff --git a/.github/pull_request_template.md b/.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)
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -33,7 +33,7 @@ jobs:
           VALIDATE_MARKDOWN: true
 
   jsonschema:
-    name: Validate examples
+    name: Validate Examples
     runs-on: ubuntu-latest
 
     steps:
@@ -47,3 +47,12 @@ jobs:
 
       - name: Validate Examples
         run: ./tools/verify-examples.sh
+
+  spellcheck:
+    name: Spellcheck (en_US)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+      - name: Spellcheck
+        uses: rojopolis/[email protected]
diff --git a/.spellcheck-en-custom.txt b/.spellcheck-en-custom.txt
@@ -0,0 +1,103 @@
+Auth
+BD
+CDF
+CVE
+Gerrit
+Github
+Gitlab
+JSON
+KH
+KyjITcZXHotdMB
+MEYCIQCBT
+NGua
+NIST
+Notational
+README
+SBOM
+SBOMs
+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
+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
@@ -0,0 +1,37 @@
+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
+    d: en_US
+    camel-case: true
+    mode: url
+  sources:
+  - "**/*.md"
+  dictionary:
+    wordlists:
+    - .spellcheck-en-custom.txt
+  pipeline:
+  - pyspelling.filters.context:
+      context_visible_first: true
+      escapes: '\\[\\`~]'
+      delimiters:
+      # Ignore multiline content between fences (fences can have 3 or more back ticks)
+      # ```
+      # content
+      # ```
+      - open: '(?s)^(?P<open> *`{3,})$'
+        close: '^(?P=open)$'
+      # Ignore text between inline back ticks
+      - open: '(?P<open>`+)'
+        close: '(?P=open)'
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -0,0 +1,12 @@
+# Maintainers table
+# | Full Name         | Company    | GitHub                                                         |
+# |-------------------|:----------:|----------------------------------------------------------------|
+# | Emil Bäckmark     | Ericsson   | [@e-backmark-ericsson](https://github.com/e-backmark-ericsson) |
+# | Andrea Frittoli   | IBM        | [@afrittoli](https://github.com/afrittoli)                     |
+# | Ben Powell        | Apple      | [@xibz](https://github.com/xibz)                               |
+
+# Emeritus maintainers (must be in a comment)
+# Note yet
+
+# Repo maintainers
+* @cdevents/spec-maintainers
diff --git a/README.md b/README.md
@@ -120,6 +120,5 @@ guidelines.
 
 ### Governance
 
-The project has been started by the CDF
-[SIG Events](https://github.com/cdfoundation/sig-events) and is currently
-[governed](https://github.com/cdevents/community/blob/main/governance.md) by a few members of the SIG.
+The project has been started by the CDF [SIG Events](https://github.com/cdfoundation/sig-events).
+Its governance is [documented in the community repository](https://github.com/cdevents/community/blob/main/governance.md).
diff --git a/cloudevents-binding.md b/cloudevents-binding.md
@@ -92,7 +92,7 @@ Full example of a CDEvents transported through a CloudEvent in HTTP *binary* mod
 POST /sink HTTP/1.1
 Host: cdevents.example.com
 ce-specversion: 1.0
-ce-type: dev.cdevents.taskrun.started.0.1-draft
+ce-type: dev.cdevents.taskrun.started.0.1.1
 ce-time: 2018-04-05T17:31:00Z
 ce-id: A234-1234-1234
 ce-source: /staging/tekton/
@@ -102,10 +102,10 @@ Content-Length: nnnn
 
 {
    "context": {
-      "version": "0.4.0-draft",
+      "version": "0.3.0",
       "id" : "A234-1234-1234",
       "source" : "/staging/tekton/",
-      "type" : "dev.cdevents.taskrun.started",
+      "type" : "dev.cdevents.taskrun.started.0.1.1",
       "timestamp" : "2018-04-05T17:31:00Z",
    }
    "subject" : {

diff --git a/continuous-deployment.md b/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.