Skip to content

docs: add e2e examples for oras-go #561

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
Merged
merged 10 commits into from
Aug 4, 2023
Merged

docs: add e2e examples for oras-go #561

merged 10 commits into from
Aug 4, 2023

Conversation

wangxiaoxuan273
Copy link
Contributor

@wangxiaoxuan273 wangxiaoxuan273 commented Aug 1, 2023 •
edited
Loading

Resolves #434

current godoc display:
image

@codecov-commenter
Copy link

codecov-commenter commented Aug 1, 2023 •
edited
Loading

Codecov Report

Merging #561 (c7cde4f) into main (6ec43e7) will increase coverage by 0.10%.
Report is 2 commits behind head on main.
The diff coverage is 90.32%.

❗ 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     #561      +/-   ##
==========================================
+ Coverage   74.19%   74.30%   +0.10%     
==========================================
  Files          50       51       +1     
  Lines        4732     4775      +43     
==========================================
+ Hits         3511     3548      +37     
- Misses        896      900       +4     
- Partials      325      327       +2
Files Changed Coverage Δ
content/oci/oci.go 75.28% <ø> (ø)
content/oci/readonlyoci.go 73.52% <ø> (ø)
content/oci/readonlystorage.go 87.50% <ø> (ø)
content/oci/storage.go 61.64% <ø> (ø)
registry/reference.go 68.42% <ø> (ø)
registry/remote/referrers.go 91.95% <ø> (ø)
registry/remote/url.go 100.00% <ø> (ø)
registry/repository.go 66.66% <ø> (ø)
registry/remote/registry.go 67.67% <75.00%> (+0.26%) ⬆️
registry/remote/repository.go 70.89% <88.88%> (-0.01%) ⬇️
... and 1 more

Wwwsylvia
Wwwsylvia requested changes Aug 1, 2023
View reviewed changes
Copy link
Member

@Wwwsylvia Wwwsylvia left a comment

Choose a reason for hiding this comment

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

Is it possible to put all these examples into something like example_test.go? It looks like godoc now supports this way.

@wangxiaoxuan273 wangxiaoxuan273 marked this pull request as draft August 1, 2023 09:28
shizhMSFT
shizhMSFT reviewed Aug 1, 2023
View reviewed changes
@Wwwsylvia
Copy link
Member

Should we mention the E2E examples in the README?

@wangxiaoxuan273
docs: add e2e examples for oras-go
34b2b91 
Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
@wangxiaoxuan273
changed Pack
a88093d 
Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
@wangxiaoxuan273
added license statement
0b244c9 
Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
@wangxiaoxuan273
removed the credentials example
428b3be 
Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
@wangxiaoxuan273
refactored the code
04ab046 
Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
@wangxiaoxuan273 wangxiaoxuan273 marked this pull request as ready for review August 2, 2023 09:42
Wwwsylvia
Wwwsylvia reviewed Aug 2, 2023
View reviewed changes
Wwwsylvia
Wwwsylvia reviewed Aug 2, 2023
View reviewed changes
Copy link
Member

@Wwwsylvia Wwwsylvia left a comment

Choose a reason for hiding this comment

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

How about we rename the original example_test.go to example_copy_test.go and call this file example_test.go?

@wangxiaoxuan273
resolved the comments
e10b179 
Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
@wangxiaoxuan273
Copy link
Contributor Author

How about we rename the original example_test.go to example_copy_test.go and call this file example_test.go?

changed accordingly.

@wangxiaoxuan273
refined display
270790f 
Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
Wwwsylvia
Wwwsylvia reviewed Aug 3, 2023
View reviewed changes
@wangxiaoxuan273
refined the doc comments
38b5211 
Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
Wwwsylvia
Wwwsylvia requested changes Aug 3, 2023
View reviewed changes
@wangxiaoxuan273
fixed my error
bc6e391 
Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
@wangxiaoxuan273
one more small change
c7cde4f 
Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>
Wwwsylvia
Wwwsylvia approved these changes Aug 4, 2023
View reviewed changes
Copy link
Member

@Wwwsylvia Wwwsylvia left a comment

Choose a reason for hiding this comment

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

LGTM

@Wwwsylvia Wwwsylvia merged commit d5cefe9 into oras-project:main Aug 4, 2023
@wangxiaoxuan273 wangxiaoxuan273 deleted the examples branch August 7, 2023 03:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shizhMSFT shizhMSFT shizhMSFT left review comments

@Wwwsylvia Wwwsylvia Wwwsylvia approved these changes

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

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

+1 more reviewer

@TerryHowe TerryHowe TerryHowe left review comments

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create E2E examples
5 participants
@wangxiaoxuan273 @codecov-commenter @Wwwsylvia @TerryHowe @shizhMSFT