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

doc: improve error output in notation key and notation cert #606

Merged
merged 10 commits into from
May 19, 2023

Conversation

FeynmanZhou
Copy link
Member

Update CLI spec to improve error output in notation key and notation cert and resolve the UX problem in #604

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@codecov-commenter
Copy link

codecov-commenter commented Mar 30, 2023

Codecov Report

Merging #606 (725da57) into main (0ec3b3d) will decrease coverage by 1.37%.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@            Coverage Diff             @@
##             main     #606      +/-   ##
==========================================
- Coverage   34.43%   33.06%   -1.37%     
==========================================
  Files          32       32              
  Lines        1844     2011     +167     
==========================================
+ Hits          635      665      +30     
- Misses       1188     1324     +136     
- Partials       21       22       +1     

see 12 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

specs/commandline/key.md Outdated Show resolved Hide resolved
specs/commandline/key.md Outdated Show resolved Hide resolved
specs/commandline/certificate.md Outdated Show resolved Hide resolved
specs/commandline/key.md Outdated Show resolved Hide resolved
specs/commandline/key.md Outdated Show resolved Hide resolved
Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

Some comments left.

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
specs/commandline/key.md Outdated Show resolved Hide resolved
specs/commandline/key.md Outdated Show resolved Hide resolved
specs/commandline/key.md Outdated Show resolved Hide resolved
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
specs/commandline/key.md Outdated Show resolved Hide resolved
specs/commandline/key.md Outdated Show resolved Hide resolved
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
specs/commandline/key.md Outdated Show resolved Hide resolved
specs/commandline/key.md Outdated Show resolved Hide resolved
@shizhMSFT shizhMSFT changed the title Doc: Improve error output in notation key and notation cert doc: improve error output in notation key and notation cert Apr 20, 2023
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Copy link
Contributor

@patrickzheng200 patrickzheng200 left a comment

Choose a reason for hiding this comment

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

LGTM

yizha1
yizha1 previously approved these changes Apr 21, 2023
Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

LGTM but IANAM

priteshbandi
priteshbandi previously approved these changes Apr 21, 2023
Copy link
Contributor

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

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

LGTM

Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou
Copy link
Member Author

Hi @notaryproject/notaryproject-notation-maintainers , I resolved @JeyJeyGao 's comment. Could you pls review it again? Thanks

@FeynmanZhou FeynmanZhou requested a review from yizha1 April 27, 2023 12:04
Copy link
Contributor

@patrickzheng200 patrickzheng200 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@JeyJeyGao JeyJeyGao left a comment

Choose a reason for hiding this comment

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

LGTM

@yizha1 yizha1 linked an issue May 19, 2023 that may be closed by this pull request
@FeynmanZhou
Copy link
Member Author

@priteshbandi There was a small update after your last approval. Could you re-approve this PR? Thanks!

Copy link
Contributor

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

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

LGTM

@priteshbandi priteshbandi merged commit 22cf1e9 into notaryproject:main May 19, 2023
priteshbandi pushed a commit that referenced this pull request May 25, 2023
This PR is based on spec changes in here:
#606.

---------

Signed-off-by: Patrick Zheng <patrickzheng@microsoft.com>
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.

Notation delete returns confusing message
9 participants