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 (spec): add error message guideline #1163

Merged
merged 52 commits into from
Feb 23, 2024
Merged
Changes from 1 commit
Commits
Show all changes
52 commits
Select commit Hold shift + click to select a range
aa34c23
doc: add ORAS CLI proposal doc
FeynmanZhou Jan 10, 2023
5e05838
doc: add ORAS CLI proposal doc
FeynmanZhou Jan 10, 2023
cce1f66
doc: update the compatibility mode proposal
FeynmanZhou Jan 10, 2023
0066516
update compatibility doc
FeynmanZhou Jan 28, 2023
4013c48
Merge branch 'main' into main
FeynmanZhou Jan 28, 2023
49a20b0
update compatibility doc to resolve Billy's comments
FeynmanZhou Jan 29, 2023
cb5e7bc
Merge branch 'main' of https://github.com/FeynmanZhou/oras
FeynmanZhou Jan 29, 2023
9addaa3
update the compatibility doc to resolve Shiwei's comments
FeynmanZhou Jan 30, 2023
e4d1922
update the compatibility doc to resolve Shiwei's comments
FeynmanZhou Jan 30, 2023
506ec41
Merge branch 'main' into main
FeynmanZhou Jan 30, 2023
0c5d128
Merge branch 'main' of https://github.com/FeynmanZhou/oras; branch 'm…
FeynmanZhou Mar 6, 2023
c5bc0bf
fix broken logo link
FeynmanZhou Apr 27, 2023
eb2a1ae
Merge branch 'main' of https://github.com/oras-project/oras
FeynmanZhou Aug 21, 2023
e65a543
Merge branch 'main' of https://github.com/oras-project/oras
FeynmanZhou Nov 2, 2023
0ec0703
add error handling guide
FeynmanZhou Nov 2, 2023
4b63f4a
update error message examples
FeynmanZhou Nov 10, 2023
76db991
update error message examples
FeynmanZhou Nov 10, 2023
20b2084
Merge branch 'main' of https://github.com/oras-project/oras into erro…
FeynmanZhou Nov 10, 2023
39ff6ae
update error message examples
FeynmanZhou Nov 10, 2023
95ec9cb
resolve comments
FeynmanZhou Nov 15, 2023
16e86cf
resolve comments
FeynmanZhou Nov 15, 2023
764b9bb
resolve comments and update examples
FeynmanZhou Nov 17, 2023
68c8907
update cli error guideline
FeynmanZhou Nov 29, 2023
c74a6d3
refine CLI error guideline
FeynmanZhou Nov 29, 2023
3510594
refine examples
FeynmanZhou Dec 5, 2023
1792ab0
update cli guideline
FeynmanZhou Dec 11, 2023
b4f8c26
resolve comments
FeynmanZhou Dec 11, 2023
7adf1aa
update CLI error guideline
FeynmanZhou Dec 13, 2023
5ac34af
resolve comments
FeynmanZhou Dec 18, 2023
6669a4e
resolve comments
FeynmanZhou Dec 18, 2023
5287047
add more examples
FeynmanZhou Dec 20, 2023
5e31ce2
resolve comments and add more examples
FeynmanZhou Dec 22, 2023
d960843
Merge branch 'main' of https://github.com/oras-project/oras into erro…
FeynmanZhou Dec 22, 2023
7dccd63
resolve comments and add more examples
FeynmanZhou Dec 22, 2023
9d25f26
Merge branch 'main' into error-guide
qweeah Dec 25, 2023
1526f87
resolve comments and refine error guideline
FeynmanZhou Dec 25, 2023
4b36290
Merge branch 'main' of https://github.com/oras-project/oras into erro…
FeynmanZhou Dec 25, 2023
2c95904
Merge branch 'error-guide' of https://github.com/FeynmanZhou/oras int…
FeynmanZhou Dec 25, 2023
60f889e
resolve comments
FeynmanZhou Dec 25, 2023
7915e64
resolve comments
FeynmanZhou Dec 26, 2023
193ac35
resolve comments and refine spec
FeynmanZhou Jan 2, 2024
15eb3cc
add two examples and one suggestion
FeynmanZhou Jan 2, 2024
c423335
add two examples and one suggestion
FeynmanZhou Jan 2, 2024
889bb38
Merge branch 'main' of https://github.com/oras-project/oras into erro…
FeynmanZhou Jan 2, 2024
0f75e08
resolve comments and refine spec
FeynmanZhou Jan 2, 2024
4ce6b05
Merge branch 'main' of https://github.com/oras-project/oras into erro…
FeynmanZhou Jan 4, 2024
0de8d59
resolve comments
FeynmanZhou Jan 4, 2024
aaeb6bb
resolve comments
FeynmanZhou Jan 9, 2024
1a575b8
Merge branch 'main' of https://github.com/oras-project/oras into erro…
FeynmanZhou Jan 9, 2024
d8f921b
resolve comments
FeynmanZhou Jan 9, 2024
5568f2c
Update docs/proposals/error-handling-guideline.md
FeynmanZhou Jan 16, 2024
d338fce
Merge branch 'main' into error-guide
Feb 23, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
resolve comments
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
FeynmanZhou committed Dec 11, 2023
commit b4f8c26de7682d5648f6a2bad082c07524d97e87
2 changes: 1 addition & 1 deletion docs/proposals/error-handling-guideline.md
Original file line number Diff line number Diff line change
@@ -163,7 +163,7 @@ Suggested error message:
$ oras attach --artifact-type sbom/example localhost:5000/sample/images:foobar
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved
Error: no file or annotation provided in the command
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved
Usage: oras attach [flags] --artifact-type=<type> <name>{:<tag>|@<digest>} <file>[:<type>] [...]
FeynmanZhou marked this conversation as resolved.
Show resolved Hide resolved
To attach to an existing artifact, please provide files via argument or annotations via flag. Run "oras attach -h" for more options and examples
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
```

#### Example 7: When pushing files, if the annotation file doesn't match the required format