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

Consider Updates to Attestor Type Documentation #372

Open
Strakeln opened this issue Jan 29, 2024 · 2 comments
Open

Consider Updates to Attestor Type Documentation #372

Strakeln opened this issue Jan 29, 2024 · 2 comments

Comments

@Strakeln
Copy link

There doesn't seem to be a place where the attestor type names are specified (for input with witness run -a). The attestor types have documentation pages found here, but the actual argument provided to the -a option is not easily discovered.

For example, the CommandRun attestor documentation can be found here, but the actual argument provided to -a, command-run, is not easily found. This may be a poor example as there appear to be separate issues with specifying -a command-run.

@tannerjones4075
Copy link

Hello @Strakeln thanks for brining this to our attention. We have a doc file that outlines the witness arguments. Is this what you are referencing?

@Strakeln
Copy link
Author

Strakeln commented Feb 7, 2024

Hey @tannerjones4075 - that is an example of what I'm referring to. Specifically looking at the following option:

-a, --attestations strings Attestations to record ('product' and 'material' are always recorded) (default [environment,git])

The valid strings arguments to provide to this option are not easily found. The help text mentions product, material, environment, and git. I believe that this page lists the available attestors, but not the specific string we should provide to the -a option.

I realize that some of the specific strings are the same as the document name in the page I linked (ex: product, material, jwt, oci, environment, git, maven), but I believe there is at least one example where that is not the case (commandrun, for which I believe the string is actually command-run.

Basically, I'm just looking for a list of valid values to provide to the -a option.

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

No branches or pull requests

2 participants