Skip to content
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

feat: Show annotations in default discovery output #1602

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Horiodino
Copy link


What this PR does / why we need it:

This PR introduces a new --format tree-full flag for the oras discover command, as outlined in the ORAS diagnose experience proposal. The flag enables users to control the level of metadata output when discovering artifacts, including detailed annotations. By adding this feature, users will be able to print more granular metadata about the artifacts, which will improve the overall diagnostic and troubleshooting experience.

Which issue(s) this PR fixes *
Fixes #1534

Please check the following list:

  • [❌] Does the affected code have corresponding tests, e.g. unit test, E2E test?
  • [✅] Does this change require a documentation update?
  • [❌] Does this introduce breaking changes that would require an announcement or bumping the major version?
  • [✅] Do all new files have an appropriate license header?

@@ -68,6 +68,11 @@ var (
Name: "text",
Usage: "Print in text format",
}

FormatTypeTreeFull = &FormatType{
Name: "tree-full",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not in love with the name tree-full, but I don't have a better idea.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do like the idea of showing the annotations in the normal tree view.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for changes in direction on this @Horiodino

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's continue the discussion in #1534. We will temporarily hold on this PR until we aligned the user experience. Apologies for blocking you @Horiodino

@shizhMSFT shizhMSFT changed the title added --format tree-full flag feat: add --format tree-full flag Jan 7, 2025
@shizhMSFT shizhMSFT changed the title feat: add --format tree-full flag feat: add --format tree-full flag Jan 7, 2025
@Horiodino Horiodino requested a review from TerryHowe January 8, 2025 11:47
@Horiodino Horiodino requested a review from Wwwsylvia as a code owner January 8, 2025 12:18
@TerryHowe
Copy link
Member

The title of this PR needs to be updated when you get a chance

@Horiodino Horiodino changed the title feat: add --format tree-full flag feat: Show annotations in default discovery output Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a new --format tree-full flag for oras discover
3 participants