docs: update the help doc for oras manifest index create
#1650
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
PR Overview
This PR updates the command usage for creating a manifest index to improve clarity on where the index is created and to ensure that positional arguments are ordered before flags.
- Updated the "Use" string in create.go to replace with and include
- Revised examples to reflect the new positional argument order and flag placement
Reviewed Changes
| File | Description |
|---|---|
| cmd/oras/root/manifest/index/create.go | Updates usage string and examples for better clarity and command consistency |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
cmd/oras/root/manifest/index/create.go:59
- [nitpick] Consider clarifying the separation between and in the usage string (e.g. by adding a delimiter) to enhance comprehension of the required positional arguments.
Use: "create [flags] <target>[:<tag[,<tag>][...]] <sources>[{<tag>|<digest>}...]"
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1650 +/- ##
==========================================
- Coverage 84.77% 84.74% -0.04%
==========================================
Files 126 126
Lines 5683 5683
==========================================
- Hits 4818 4816 -2
- Misses 615 617 +2
Partials 250 250 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Wwwsylvia
reviewed
Mar 11, 2025
oras manifest index create
wangxiaoxuan273
approved these changes
Mar 11, 2025
TerryHowe
reviewed
Mar 11, 2025
|
Let's merge this PR first and finish the remaining part in a separate PR. |
Wwwsylvia
approved these changes
Apr 14, 2025
1. Changing <name> to <target> explicitly states where the manifest index will be created. 2. Keeping all positional arguments first improves readability and reduces the risk of users mistaking flags like --oci-layout as having their own positional arguments. Fixes: oras-project#1638 Signed-off-by: Rohan Mishra <315scisyb2020rohanmishra@gmail.com>
6 tasks
FeynmanZhou
pushed a commit
to FeynmanZhou/oras
that referenced
this pull request
May 28, 2025
…ect#1650) Signed-off-by: Rohan Mishra <315scisyb2020rohanmishra@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #1638
What this PR does / why we need it:
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 #
Please check the following list: