Fix verification example #194
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
codysoyland
requested changes
May 30, 2024
There was a problem hiding this comment.
Thanks for your contribution, @cmurphy! Just a couple of suggestions to remove these already default values.
docs/verification.md
Outdated
| @@ -58,7 +58,13 @@ To verify a bundle with the Go API, you'll need to: | |||
| Going through this step-by-step, we'll start by loading the trusted root from the Sigstore TUF repo: | |||
|
|
|||
| ```go | |||
| trustedrootJSON, err := tuf.GetTrustedrootJSON("tuf-repo-cdn.sigstore.dev", "tufcache") | |||
| opts := tuf.DefaultOptions() | |||
| opts.RepositoryBaseURL = "https://tuf-repo-cdn.sigstore.dev" | |||
There was a problem hiding this comment.
This is the default base URL, so we can omit this line.
Suggested change
| opts.RepositoryBaseURL = "https://tuf-repo-cdn.sigstore.dev" |
docs/verification.md
Outdated
| @@ -187,7 +193,13 @@ import ( | |||
| ) | |||
|
|
|||
| func main() { | |||
| trustedrootJSON, err := tuf.GetTrustedrootJSON("tuf-repo-cdn.sigstore.dev", "tufcache") | |||
| opts := tuf.DefaultOptions() | |||
| opts.RepositoryBaseURL = "https://tuf-repo-cdn.sigstore.dev" | |||
There was a problem hiding this comment.
Suggested change
| opts.RepositoryBaseURL = "https://tuf-repo-cdn.sigstore.dev" |
`GetTrustedrootJSON` was removed in 40d7422, so update the example for the new API. Signed-off-by: Colleen Murphy <[email protected]>
|
Fixed, thanks! |
haydentherapper
approved these changes
May 30, 2024
codysoyland
approved these changes
May 30, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GetTrustedrootJSONwas removed in 40d7422, so update the example for the new API.Summary
Release Note
Documentation