cdevents / spec

A common specification for Continuous Delivery events

Apache License 2.0

133 stars 23 forks source link

Add change.created description field #155

Closed xibz closed 1 year ago

xibz commented 1 year ago

Changes

This commit adds a new optional field to the dev.cdevents.change.created event. This field, description, should be used to describe the change, e.g. a GitHub PR.

An example of the description field could be something like

"This PR addresses a new bug that was introduced in some PR"

resolves #151

Signed-off-by: benjamin-j-powell benjamin_j_powell@apple.com

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

[x] Has the primer doc been updated if a design decision is involved
[x] Have the JSON schemas been updated if the specification changed
[x] Has spec version and event versions been updated according to the versioning policy
[x] Meets the CDEvents contributor standards

xibz commented 1 year ago

Has spec version and event versions been updated according to the versioning policy

@afrittoli @e-backmark-ericsson One thing that wasn't clear to me was the versioning. Can you explain the process? Since the link looks to 404. We should fix that as well and document the process.

e-backmark-ericsson commented 1 year ago

@xibz , looks like the title of this PR has been copied from another PR. Could you please correct that?

e-backmark-ericsson commented 1 year ago

Has spec version and event versions been updated according to the versioning policy

@afrittoli @e-backmark-ericsson One thing that wasn't clear to me was the versioning. Can you explain the process? Since the link looks to 404. We should fix that as well and document the process.

The versioning of cdevents is documented here: https://cdevents.dev/docs/primer/#versioning You should step the minor version of the change.created event from 0.1.2 to 0.2.0 and keep the spec version as 0.4.0-draft. It's correct that the $id field in the schema will not be possible to resolve until the new spec version is released (and then all files will be updated to 0.4.0 as part of the release as well)

e-backmark-ericsson commented 1 year ago

The only thing missing on this PR is that the commit needs to be signed. https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits

xibz commented 1 year ago

The only thing missing on this PR is that the commit needs to be signed. docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits

@e-backmark-ericsson done!