Add example files for all events

Add example files for all events.
Add a CI job that checks all examples against the schemas.

Signed-off-by: Andrea Frittoli <[email protected]>

.github/workflows/main.yml

@@ -10,13 +10,13 @@ on:
 # Set the Job #
 ###############
 jobs:
-  build:
+  lint:
     name: Lint Code Base
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           # Full git history is needed to get a proper list of changed files within `super-linter`
           fetch-depth: 0
@@ -31,3 +31,19 @@ jobs:
           DEFAULT_BRANCH: main
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VALIDATE_MARKDOWN: true
+
+  jsonschema:
+    name: Validate examples
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Set up Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: 1.19
+
+      - name: Validate Examples
+        run: ./tools/verify-examples.sh

README.md

@@ -86,6 +86,10 @@ Handling Events associated with the health of the services deployed and running
 
 Defining how CDEvents are mapped to CloudEvents for transportation and delivery
 
+### [Schemas](./schemas/) and [Examples](./examples/)
+
+The [schemas](./schemas/) folder contains `jsonschemas` for all events in the spec. The [examples](./examples/) contains simple `JSON` examples for all events.
+
 ## CDEvents SDKs
 
 CDEvents is developing as set of SDKs:
@@ -94,7 +98,6 @@ CDEvents is developing as set of SDKs:
 * [Python](https://github.com/cdevents/sdk-python)
 * [Java](https://github.com/cdevents/sdk-java)
 
-
 ## Community
 
 ### How to get involved

examples/artifact_packaged.json

@@ -0,0 +1,20 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.artifact.packaged.0.1.1",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c",
+    "source": "/event/source/123",
+    "type": "artifact",
+    "content": {
+      "change": {
+        "id": "myChange123",
+        "source": "my-git.example/an-org/a-repo"
+      }
+    }
+  }
+}

examples/artifact_published.json

@@ -0,0 +1,15 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.artifact.published.0.1.1",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c",
+    "source": "/event/source/123",
+    "type": "artifact",
+    "content": {}
+  }
+}

examples/branch_created.json

@@ -0,0 +1,20 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.branch.created.0.1.2",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "branch",
+    "content": {
+      "repository": {
+        "id": "TestRepo/TestOrg",
+        "source": "https://example.org"
+      }
+    }
+  }
+}

examples/branch_deleted.json

@@ -0,0 +1,20 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.branch.deleted.0.1.2",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "branch",
+    "content": {
+      "repository": {
+        "id": "TestRepo/TestOrg",
+        "source": "https://example.org"
+      }
+    }
+  }
+}

examples/build_finished.json

@@ -0,0 +1,17 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.build.finished.0.1.1",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "build",
+    "content": {
+      "artifactId": "pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427"
+    }
+  }
+}

examples/build_queued.json

@@ -0,0 +1,15 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.build.queued.0.1.1",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "build",
+    "content": {}
+  }
+}

examples/build_started.json

@@ -0,0 +1,15 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.build.started.0.1.1",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "build",
+    "content": {}
+  }
+}

examples/change_abandoned.json

@@ -0,0 +1,20 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.change.abandoned.0.1.2",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "change",
+    "content": {
+      "repository": {
+        "id": "TestRepo/TestOrg",
+        "source": "https://example.org"
+      }
+    }
+  }
+}

examples/change_created.json

@@ -0,0 +1,20 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.change.created.0.1.2",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "change",
+    "content": {
+      "repository": {
+        "id": "TestRepo/TestOrg",
+        "source": "https://example.org"
+      }
+    }
+  }
+}

examples/change_merged.json

@@ -0,0 +1,20 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.change.merged.0.1.2",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "change",
+    "content": {
+      "repository": {
+        "id": "TestRepo/TestOrg",
+        "source": "https://example.org"
+      }
+    }
+  }
+}

examples/change_reviewed.json

@@ -0,0 +1,20 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.change.reviewed.0.1.2",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "change",
+    "content": {
+      "repository": {
+        "id": "TestRepo/TestOrg",
+        "source": "https://example.org"
+      }
+    }
+  }
+}

examples/change_updated.json

@@ -0,0 +1,20 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.change.updated.0.1.2",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "change",
+    "content": {
+      "repository": {
+        "id": "TestRepo/TestOrg",
+        "source": "https://example.org"
+      }
+    }
+  }
+}

examples/environment_created.json

@@ -0,0 +1,18 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.environment.created.0.1.1",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "environment",
+    "content": {
+      "name": "testEnv",
+      "url": "https://example.org/testEnv"
+    }
+  }
+}

examples/environment_deleted.json

@@ -0,0 +1,17 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.environment.deleted.0.1.1",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "environment",
+    "content": {
+      "name": "testEnv"
+    }
+  }
+}

examples/environment_modified.json

@@ -0,0 +1,18 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.environment.modified.0.1.1",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "environment",
+    "content": {
+      "name": "testEnv",
+      "url": "https://example.org/testEnv"
+    }
+  }
+}

examples/pipelinerun_finished.json

@@ -0,0 +1,20 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.pipelinerun.finished.0.1.1",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "pipelineRun",
+    "content": {
+      "pipelineName": "myPipeline",
+      "url": "https://www.example.com/mySubject123",
+      "outcome": "failure",
+      "errors": "Something went wrong\nWith some more details"
+    }
+  }
+}

examples/pipelinerun_queued.json

@@ -0,0 +1,18 @@
+{
+  "context": {
+    "version": "0.2.0",
+    "id": "271069a8-fc18-44f1-b38f-9d70a1695819",
+    "source": "/event/source/123",
+    "type": "dev.cdevents.pipelinerun.queued.0.1.1",
+    "timestamp": "2023-03-20T14:27:05.315384Z"
+  },
+  "subject": {
+    "id": "mySubject123",
+    "source": "/event/source/123",
+    "type": "pipelineRun",
+    "content": {
+      "pipelineName": "myPipeline",
+      "url": "https://www.example.com/mySubject123"
+    }
+  }
+}