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

docs: Fix extensions for digest values requiring a type prefix #1661

Merged
merged 2 commits into from
May 14, 2024

Conversation

facutuesca
Copy link
Contributor

This PR has two commits:

  • The first one fixes the table mapping OIDC token claims to OIDs, changing digest extensions (i.e: Build Signer Digest, Source Repository Digest and Build Config Digest) to say that their value MAY include the digest type (as in: sha1:$SHA_VALUE), rather than SHOULD include it.
  • The second one formats the plain text of the table so that each column has the same width (the difference can only be seen in plaintext, the rendered markdown should be the same):
image

The second commit is optional, I can remove it if it's unwanted

cc @woodruffw @haydentherapper

Signed-off-by: Facundo Tuesca <facundo.tuesca@trailofbits.com>
Signed-off-by: Facundo Tuesca <facundo.tuesca@trailofbits.com>
Copy link
Member

@woodruffw woodruffw left a comment

Choose a reason for hiding this comment

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

LGTM in terms of observed behavior! I suppose one could argue that "should" is already non-normative, though 🙂

Copy link
Contributor

@haydentherapper haydentherapper left a comment

Choose a reason for hiding this comment

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

Thank you!

Copy link
Member

@cpanato cpanato left a comment

Choose a reason for hiding this comment

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

thanks!

@haydentherapper haydentherapper merged commit de65352 into sigstore:main May 14, 2024
13 checks passed
@facutuesca facutuesca deleted the docs-digest-may branch May 14, 2024 17:38
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

4 participants