Skip to content

docs: update the help doc for --oci-layout-path#1609

Merged
TerryHowe merged 3 commits into
oras-project:mainfrom
Wwwsylvia:update_help
Jan 22, 2025
Merged

docs: update the help doc for --oci-layout-path#1609
TerryHowe merged 3 commits into
oras-project:mainfrom
Wwwsylvia:update_help

Conversation

@Wwwsylvia

@Wwwsylvia Wwwsylvia commented Jan 22, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

What this PR does / why we need it:

  1. Use lowercase letters after feature flags in help docs
  2. Align the help docs for other commands with feature flags
  3. Add E2E tests for the feature flag of --oci-layout-path for core commands

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1607

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?

@Wwwsylvia
use lowercase letters in help docs
90a1b5d 
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
@Wwwsylvia
update other places
e732174 
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
@Wwwsylvia
add e2e
c27a8aa 
Signed-off-by: Lixia (Sylvia) Lei <lixlei@microsoft.com>
@codecov

codecov Bot commented Jan 22, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.30%. Comparing base (ad8c845) to head (c27a8aa).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #1609   +/-   ##
=======================================
  Coverage   84.30%   84.30%           
=======================================
  Files         120      120           
  Lines        5449     5449           
=======================================
  Hits         4594     4594           
  Misses        608      608           
  Partials      247      247

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

@Wwwsylvia

Wwwsylvia commented Jan 22, 2025

Copy link
Copy Markdown
Member Author

oras push -h BEFORE:
image

oras push -h AFTER:
image

shizhMSFT
shizhMSFT approved these changes Jan 22, 2025
View reviewed changes

@shizhMSFT shizhMSFT left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

TerryHowe
TerryHowe approved these changes Jan 22, 2025
View reviewed changes

@TerryHowe TerryHowe left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

/lgtm

@TerryHowe TerryHowe merged commit 13dce59 into oras-project:main Jan 22, 2025
@Wwwsylvia Wwwsylvia mentioned this pull request Feb 25, 2025
Merged
6 tasks
@Wwwsylvia Wwwsylvia mentioned this pull request Sep 3, 2025
Merged
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TerryHowe TerryHowe TerryHowe approved these changes

@shizhMSFT shizhMSFT shizhMSFT approved these changes

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

@SteveLasker SteveLasker Awaiting requested review from SteveLasker

@qweeah qweeah Awaiting requested review from qweeah

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Wwwsylvia @TerryHowe @shizhMSFT