Skip to content

docs: enrich the CLI design of oras backup and oras restore#1767

Merged
Wwwsylvia merged 22 commits into
oras-project:mainfrom
FeynmanZhou:back-restore
Jul 29, 2025
Merged

docs: enrich the CLI design of oras backup and oras restore#1767
Wwwsylvia merged 22 commits into
oras-project:mainfrom
FeynmanZhou:back-restore

Conversation

@FeynmanZhou

@FeynmanZhou FeynmanZhou commented Jul 3, 2025

Copy link
Copy Markdown
Member

What this PR does / why we need it:

This is a follow up PR of #1610 to enrich the CLI design of oras backup and oras restore. The intention is to bring more clarity to the desired end-to-end user experience and CLI design.

The scenario doc is written in another PR: #1778

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 # #1610

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?

@codecov

codecov Bot commented Jul 3, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.61%. Comparing base (ec22c82) to head (3d51f68).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1767      +/-   ##
==========================================
+ Coverage   85.58%   85.61%   +0.03%     
==========================================
  Files         137      137              
  Lines        6006     6006              
==========================================
+ Hits         5140     5142       +2     
+ Misses        615      613       -2     
  Partials      251      251              

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@shizhMSFT shizhMSFT requested a review from Copilot July 3, 2025 08:33

This comment was marked as outdated.

Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou FeynmanZhou marked this pull request as ready for review July 4, 2025 00:15
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@shizhMSFT shizhMSFT requested a review from Copilot July 4, 2025 02:39

This comment was marked as outdated.

Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>

This comment was marked as outdated.

Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Comment thread docs/proposals/backup-restore.md Outdated
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
@FeynmanZhou FeynmanZhou requested a review from Wwwsylvia July 15, 2025 03:09

@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 with suggestions. We can iterate on the output in future PRs.

Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>

@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.

Note: The comment I have is for both restore and backup.

Comment thread docs/proposals/backup-restore.md
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Comment thread docs/proposals/backup-restore.md

@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

@FeynmanZhou FeynmanZhou requested a review from Wwwsylvia July 18, 2025 06:32

@Wwwsylvia Wwwsylvia 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.

There are some issues with the status output

Comment thread docs/proposals/backup-restore.md Outdated

@Wwwsylvia Wwwsylvia 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.

About tar file existence

Comment thread docs/proposals/backup-restore.md
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md Outdated
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>

@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

@Wwwsylvia Wwwsylvia 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 with suggestions

Comment thread docs/proposals/backup-restore.md Outdated
Comment thread docs/proposals/backup-restore.md

@Wwwsylvia Wwwsylvia 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.

UX

Comment thread docs/proposals/backup-restore.md
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>
Comment thread docs/proposals/backup-restore.md
Comment thread docs/proposals/backup-restore.md
Signed-off-by: Feynman Zhou <feynmanzhou@microsoft.com>

@Wwwsylvia Wwwsylvia 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

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.

5 participants