Skip to content

The flag --exclude-digest-tags was incorrectly spelled in oras repo tags --help #1444

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

The flag --exclude-digest-tags was incorrectly spelled in oras repo tags --help #1444

wants to merge 2 commits into from

Conversation

maelvls
Copy link
Contributor

@maelvls maelvls commented Jul 12, 2024

What this PR does / why we need it:

Using oras 1.2.0+Homebrew, I got confused by the following --help output:

$ oras repo tags --help
Example - Show tags in the target repository with digest-like tags hidden:
  oras repo tags --exclude-digest-tag localhost:5000/hello

When running the example command, I get:

$ oras repo tags --exclude-digest-tag localhost:5000/hello
Error: unknown flag: --exclude-digest-tag

I dug into Oras' source code and found that the actual flag name is --exclude-digest-tags:

oras/cmd/oras/root/repo/tags.go

Line 77 in d06bb81

cmd.Flags().BoolVar(&opts.excludeDigestTag, "exclude-digest-tags", false, "[Preview] exclude all digest-like tags such as 'sha256-aaaa...'")
. This PR fixes the --help output to match the actual flag name.

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? → No
  • Does this introduce breaking changes that would require an announcement or bumping the major version? → No
  • Do all new files have an appropriate license header?

@qweeah
Copy link
Contributor

qweeah commented Jul 12, 2024

Thanks @maelvls for the contribution, could you help fix the DCO following https://github.com/oras-project/oras/pull/1444/checks?check_run_id=27365143300

@codecov Codecov
Copy link

codecov bot commented Jul 12, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.49%. Comparing base (061344b) to head (d91819f).

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1444   +/-   ##
=======================================
  Coverage   85.49%   85.49%           
=======================================
  Files         109      109           
  Lines        3853     3853           
=======================================
  Hits         3294     3294           
  Misses        335      335           
  Partials      224      224

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@qweeah
Copy link
Contributor

qweeah commented Jul 15, 2024

Hi @maelvls, can you help fix the DCO check? It requires you to sign off the commit. You may find detailed git commands in here. Thanks in advance.

@TerryHowe TerryHowe mentioned this pull request Aug 1, 2024
Merged
qweeah
qweeah approved these changes Aug 2, 2024
View reviewed changes
Copy link
Contributor

@qweeah qweeah left a comment

Choose a reason for hiding this comment

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

LGTM

@qweeah qweeah closed this Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qweeah qweeah qweeah approved these changes

@sajayantony sajayantony Awaiting requested review from sajayantony sajayantony is a code owner

@shizhMSFT shizhMSFT Awaiting requested review from shizhMSFT shizhMSFT is a code owner

@SteveLasker SteveLasker Awaiting requested review from SteveLasker SteveLasker is a code owner

@TerryHowe TerryHowe Awaiting requested review from TerryHowe TerryHowe is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@maelvls @qweeah