cdevents / spec

A common specification for Continuous Delivery events
Apache License 2.0
129 stars 22 forks source link

Propose new event, "Artifact.flagged" #163

Open dan-han-101 opened 1 year ago

dan-han-101 commented 1 year ago

Currently, an "artifact" has the following predicates: packaged, published, and signed.

In #143 - there is a discussion on adding

And in #144 - there is a discussion for adding

In this Issue, I'd like to propose adding another event, artifact.flagged.

Our use case

We run tests that create messages like testSuiteRun.finished and testSuiteRun.finished. These tests ultimately are intended to validate whether some other system-under-test is in a healthy state. When a test completes, we would like to post a message, saying that a given "artifact" has been "flagged" with a passing or failing test.

Alternatives

While, internally, we have been using the rather generic name of "flagged", for our purposes, it would be fine with us to go to a more granular level and have the message instead be "Artifact.tested".

Message details

Roughly, we envision something that has identifers for the artifact, and identifiers for the test with its associated status (failed/passed/etc...)

e-backmark-ericsson commented 10 months ago

@dan-han-101 , this artifact.flagged event, do you think it is the same use case as the confidence label or maturity level terms I mentioned in my comment on this issue: https://github.com/cdevents/spec/issues/143#issuecomment-1840733305 ?

dan-han-101 commented 9 months ago

@e-backmark-ericsson - Yes, I think this issue is similar to a confidence label or maturity level .

I also saw someone mention artifact.quarantined - I think is close to what I was looking for.

I'm Ok to close this issue if existing issues already overlap. And I can just follow and add comments to the other ones.