Skip to content

feat: add outcome and errors to build.finished #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sol-duara wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −6
Open

feat: add outcome and errors to build.finished #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions conformance/build_finished.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"id": "271069a8-fc18-44f1-b38f-9d70a1695819",
"chainId": "4c8cb7dd-3448-41de-8768-eec704e2829b",
"source": "/event/source/123",
"type": "dev.cdevents.build.finished.0.3.0",
"type": "dev.cdevents.build.finished.0.4.0-draft",
"timestamp": "2023-03-20T14:27:05.315384Z",
"schemaUri": "https://myorg.com/schema/custom",
"links": [
Expand Down Expand Up @@ -43,7 +43,8 @@
"id": "mySubject123",
"source": "/event/source/123",
"content": {
"artifactId": "pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427"
"artifactId": "pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427",
"outcome": "success"
}
}
}
6 changes: 4 additions & 2 deletions continuous-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ This event represents a Build task that has been started; this build process usu

### [`build finished`](conformance/build_finished.json)

This event represents a Build task that has finished. This event will eventually contain the finished status, success, error or failure
A Build task has finished, successfully or not.

- Event Type: __`dev.cdevents.build.finished.0.3.0`__
- Event Type: __`dev.cdevents.build.finished.0.4.0-draft`__
- Predicate: finished
- Subject: [`build`](#build)

Expand All @@ -89,6 +89,8 @@ This event represents a Build task that has finished. This event will eventually
| id | `String` | See [id](spec.md#id-subject)| `1234`, `maven123`, `builds/taskrun123` | ✅ |
| source | `URI-Reference` | See [source](spec.md#source-subject) | | |
| artifactId | `Purl` | Identifier of the artifact produced by the build | `pkg:oci/myapp@sha256%3A0b31b1c02ff458ad9b7b81cbdf8f028bd54699fa151f221d1e8de6817db93427`, `pkg:golang/mygit.com/myorg/myapp@234fd47e07d1004f0aed9c` | `build` | |
| outcome | `String (enum)` | outcome of a finished `build` | `success`, `failure`, `cancel`, or `error` | `success`, `failure`, `cancel`, `error` |
| errors | `String` | In case of error, canceled, or failed build, provides details about the failure | `Invalid input param 123`, `Timeout during execution`, `build canceled by user`, `Compilation failed`| |

### [`artifact packaged`](conformance/artifact_packaged.json)

Expand Down
16 changes: 14 additions & 2 deletions schemas/buildfinished.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@
"type": {
"type": "string",
"enum": [
"dev.cdevents.build.finished.0.3.0"
"dev.cdevents.build.finished.0.4.0-draft"
],
"default": "dev.cdevents.build.finished.0.3.0"
"default": "dev.cdevents.build.finished.0.4.0-draft"
},
"timestamp": {
"type": "string",
Expand Down Expand Up @@ -66,6 +66,18 @@
"properties": {
"artifactId": {
"type": "string"
},
"outcome": {
"type": "string",
"enum": [
"success",
"failure",
"cancel",
"error"
]
},
"errors": {
"type": "string"
}
},
"additionalProperties": false,
Expand Down