Support yaml output #241

Standing-Man · 2024-11-03T01:24:20Z

Fixed #240

Support yaml output for the command registry list

bupd · 2024-11-05T14:19:02Z

Every command need to have support for yaml output.

bupd · 2024-11-05T14:38:14Z

cmd/harbor/root/registry/list.go

+			if FormatFlag == "yaml" {
+				utils.PrintPayloadInYAMLFormat(registry)
+				return
+			}


Produce an error message to user when using flags other than json or yaml.

I have finalized the subcommand list for project, registry, and user. I would like to confirm that this is accurate before moving on to support the remaining commands.

Should I use a generic function to unify the output in both YAML and JSON formats?

bupd

@JianMinTang thanks for the contribution. I found some commands still need additional formats. adding formats for those commands would be better.

commands need to be covered are

artifact
- info
- tags (these have issue with output)

❯ ./harbor-dev artifact tags list
INFO[0003] [0xc000695e60]

❯ ./harbor-dev artifact tags list -o yaml
INFO[0002] [0xc000034ba0]

project
- view (also lacks table format)
registry
- info (lacks table format)
repo
- info (also lacks table format)

Standing-Man · 2024-11-13T08:22:58Z

Hi @bupd and @Vad1mo, I am a bit confused about the difference between list and info under the same command. If there is any difference in the information they display, could you clearly explain the distinction between them?

I created a sample, but I think the info subcommand is redundant, or it could display only the name and description fields within the subcommand info.

Maybe the list command is displaying incorrectly, if the user want to list ther repos by the command harbor repo list, we should show every repositories, not just those within a single project. If the user wants to view detailed information about a specific repository, they should use the command harbor repo info to see information about that particular repository.

My suggestion might not be correct, So I am open to receiving your suggestions and guidance on this issue.

bupd · 2024-11-18T11:41:10Z

if the user want to list ther repos by the command harbor repo list, we should show every repositories, not just those within a single project.

./harbor-dev catalog

catalog command can be used if the user needs to list all the repos. instead of repos under a single project.
catalog seems more oci than list.

we still not have catalog command. we sure need one in the future.

bupd · 2024-11-18T11:53:01Z

If the user wants to view detailed information about a specific repository, they should use the command harbor repo info to see information about that particular repository.

harbor repo view <project_name>/<repo_name>

we can rename the repo info to repo view this might be clear than info.

bupd · 2024-11-18T11:59:10Z

SO, @JianMinTang

repo list - will list repos under a single project
catalog - will list all repos
repo view - will show details about a single repo

Signed-off-by: JianMinTang <jmtangcs@gmail.com>

* generate credential name Signed-off-by: bupd <bupdprasanth@gmail.com> * feat: add support for the password-stdin flag in login flow Signed-off-by: karanngi <karann.git@gmail.com> * fix deps - fixes dependencies Signed-off-by: bupd <bupdprasanth@gmail.com> * return stdout for tests Signed-off-by: bupd <bupdprasanth@gmail.com> * update workflow Signed-off-by: bupd <bupdprasanth@gmail.com> --------- Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: karanngi <karann.git@gmail.com> Co-authored-by: karanngi <karann.git@gmail.com> Signed-off-by: JianMinTang <jmtangcs@gmail.com>

print test output to screen Signed-off-by: JianMinTang <jmtangcs@gmail.com>

Signed-off-by: JianMinTang <jmtangcs@gmail.com> Add more detail on repo view Signed-off-by: JianMinTang <jmtangcs@gmail.com> Support table format on registry view Signed-off-by: JianMinTang <jmtangcs@gmail.com> Support table format on project view Signed-off-by: JianMinTang <jmtangcs@gmail.com> Fixed tags list Signed-off-by: JianMinTang <jmtangcs@gmail.com> Support table format and YAML/JSON output on artifact view Signed-off-by: JianMinTang <jmtangcs@gmail.com> Fixed alignment problem Signed-off-by: JianMinTang <jmtangcs@gmail.com> Fixed the code format Signed-off-by: JianMinTang <jmtangcs@gmail.com>

* generate credential name Signed-off-by: bupd <bupdprasanth@gmail.com> * feat: add support for the password-stdin flag in login flow Signed-off-by: karanngi <karann.git@gmail.com> * fix deps - fixes dependencies Signed-off-by: bupd <bupdprasanth@gmail.com> * return stdout for tests Signed-off-by: bupd <bupdprasanth@gmail.com> * update workflow Signed-off-by: bupd <bupdprasanth@gmail.com> --------- Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: karanngi <karann.git@gmail.com> Co-authored-by: karanngi <karann.git@gmail.com> Signed-off-by: JianMinTang <jmtangcs@gmail.com>

print test output to screen Signed-off-by: JianMinTang <jmtangcs@gmail.com>

Signed-off-by: JianMinTang <jmtangcs@gmail.com> Use gofmt to format all code Signed-off-by: JianMinTang <jmtangcs@gmail.com> fix: Support YAML output for additional commands Signed-off-by: JianMinTang <jmtangcs@gmail.com> fix: Implement a generic function to format output Signed-off-by: JianMinTang <jmtangcs@gmail.com> chore: fix the problem about golangci-lint Signed-off-by: JianMinTang <jmtangcs@gmail.com>

Standing-Man · 2024-11-20T02:20:38Z

Hi @bupd, I’ve added the table format and YAML/JSON output to some commands, following your suggestions. Thank you so much for your valuable input!

bupd

.

* Support yaml output for 'registry list' Signed-off-by: JianMinTang <jmtangcs@gmail.com> * Use gofmt to format all code Signed-off-by: JianMinTang <jmtangcs@gmail.com> * fix: Support YAML output for additional commands Signed-off-by: JianMinTang <jmtangcs@gmail.com> * fix: Support YAML format on artiface and repo command Signed-off-by: JianMinTang <jmtangcs@gmail.com> * fix: Implement a generic function to format output Signed-off-by: JianMinTang <jmtangcs@gmail.com> * chore: fix the problem about golangci-lint Signed-off-by: JianMinTang <jmtangcs@gmail.com> * AutoGenerate credential name in login (goharbor#250) * generate credential name Signed-off-by: bupd <bupdprasanth@gmail.com> * feat: add support for the password-stdin flag in login flow Signed-off-by: karanngi <karann.git@gmail.com> * fix deps - fixes dependencies Signed-off-by: bupd <bupdprasanth@gmail.com> * return stdout for tests Signed-off-by: bupd <bupdprasanth@gmail.com> * update workflow Signed-off-by: bupd <bupdprasanth@gmail.com> --------- Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: karanngi <karann.git@gmail.com> Co-authored-by: karanngi <karann.git@gmail.com> Signed-off-by: JianMinTang <jmtangcs@gmail.com> * print test output to screen (goharbor#254) print test output to screen Signed-off-by: JianMinTang <jmtangcs@gmail.com> * Support table format for repo view and add some comments on repo list Signed-off-by: JianMinTang <jmtangcs@gmail.com> Add more detail on repo view Signed-off-by: JianMinTang <jmtangcs@gmail.com> Support table format on registry view Signed-off-by: JianMinTang <jmtangcs@gmail.com> Support table format on project view Signed-off-by: JianMinTang <jmtangcs@gmail.com> Fixed tags list Signed-off-by: JianMinTang <jmtangcs@gmail.com> Support table format and YAML/JSON output on artifact view Signed-off-by: JianMinTang <jmtangcs@gmail.com> Fixed alignment problem Signed-off-by: JianMinTang <jmtangcs@gmail.com> Fixed the code format Signed-off-by: JianMinTang <jmtangcs@gmail.com> * AutoGenerate credential name in login (goharbor#250) * generate credential name Signed-off-by: bupd <bupdprasanth@gmail.com> * feat: add support for the password-stdin flag in login flow Signed-off-by: karanngi <karann.git@gmail.com> * fix deps - fixes dependencies Signed-off-by: bupd <bupdprasanth@gmail.com> * return stdout for tests Signed-off-by: bupd <bupdprasanth@gmail.com> * update workflow Signed-off-by: bupd <bupdprasanth@gmail.com> --------- Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: karanngi <karann.git@gmail.com> Co-authored-by: karanngi <karann.git@gmail.com> Signed-off-by: JianMinTang <jmtangcs@gmail.com> * print test output to screen (goharbor#254) print test output to screen Signed-off-by: JianMinTang <jmtangcs@gmail.com> * Support yaml output for 'registry list' Signed-off-by: JianMinTang <jmtangcs@gmail.com> Use gofmt to format all code Signed-off-by: JianMinTang <jmtangcs@gmail.com> fix: Support YAML output for additional commands Signed-off-by: JianMinTang <jmtangcs@gmail.com> fix: Implement a generic function to format output Signed-off-by: JianMinTang <jmtangcs@gmail.com> chore: fix the problem about golangci-lint Signed-off-by: JianMinTang <jmtangcs@gmail.com> --------- Signed-off-by: JianMinTang <jmtangcs@gmail.com> Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: karanngi <karann.git@gmail.com> Co-authored-by: Prasanth B <89722848+bupd@users.noreply.github.com> Co-authored-by: karanngi <karann.git@gmail.com> Co-authored-by: Vadim Bauer <vb@container-registry.com> Signed-off-by: Patrick Eschenbach <patrickeschenbach96@gmail.com>

bupd suggested changes Nov 5, 2024

View reviewed changes

Standing-Man requested a review from bupd November 8, 2024 04:47

bupd suggested changes Nov 11, 2024

View reviewed changes

Standing-Man force-pushed the bug/JianMinTang/240 branch 3 times, most recently from 948eeba to 8262575 Compare November 20, 2024 01:46

Standing-Man and others added 12 commits November 20, 2024 10:13

Support yaml output for 'registry list'

e484003

Signed-off-by: JianMinTang <jmtangcs@gmail.com>

Use gofmt to format all code

60f6c22

Signed-off-by: JianMinTang <jmtangcs@gmail.com>

fix: Support YAML output for additional commands

693dacc

Signed-off-by: JianMinTang <jmtangcs@gmail.com>

fix: Support YAML format on artiface and repo command

eb2d153

Signed-off-by: JianMinTang <jmtangcs@gmail.com>

fix: Implement a generic function to format output

f50e471

Signed-off-by: JianMinTang <jmtangcs@gmail.com>

chore: fix the problem about golangci-lint

2e2a7bd

Signed-off-by: JianMinTang <jmtangcs@gmail.com>

print test output to screen (goharbor#254)

bc40a42

print test output to screen Signed-off-by: JianMinTang <jmtangcs@gmail.com>

print test output to screen (goharbor#254)

0c5fc1a

print test output to screen Signed-off-by: JianMinTang <jmtangcs@gmail.com>

Standing-Man force-pushed the bug/JianMinTang/240 branch from 8262575 to 92b09c8 Compare November 20, 2024 02:13

Standing-Man requested a review from bupd November 20, 2024 02:31

Merge remote-tracking branch 'harbor-cli/main' into bug/JianMinTang/240

994566d

Vad1mo merged commit c464871 into goharbor:main Nov 26, 2024
5 checks passed

Standing-Man deleted the bug/JianMinTang/240 branch November 27, 2024 01:29

Standing-Man mentioned this pull request Nov 27, 2024

feature: Support YAML output for newly added commands #268

Merged

bupd reviewed Nov 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support yaml output #241

Support yaml output #241

Standing-Man commented Nov 3, 2024

bupd commented Nov 5, 2024

bupd Nov 5, 2024

Standing-Man Nov 6, 2024

Standing-Man Nov 6, 2024

bupd left a comment

Standing-Man commented Nov 13, 2024 •

edited

Loading

bupd commented Nov 18, 2024 •

edited

Loading

bupd commented Nov 18, 2024

bupd commented Nov 18, 2024

Standing-Man commented Nov 20, 2024

bupd left a comment

Support yaml output #241

Support yaml output #241

Conversation

Standing-Man commented Nov 3, 2024

bupd commented Nov 5, 2024

bupd Nov 5, 2024

Choose a reason for hiding this comment

Standing-Man Nov 6, 2024

Choose a reason for hiding this comment

Standing-Man Nov 6, 2024

Choose a reason for hiding this comment

bupd left a comment

Choose a reason for hiding this comment

commands need to be covered are

Standing-Man commented Nov 13, 2024 • edited Loading

bupd commented Nov 18, 2024 • edited Loading

bupd commented Nov 18, 2024

bupd commented Nov 18, 2024

Standing-Man commented Nov 20, 2024

bupd left a comment

Choose a reason for hiding this comment

Standing-Man commented Nov 13, 2024 •

edited

Loading

bupd commented Nov 18, 2024 •

edited

Loading