chore: improving error log for `oras push` and `oras attach` when the annotation file is invalid #1026

1Shubham7 · 2023-07-19T06:23:18Z

What this PR does / why we need it:
If a malformed JSON file is provided via --annotation-file flag, oras used to output
Error: json: cannot unmarshal string into Go value of type map[string]string

PR to improve this to

 error loading manifest annotations from file annotations.json: [Error]. refer to the document at https://oras.land/docs/how_to_guides/manifest_annotations

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 #1021

screen shot of the final version

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?

cmd/oras/internal/option/packer.go

qweeah · 2023-07-20T04:22:17Z

@1Shubham7 Can you sign the commits via following https://github.com/oras-project/oras/pull/1026/checks?check_run_id=15187109754

1Shubham7 · 2023-07-20T05:23:07Z

figured it out, it should be fine now. @qweeah can you check it out now.

Signed-off-by: Shubham Singh <shubhammahar1306@gmail.com>

Signed-off-by: Sajay Antony <sajaya@microsoft.com> Signed-off-by: Shubham Singh <shubhammahar1306@gmail.com>

Signed-off-by: Shubham Singh <shubhammahar1306@gmail.com>

1Shubham7 · 2023-07-22T08:16:41Z

@qweeah Please have a look at it now.

codecov-commenter · 2023-07-22T10:43:13Z

Codecov Report

Merging #1026 (addd92f) into main (9260209) will increase coverage by 0.07%.
The diff coverage is 100.00%.

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##             main    #1026      +/-   ##
==========================================
+ Coverage   81.21%   81.29%   +0.07%     
==========================================
  Files          57       57              
  Lines        2907     2908       +1     
==========================================
+ Hits         2361     2364       +3     
+ Misses        373      371       -2     
  Partials      173      173

Impacted Files	Coverage Δ
cmd/oras/internal/option/packer.go	`90.76% <100.00%> (+0.14%)`	⬆️

... and 1 file with indirect coverage changes

fix: move stale into .github/workflows (oras-project#1031)

1Shubham7 · 2023-07-23T16:59:14Z

removing "," because of this.

Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

1Shubham7 · 2023-07-23T17:07:49Z

cmd/oras/internal/option/packer.go

Co-authored-by: Billy Zha <qweeah@gmail.com> Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

1Shubham7 · 2023-07-24T15:41:20Z

Maintainers, I am seeing another issue, some errors end with a period (".") while some don't. I had a discussion with @qweeah . Making commits to deal with this.

Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

cmd/oras/internal/option/packer.go

Co-authored-by: Billy Zha <qweeah@gmail.com> Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

1Shubham7 · 2023-07-24T16:26:49Z

it has multiple errors @qweeah . changing it.

Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

1Shubham7 · 2023-07-24T16:51:14Z

@qweeah please have a look now. I think its completed.

qweeah · 2023-07-25T11:39:03Z

@toddysm Can you help review and confirm the UX in the screen shot? Thanks cc @FeynmanZhou

qweeah

LGTM

… annotation file is invalid (oras-project#1026) Signed-off-by: Shubham Singh <shubhammahar1306@gmail.com>

1Shubham7 requested review from sajayantony, shizhMSFT, SteveLasker, qweeah and TerryHowe as code owners July 19, 2023 06:23

1Shubham7 marked this pull request as draft July 19, 2023 06:23

TerryHowe reviewed Jul 19, 2023

View reviewed changes

cmd/oras/internal/option/packer.go Outdated Show resolved Hide resolved

qweeah changed the title ~~[feat] : improving error log for oras push and oras attach when the annotation file is invalid~~ feat: improving error log for oras push and oras attach when the annotation file is invalid Jul 19, 2023

qweeah reviewed Jul 19, 2023

View reviewed changes

cmd/oras/internal/option/packer.go Outdated Show resolved Hide resolved

1Shubham7 marked this pull request as ready for review July 20, 2023 01:28

1Shubham7 force-pushed the main branch from 590c313 to 5f1d6e1 Compare July 20, 2023 05:22

1Shubham7 and others added 4 commits July 22, 2023 12:49

wrapped the returned error with filepath and adding link

2de9ec8

Signed-off-by: Shubham Singh <shubhammahar1306@gmail.com>

adding the changes as per billy's review

2a28f92

Signed-off-by: Shubham Singh <shubhammahar1306@gmail.com>

workflow: add github stale action (oras-project#1024)

b816bf3

Signed-off-by: Sajay Antony <sajaya@microsoft.com> Signed-off-by: Shubham Singh <shubhammahar1306@gmail.com>

'newline in string' error resolve

c0f90ad

Signed-off-by: Shubham Singh <shubhammahar1306@gmail.com>

1Shubham7 force-pushed the main branch from 7aa9824 to c0f90ad Compare July 22, 2023 07:19

Merge branch 'main' into main

5f0e187

Merge pull request #3 from oras-project/main

6e42dda

fix: move stale into .github/workflows (oras-project#1031)

to prevent ".,"

addd92f

Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

qweeah reviewed Jul 24, 2023

View reviewed changes

cmd/oras/internal/option/packer.go Outdated Show resolved Hide resolved

accepting changes from @qweaeh

ee4ebed

Co-authored-by: Billy Zha <qweeah@gmail.com> Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

addressing the issue of "."

9031066

Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

qweeah reviewed Jul 24, 2023

View reviewed changes

cmd/oras/internal/option/packer.go Outdated Show resolved Hide resolved

accepting the changes from @qweaeh

d2f64c2

Co-authored-by: Billy Zha <qweeah@gmail.com> Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

1Shubham7 added 2 commits July 24, 2023 22:19

issue solved - checks for "." and adds "." if not present

07bfd6e

Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

removed extra gap

0df604f

Signed-off-by: Shubham Singh <116020663+1Shubham7@users.noreply.github.com>

qweeah approved these changes Jul 25, 2023

View reviewed changes

sajayantony approved these changes Jul 25, 2023

View reviewed changes

qweeah changed the title ~~feat: improving error log for oras push and oras attach when the annotation file is invalid~~ chore: improving error log for oras push and oras attach when the annotation file is invalid Jul 26, 2023

qweeah added the ux User experience related label Jul 26, 2023

Merge branch 'main' into main

bdc38a8

qweeah merged commit 0b6651a into oras-project:main Jul 27, 2023

qweeah mentioned this pull request Jul 28, 2023

add document links to error messages consistently #1039

Open

shizhMSFT pushed a commit to shizhMSFT/oras that referenced this pull request Aug 3, 2023

chore: improving error log for oras push and oras attach when the…

a45a74a

… annotation file is invalid (oras-project#1026) Signed-off-by: Shubham Singh <shubhammahar1306@gmail.com>

ZhongRuoyu mentioned this pull request Aug 7, 2023

oras 1.0.1 Homebrew/homebrew-core#138923

Merged

This was referenced Aug 24, 2023

bump: tag and release ORAS CLI v1.1.0-rc.2 #1076

Closed

bump: tag and release ORAS CLI v1.1.0-rc.2 #1078

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: improving error log for `oras push` and `oras attach` when the annotation file is invalid #1026

chore: improving error log for `oras push` and `oras attach` when the annotation file is invalid #1026

1Shubham7 commented Jul 19, 2023 •

edited

Loading

qweeah commented Jul 20, 2023

1Shubham7 commented Jul 20, 2023 •

edited

Loading

1Shubham7 commented Jul 22, 2023

codecov-commenter commented Jul 22, 2023 •

edited

Loading

1Shubham7 commented Jul 23, 2023

1Shubham7 commented Jul 23, 2023

1Shubham7 commented Jul 24, 2023

1Shubham7 commented Jul 24, 2023 •

edited

Loading

1Shubham7 commented Jul 24, 2023

qweeah commented Jul 25, 2023

qweeah left a comment

chore: improving error log for oras push and oras attach when the annotation file is invalid #1026

chore: improving error log for oras push and oras attach when the annotation file is invalid #1026

Conversation

1Shubham7 commented Jul 19, 2023 • edited Loading

qweeah commented Jul 20, 2023

1Shubham7 commented Jul 20, 2023 • edited Loading

1Shubham7 commented Jul 22, 2023

codecov-commenter commented Jul 22, 2023 • edited Loading

Codecov Report

1Shubham7 commented Jul 23, 2023

1Shubham7 commented Jul 23, 2023

1Shubham7 commented Jul 24, 2023

1Shubham7 commented Jul 24, 2023 • edited Loading

1Shubham7 commented Jul 24, 2023

qweeah commented Jul 25, 2023

qweeah left a comment

Choose a reason for hiding this comment

chore: improving error log for `oras push` and `oras attach` when the annotation file is invalid #1026

chore: improving error log for `oras push` and `oras attach` when the annotation file is invalid #1026

1Shubham7 commented Jul 19, 2023 •

edited

Loading

1Shubham7 commented Jul 20, 2023 •

edited

Loading

codecov-commenter commented Jul 22, 2023 •

edited

Loading

1Shubham7 commented Jul 24, 2023 •

edited

Loading