oras-project/oras

Add status output to show the command execution result

Opened this issue · 6 comments

FeynmanZhou commented

What is the version of your ORAS CLI

v1.2.0

What would you like to be added?

Suggest adding a standard status output at the end of all oras CLI output to show the final execution result.

It will be much more straightforward for users to understand which resource has been manipulated by ORAS and where it is.

For example, for oras manifest index create:

  • Current output
Fetching  v1-linux-amd64
Fetched   v1-linux-amd64
Fetching  v1-linux-arm64
Fetched   v1-linux-arm64
Packed    edb5bc1f0b5c application/vnd.oci.image.index.v1+json
Pushed    [oci-layout] layout-dir:v1
Digest: sha256:edb5bc1f0b5c21e9321b34e50c92beae739250fb88409056e8719d9759f6b5b4
  • Expected output:
$ oras manifest index create --oci-layout layout-dir:v1 v1-linux-amd64 v1-linux-arm64 --annotation "platform=multi-arch" 

Fetching  v1-linux-amd64
Fetched   v1-linux-amd64
Fetching  v1-linux-arm64
Fetched   v1-linux-arm64
Packed    edb5bc1f0b5c application/vnd.oci.image.index.v1+json
Pushed    [oci-layout] layout-dir:v1
Digest: sha256:edb5bc1f0b5c21e9321b34e50c92beae739250fb88409056e8719d9759f6b5b

An image index has been created and pushed to layout-dir:v1

Why is this needed for ORAS?

Improve usability of ORAS output, make the information much more intuitive to users.

Other client tools like docker has the similar output to show the final execution result.

Are you willing to submit PRs to contribute to this feature?

  • Yes, I am willing to implement it.
Wwwsylvia commented

@FeynmanZhou The format of the current output and the expected output in the description looks identical.

FeynmanZhou commented

@Wwwsylvia Apologize for missing the execution result in the expected output. I have appended to the issue description above.

  • 👍1
Horiodino commented

Hey, I’d be happy to take this on from now if no one else is working on it. Let me know

shizhMSFT commented

It is not categorized as status output. Precisely, it is metadata output in the format of text.

Wwwsylvia commented

Hi @Horiodino , thank you for showing the interests. We are still sorting out the requirement, will keep this thread updated.

  • 👍1
sajayantony commented

Might be better to output "Index" instead of "Image Index"

Updated since the image spec actually does call it Image Index.
If the proposal is to add it to all commands then it would be good to make sure all commands have some structure.
For e.g. {Type} {Action} {performed in} {destination}