Skip to content
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.

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

doc: introduce verifier type #43

Closed

Conversation

junczhu
Copy link
Contributor

@junczhu junczhu commented Dec 6, 2023

introduce verifier type to the verifier spec and verification result version

Copy link

netlify bot commented Dec 6, 2023

Deploy Preview for ratify-dev ready!

Name Link
🔨 Latest commit e8153ec
🔍 Latest deploy log https://app.netlify.com/sites/ratify-dev/deploys/6577b74ff92a200008810422
😎 Deploy Preview https://deploy-preview-43--ratify-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/reference/verification-result-version.md Outdated Show resolved Hide resolved

| Property | Type | IsRequired | Description |
| -------- | -------- | -------- | --------- |
| name | string | true |The name of the plugin that should match with plugin binary on disk. Must not contain characters disallowed in file paths for the system (e.g. / or \) |
| name | string | true |The name of the plugin that should match with plugin binary on disk. Must not contain characters disallowed in file paths for the system (e.g. / or \). `name` can be customized when `type` has been specified. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe we should mention that when type is not provided, name would behave like type.

Copy link
Collaborator

Choose a reason for hiding this comment

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

The binary naming is also confusing to me. If only the name is specified then the binary name must match but otherwsie the binary must match the type field right?

@akashsinghal
Copy link
Collaborator

@junczhu do you think we should update all the configs and verifier report samples we have in the docs to add the type field?

@junczhu
Copy link
Contributor Author

junczhu commented Dec 11, 2023

@junczhu do you think we should update all the configs and verifier report samples we have in the docs to add the type field?

We can discuss that at the next community meeting.

As discussed, I would open a new PR for the updates, and comment about the change applies to the release version 1.1.0 and this change is backward compatible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants