Add documentation around gh attestation verify JSON output
#10440
Conversation
Signed-off-by: Meredith Lancaster <malancas@github.com>
| fields used during the verification process. This includes: | ||
| - The attestation's signature | ||
| - The attestation's statement | ||
| - The attestation's predicate |
There was a problem hiding this comment.
Is this a comprehensive list? And just checking, is this the right place to list what fields are used during the verification process? Maybe we could note what is verified under the "By default, the verify command will:" section, and then in the --json helper notes we can mention that details used for verification are within the verificationResult object.
There was a problem hiding this comment.
It isn't an exhaustive list, it just includes a lists a few fields surfaced in the verificationResult object the user might find particularly useful. These could definitely be moved under a json helper notes section.
There was a problem hiding this comment.
ah okay, it might be good to say "This includes useful fields, such as: " or similar. Just in case others assume it's exhaustive.
There was a problem hiding this comment.
I'm going to take a stab at this tomorrow fwiw.
|
Superseded by #10685 |
Add documentation around the output printed by
gh attestation verifywhen the--format jsonflag is included.cc #9850