Skip to content

chore(ux): improve error message when attaching without subject artifact #1430

Merged
qweeah merged 23 commits into
oras-project:mainfrom
qweeah:improve-attach
Jul 4, 2024
Merged

chore(ux): improve error message when attaching without subject artifact #1430
qweeah merged 23 commits into
oras-project:mainfrom
qweeah:improve-attach

Conversation

@qweeah

@qweeah qweeah commented Jun 24, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

What this PR does / why we need it:
This PR improves error message when the oras attach is run with only one argument, which might be an invalid artifact subject reference or mistakenly used as a to-be-uploaded file path.

Before

> oras attach --artifact-type test/example $ARTIFACT ./layers 
Error: neither file nor annotation provided in the command
Usage: oras attach [flags] --artifact-type=<type> <name>{:<tag>|@<digest>} <file>[:<layer_media_type>] [...]
To attach to an existing artifact, please provide files via argument or annotations via flag "--annotation". Run "oras attach -h" for more options and examples

After

> oras attach --artifact-type test/example $ARTIFACT ./layers 
Error: "./layers": no tag or digest specified
Usage: oras attach [flags] --artifact-type=<type> <name>{:<tag>|@<digest>} <file>[:<layer_media_type>] [...]
Have you specified an artifact reference to attach to? Please specify a reference in the form of "<name>:<tag>" or "<name>@<digest>". Run "oras attach -h" for more options and examples

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1424, #1404

Please check the following list:

  • Does the affected code have corresponding tests, e.g. unit test, E2E test?
  • Does this change require a documentation update?
  • Does this introduce breaking changes that would require an announcement or bumping the major version?
  • Do all new files have an appropriate license header?

qweeah added 7 commits June 21, 2024 10:33
@qweeah
chore(ux): improve error message when attaching without subject artifact
0bdccef 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
code clean
54d5edf 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
Merge branch 'main' into improve-attach
2cd440d
@qweeah
reword
e7ec3ee 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
refactor: append subject artifact missing recommendation for
9a56b57 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
Merge branch 'main' into improve-attach
bcbcb3e
@qweeah
rephrase prompt for missing subject artifact reference
ce71ca3 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@codecov

codecov Bot commented Jun 24, 2024 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.41%. Comparing base (e7ffb65) to head (e1163c7).

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #1430      +/-   ##
==========================================
+ Coverage   85.38%   85.41%   +0.02%     
==========================================
  Files         108      108              
  Lines        3818     3825       +7     
==========================================
+ Hits         3260     3267       +7     
- Misses        333      334       +1     
+ Partials      225      224       -1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

qweeah added 3 commits June 24, 2024 00:54
@qweeah
test(e2e): add tests
0c1c034 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
Merge remote-tracking branch 'upstream/main' into improve-attach
356af80
@qweeah
increase coverage
1170818 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah qweeah marked this pull request as ready for review June 24, 2024 01:06
@wangxiaoxuan273

wangxiaoxuan273 commented Jun 24, 2024

Copy link
Copy Markdown
Contributor

LGTM but I'm not a maintainer

TerryHowe
TerryHowe reviewed Jun 25, 2024
View reviewed changes
Comment thread cmd/oras/internal/errors/errors.go Outdated
@qweeah
use iota instead
b00fb00 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
TerryHowe
TerryHowe approved these changes Jun 25, 2024
View reviewed changes

@TerryHowe TerryHowe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/lgtm

shizhMSFT
shizhMSFT requested changes Jun 26, 2024
View reviewed changes
Comment thread cmd/oras/internal/errors/errors.go
Comment thread cmd/oras/internal/errors/errors.go Outdated
Comment thread cmd/oras/internal/errors/errors.go Outdated
Comment thread cmd/oras/internal/errors/errors.go Outdated
Comment thread cmd/oras/internal/errors/errors.go Outdated
Comment thread cmd/oras/internal/errors/errors.go Outdated
Comment thread cmd/oras/root/attach.go Outdated
Comment thread cmd/oras/root/attach.go Outdated
FeynmanZhou
FeynmanZhou reviewed Jun 27, 2024
View reviewed changes

@FeynmanZhou FeynmanZhou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just one suggested error message for this case

qweeah added 5 commits June 28, 2024 08:14
@qweeah
resolve comments
7ef6de4 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
Merge branch 'main' into improve-attach
7fa2b87
@qweeah
resolve comments
e2c55fe 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
resolve comments
ac1db75 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
fix e2e
3f7d52c 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
shizhMSFT
shizhMSFT approved these changes Jun 28, 2024
View reviewed changes

@shizhMSFT shizhMSFT left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM with suggestions

Comment thread cmd/oras/root/attach.go Outdated
qweeah added 3 commits June 28, 2024 10:34
@qweeah
remove unnecessary commment
e3e5212 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
@qweeah
Merge remote-tracking branch 'upstream/main' into improve-attach
fe412f6
@qweeah
add usage hint
de8ccca 
Signed-off-by: Billy Zha <jinzha1@microsoft.com>
FeynmanZhou
FeynmanZhou approved these changes Jul 4, 2024
View reviewed changes

@FeynmanZhou FeynmanZhou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@qweeah qweeah merged commit a4a4b33 into oras-project:main Jul 4, 2024
@qweeah qweeah mentioned this pull request Dec 9, 2024
Merged
@Wwwsylvia Wwwsylvia mentioned this pull request Sep 3, 2025
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TerryHowe TerryHowe TerryHowe approved these changes

@shizhMSFT shizhMSFT shizhMSFT approved these changes

@FeynmanZhou FeynmanZhou FeynmanZhou approved these changes

@sajayantony sajayantony Awaiting requested review from sajayantony sajayantony is a code owner

@SteveLasker SteveLasker Awaiting requested review from SteveLasker

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

improve error message of oras attach when subject artifact is not specified

5 participants

@qweeah @wangxiaoxuan273 @TerryHowe @shizhMSFT @FeynmanZhou