New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

docs: add e2e examples for oras-go #561

Merged

Wwwsylvia merged 10 commits into oras-project:main from wangxiaoxuan273:examples

Aug 4, 2023

Contributor

wangxiaoxuan273 commented Aug 1, 2023 •

edited

Loading

Resolves #434

current godoc display:

wangxiaoxuan273 requested review from sajayantony, shizhMSFT, SteveLasker and Wwwsylvia as code owners

August 1, 2023 06:44

wangxiaoxuan273 force-pushed the examples branch from bd17681 to bc68ca8 Compare

August 1, 2023 07:08

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 requested changes

View reviewed changes

Member

Wwwsylvia left a comment

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

pull_image_using_docker_store_test.go Outdated Show resolved Hide resolved

pull_files_from_remote_test.go Outdated Show resolved Hide resolved

wangxiaoxuan273 marked this pull request as draft

August 1, 2023 09:28

shizhMSFT reviewed

View reviewed changes

go.mod Outdated Show resolved Hide resolved

Member

Wwwsylvia commented Aug 2, 2023

Should we mention the E2E examples in the README?

wangxiaoxuan273 added 3 commits

August 2, 2023 09:20


          docs: add e2e examples for oras-go

34b2b91

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>


          changed Pack

a88093d

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>


          added license statement

0b244c9

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

wangxiaoxuan273 force-pushed the examples branch from bc68ca8 to 0b244c9 Compare

August 2, 2023 09:20

wangxiaoxuan273 added 2 commits

August 2, 2023 09:22


          removed the credentials example

428b3be

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>


          refactored the code

04ab046

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

wangxiaoxuan273 marked this pull request as ready for review

August 2, 2023 09:42

wangxiaoxuan273 requested a review from Wwwsylvia

August 2, 2023 11:45

Wwwsylvia reviewed

View reviewed changes

larger_example_test.go Outdated Show resolved Hide resolved

larger_example_test.go Outdated Show resolved Hide resolved

Wwwsylvia reviewed

View reviewed changes

Member

Wwwsylvia left a comment

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


          resolved the comments

e10b179

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

Contributor Author

wangxiaoxuan273 commented Aug 3, 2023

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

changed accordingly.

wangxiaoxuan273 requested a review from Wwwsylvia

August 3, 2023 07:13


          refined display

270790f

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

Wwwsylvia reviewed

View reviewed changes

example_test.go Outdated Show resolved Hide resolved

example_test.go Show resolved Hide resolved

example_copy_test.go Outdated Show resolved Hide resolved


          refined the doc comments

38b5211

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

wangxiaoxuan273 requested a review from Wwwsylvia

August 3, 2023 09:32

Wwwsylvia requested changes

View reviewed changes

example_test.go Outdated Show resolved Hide resolved

wangxiaoxuan273 added 2 commits

August 4, 2023 05:28


          fixed my error

bc6e391

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>


          one more small change

c7cde4f

Signed-off-by: Xiaoxuan Wang <wangxiaoxuan119@gmail.com>

wangxiaoxuan273 requested a review from Wwwsylvia

August 4, 2023 06:11

Wwwsylvia approved these changes

View reviewed changes

Member

Wwwsylvia left a comment

LGTM

Wwwsylvia merged commit d5cefe9 into oras-project:main

wangxiaoxuan273 deleted the examples branch

August 7, 2023 03:25

# for free to join this conversation on GitHub. Already have an account? # to comment

Reviewers

TerryHowe TerryHowe left review comments

shizhMSFT shizhMSFT left review comments

Wwwsylvia Wwwsylvia approved these changes

sajayantony Awaiting requested review from sajayantony sajayantony is a code owner

SteveLasker Awaiting requested review from SteveLasker SteveLasker is a code owner

Labels

None yet