Add change.created description field #155
Conversation
@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. |
xibz
force-pushed
the
change-created-description
branch
from
ce4784d to
9e82af9
Compare
|
@xibz , looks like the title of this PR has been copied from another PR. Could you please correct that? |
xibz
changed the title
source-code-version-control.md
Outdated
| @@ -156,6 +156,7 @@ A source code change was created and submitted to a repository specific branch. | |||
| |-------|------|-------------|----------|----------------------------| | |||
| | id | `String` | See [id](spec.md#id-subject)| `1234`, `featureBranch123` | ✅ | | |||
| | source | `URI-Reference` | See [source](spec.md#source-subject) | `my-git.example/an-org/a-repo`| | | |||
| | description | `String` | Description associated with the change, e.g. A pull request's description | `This PR addresses a fix for some feature`| | | |||
There was a problem hiding this comment.
This description field should also be mentioned in the change table (e.g. on line 61 above).
Also, we want to keep the id, source and type fields together, so please move this new field one step down in the table.
There was a problem hiding this comment.
Okay, I think I did that correctly. It's a little odd that it seems to be a complete duplicate of the line I added.
There was a problem hiding this comment.
It's a little odd that it seems to be a complete duplicate of the line I added.
I do agree on that. We should maybe refactor that in the future because it is a bit hard to grasp, but that is what it looks like today at least.
The versioning of cdevents is documented here: https://cdevents.dev/docs/primer/#versioning |
xibz
force-pushed
the
change-created-description
branch
from
d3e4178 to
2a2296f
Compare
There was a problem hiding this comment.
Hmm. I'm a bit confused myself over the structure of the json bodies. New subject specific fields should always be placed within the content object in the subject object. The top level properties in a subject should only be id, source, type and content for all event types.
schemas/changecreated.json
Outdated
| @@ -58,6 +58,10 @@ | |||
| ], | |||
| "default": "change" | |||
| }, | |||
| "description": { | |||
There was a problem hiding this comment.
Please move this down to be part of the content object.
There was a problem hiding this comment.
Oh, what's the top level id, source, and type not doing in content?
There was a problem hiding this comment.
I believe the reasoning is that those fields are identifying the subject itself, while any other fields are considered parameters on the subject identity.
xibz
force-pushed
the
change-created-description
branch
from
b841dd4 to
c3efcaa
Compare
|
The only thing missing on this PR is that the commit needs to be signed. |
xibz
force-pushed
the
change-created-description
branch
from
c3efcaa to
2ba8074
Compare
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" Signed-off-by: xibz <impactbchang@gmail.com>
xibz
force-pushed
the
change-created-description
branch
from
2ba8074 to
061a46e
Compare
@e-backmark-ericsson done! |
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" Signed-off-by: xibz <impactbchang@gmail.com> Co-authored-by: benjamin-j-powell <benjamin_j_powell@apple.com>
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: