Make the the invalid CA error message actionable #356
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
Signed-off-by: Thomas Stromberg <t+github@chainguard.dev>
lukehinds
approved these changes
Jan 28, 2022
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.
Signed-off-by: Thomas Stromberg t+github@chainguard.dev
Summary
This PR improves the error message when an invalid
--cais provided by making it directly actionable. This lowers the friction for folks like me who are blindly pasting lines from the sigstore-the-hard-way doc.When I first saw the error message, it did not occur to me that it referenced the
--cavalue versus an expected value within the key pair. Here is the example command-line to trigger the condition:fulcio serve --config-path=fulcio-config.json --ca=fulcioca --hsm-caroot-id=1 --ct-log-url=http://localhost:6105/sigstore --host=0.0.0.0 --port=5000Old output
FATAL app/serve.go:119 unknown CA: fulciocaNew output
FATAL app/serve.go:119 --ca=fulcioca is not a valid selection. Try: pkcs11ca, googleca, fileca, or ephemeralcaRelease Note