Skip to content

Commit c3195ae

Browse files
committed
resolve comments
Signed-off-by: Feynman Zhou <[email protected]>
1 parent 0754050 commit c3195ae

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/proposals/formatted-output.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ oras manifest fetch $REGISTRY/$REPO:$TAG --format json
9898

9999
### Scripting
100100

101-
Alice is a developer who wants to batch operations with ORAS in her Shell script. In order to automate a portion of her workflow, she would like to obtain the image digest from the JSON output objects produced by the `oras push` command and then use shell variables or utilities like [xargs](https://en.wikipedia.org/wiki/Xargs) or to enable an ORAS command to act on the output of another command and perform further steps. In this way, she can chain commands together. For example, she can use `oras attach` to attach an SBOM to the image using its image digest as a argument outputted from `oras push`.
101+
Alice is a developer who wants to batch operations with ORAS in her Shell script. In order to automate a portion of her workflow, she would like to obtain the image digest from the JSON output objects produced by the `oras push` command and then use shell variables or utilities like [xargs](https://en.wikipedia.org/wiki/Xargs) to enable an ORAS command to act on the output of another command and perform further steps. In this way, she can chain commands together. For example, she can use `oras attach` to attach an SBOM to the image using its image digest as a argument outputted from `oras push`.
102102

103103
For example, push an artifact to a registry and generate the artifact reference in the standard output. Then, attach an SBOM to the artifact using the artifact reference (`$REGISTRY/$REPO@$DIGEST`) outputted from the first command. Finally, sign the attached SBOM with another tool against the reference of the SBOM file (`$REGISTRY/$REPO@$DIGEST`) that was obtained in the proceeding step.
104104

@@ -224,7 +224,7 @@ oras push $REGISTRY/$REPO:$TAG sbom.spdx vul-scan.json --format json
224224
Push a folder to a repository and filter out the value of `reference` and `artifactType` of the pushed artifact in the standard output.
225225

226226
```bash
227-
oras push $REGISTRY/$REPO:$TAG /sample-folder --format '{{.Ref}},{{.MediaType}}'
227+
oras push $REGISTRY/$REPO:$TAG sample-folder --format '{{.Ref}}, {{.MediaType}}'
228228
```
229229

230230
```console
@@ -276,7 +276,7 @@ View an artifact's referrers manifest in pretty JSON output. The following field
276276
- `Size`: referrer file size in bytes
277277
- `Digest`: digest of the referrer
278278
- `ArtifactType`: the type of a referrer
279-
- `Annotations`: contains arbitrary metadata for the image manifest
279+
- `Annotations`: contains arbitrary metadata of a referrer
280280

281281
See an example:
282282

@@ -312,7 +312,7 @@ oras discover localhost:5000/hello:v1 --format json
312312
```
313313

314314
> [!NOTE]
315-
> The `--format` flag will replace the existing `--output` flag. The `--output` will be marked as "deprecated" in ORAS v1.2.0 and will be removed in the next release.
315+
> The `--format` flag will replace the existing `--output` flag. The `--output` will be marked as "deprecated" in ORAS v1.2.0 and will be removed in the future releases.
316316
317317
## FAQ
318318

0 commit comments

Comments
 (0)