-
Notifications
You must be signed in to change notification settings - Fork 102
docs: add quick start for oras-go #939
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
Conversation
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #939 +/- ##
=======================================
Coverage 81.69% 81.69%
=======================================
Files 64 64
Lines 6119 6119
=======================================
Hits 4999 4999
Misses 790 790
Partials 330 330 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks nice!
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with a few nits
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a comprehensive quick start guide for oras-go v2. The changes include a new markdown tutorial file demonstrating step-by-step instructions on connecting to a remote repository, showing tags, pushing layers and manifests, fetching and parsing manifests, and copying artifacts to a local OCI layout.
Comments suppressed due to low confidence (1)
docs/tutorial/quickstart.md:329
- The code uses json.Unmarshal but does not import the encoding/json package. Please add 'import "encoding/json"' to ensure proper functionality.
if err := json.Unmarshal(fetchedManifestContent, &manifest); err != nil {
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR introduces a comprehensive quick start tutorial for oras-go v2, aimed at guiding users in managing OCI artifacts through a series of code examples and instructions.
- Adds detailed step-by-step sections for creating a folder, connecting to a remote repository, pushing layers and manifests, fetching content, and copying the artifact locally.
- Provides a complete code snippet at the end for users to reference and run.
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds a comprehensive quick start tutorial for oras-go v2, aimed at helping users understand how to manage OCI artifacts using the package.
- Introduces a step-by-step guide covering folder creation, repository connection with token authentication, listing tags, pushing layers and manifests, as well as fetching and copying artifacts.
- Provides complete example code snippets to illustrate each step in the process.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: Xiaoxuan Wang <xiaoxuanwang@microsoft.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Fixes #816