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.

Sign up for GitHub

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

Jump to bottom

Create a CLI Error Handling Guideline to improve error messages and error handling #824

Closed
FeynmanZhou opened this issue Nov 7, 2023 · 0 comments · Fixed by #834
Closed

Create a CLI Error Handling Guideline to improve error messages and error handling #824

FeynmanZhou opened this issue Nov 7, 2023 · 0 comments · Fixed by #834
Assignees
@FeynmanZhou
Labels
enhancement New feature or request
Milestone
1.2.0

Comments

@FeynmanZhou
Copy link
Member

Is your feature request related to a problem?

The error messages in some Notation CLI commands do not show the actual value that were provided or show too vague error messages that are hard to troubleshoot and locate the root cause. Notation maintainers are working on improving some error messages, such as #810 .

What solution do you propose?

In order to provide clearer structures for error categorizing and also more actionable error outputs for better user experience, it is recommended to create a Notation CLI Error Handling Guideline.

This document aims to provide the guidelines for ORAS contributors to improve existing error messages and handling method as well as the new error output format. It will also provide recommendations for ORAS CLI contributors for how to write friendly and standard error messages and avoid inconsistent error handling & messages.

What alternatives have you considered?

NA

Any additional context?

No response
@FeynmanZhou FeynmanZhou added enhancement New feature or request triage Need to triage labels Nov 7, 2023
@FeynmanZhou FeynmanZhou mentioned this issue Nov 20, 2023
Merged
@yizha1 yizha1 removed the triage Need to triage label Nov 23, 2023
@yizha1 yizha1 modified the milestones: 1.2.0, 1.1.0 Nov 23, 2023
@JeyJeyGao JeyJeyGao mentioned this issue Jan 12, 2024
Merged
JeyJeyGao added a commit to notaryproject/notation-go that referenced this issue Jan 18, 2024
@JeyJeyGao
fix: improve plugin error message (#371)
d52ca71 
- added `PluginUnknownError`, `PluginValidityError`,
`PluginDirectoryError`. For each error types, Notation CLI should
provide a recommanded suggestion to solve them.
- improved error message

Resolve part of: notaryproject/notation#824
Resolve part of: notaryproject/notation#867

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>

---------

Signed-off-by: Junjie Gao <junjiegao@microsoft.com>
@yizha1 yizha1 mentioned this issue Jan 29, 2024
Open
@yizha1 yizha1 mentioned this issue Apr 9, 2024
Open
@yizha1 yizha1 modified the milestones: 1.1.0, 1.2.0 Apr 9, 2024
@yizha1 yizha1 mentioned this issue Apr 9, 2024
Open
priteshbandi pushed a commit that referenced this issue May 28, 2024
@FeynmanZhou
doc: add Notation CLI Error Handling and Message Guideline (#834)
66126e2 
Resolve #824 

This guideline only includes the guiding principles for Notation CLI error message. All suggested changes will be documented into different GitHub issues and another [document](https://hackmd.io/9O01p9xYS7S-8apWZkaLHg).

---------
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@FeynmanZhou FeynmanZhou

Labels
enhancement New feature or request
Projects
Notary Project Planning Board
Status: Done
Milestone
1.2.0
Development

Successfully merging a pull request may close this issue.

doc: add Notation CLI Error Handling and Message Guideline FeynmanZhou/notation
2 participants
@FeynmanZhou @yizha1