Skip to content

Add UID Optional field to scorecard config types #110

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

Merged
merged 6 commits into from
Jun 15, 2021
Merged

Add UID Optional field to scorecard config types #110

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bfed7a0
Add UID Optional field to scorecard config types
Apr 14, 2021
159fa6a
generated changes
Apr 30, 2021
d8660ab
rebase
Jun 7, 2021
39df612
repaird generated files
Jun 7, 2021
b9245a7
Merge remote-tracking branch 'upstream/master' into addUniqueSCTest
Jun 15, 2021
63b95aa
gen manifests
Jun 15, 2021
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
2 changes: 2 additions & 0 deletions pkg/apis/scorecard/v1alpha3/configuration_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ type StageConfiguration struct {
type TestConfiguration struct {
// Image is the name of the test image.
Image string `json:"image" yaml:"image"`
// UniqueID is is an optional unique test identifier of the test image.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add an example of a default/generated value used if this is unset, and clarify where the default/generated value comes from?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are not going default this value, as it's not being used anywhere within scorecard and is only available as an option if someone wants to specifically tag a test and watch it with a unique id for that run.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this value conform to any specifications, ex. DNS 1123? What do you mean by "watch it"? As a user, how and where is this value applied to my scorecard tests? Are there examples of what value I might set here?

These are some of the questions not answered by any documentation/godocs anywhere, which is kinda what I was getting at with my question. It isn't clear what this field does, and libraries should be self-descriptive.

UniqueID string `json:"uniqueID,omitempty" yaml:"uniqueID,omitempty"`
// Entrypoint is a list of commands and arguments passed to the test image.
Entrypoint []string `json:"entrypoint,omitempty" yaml:"entrypoint,omitempty"`
// Labels further describe the test and enable selection.
Expand Down