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

notation sign error messages are not helpful to understand what parameter is missing #618

Closed
toddysm opened this issue Apr 5, 2023 · 2 comments
Labels
bug Something isn't working UX User experience changes
Milestone

Comments

@toddysm
Copy link
Contributor

toddysm commented Apr 5, 2023

What is the areas you experience the issue in?

Notation CLI

What is not working as expected?

The following command notation sign --signature-format cose --key $REMOTE_KEY_NAME $DEST_IMAGE returns the following error message: Error: missing reference

From that error message is not clear what reference is missing. Actually the error is even more confusing because reference assumes reference to the artifact and the actual error was missing key.

What did you expect to happen?

Meaningful error like: "Missing key parameter required for signing" or missing "Artifact reference required for signing".

How can we reproduce it?

Issue the command listed above.

Describe your environment

N/A

What is the version of your Notation CLI or Notation Library?

Notation: Notary v2, A tool to sign, store, and verify artifacts.

Version: 1.0.0-rc.3
Go version: go1.20.1
Git commit: 233c0ea

@toddysm toddysm added bug Something isn't working UX User experience changes triage Need to triage labels Apr 5, 2023
@yizha1 yizha1 added this to the 1.0.0 milestone Apr 26, 2023
@yizha1 yizha1 removed the triage Need to triage label Apr 26, 2023
@yizha1 yizha1 modified the milestones: 1.0.0, 1.1.0 May 19, 2023
@yizha1
Copy link
Contributor

yizha1 commented May 19, 2023

Move to post v1 release, as it is not critical for v1 release. cc @vaninrao10

@yizha1
Copy link
Contributor

yizha1 commented Jan 2, 2024

Fixed by #810

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working UX User experience changes
Projects
Status: Done
Development

No branches or pull requests

2 participants