docs: Improve help message for ws restore command #1659
Conversation
Using this subcommand can easily fail, when user do not know that the tarfile should be a gzip compressed file with one top level directory named 'workspace'.
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1659 +/- ##
=======================================
Coverage 80.64% 80.64%
=======================================
Files 185 185
Lines 6090 6090
Branches 678 678
=======================================
Hits 4911 4911
Misses 1030 1030
Partials 149 149 ☔ View full report in Codecov by Sentry. |
| "gzip compressed file with one top level " | ||
| "directory named 'workspace'" |
There was a problem hiding this comment.
| "gzip compressed file with one top level " | |
| "directory named 'workspace'" | |
| "tarfile generated by the backup CLI command" |
I wouldn't support manually created tarfiles officially, there is a lot more that can go wrong. The purpose of the command is to restore backups done by the CLI itself.
There was a problem hiding this comment.
I'd rather keep it as proposed. I can imagine scenarios where people
1
backup a workpace
2
modify the backup
3
compress the modified backup
4
restore the packed workspace
The CLI can deal with a manually archived workspace folder. This is good and useful. It just lacks documentation here.
There was a problem hiding this comment.
Accepting a custom archive would mean that we also need proper validation in the restore interface to provide a correct error message in case of wrongly packed archives. Instead, I'd propose to add two new CLI functions: pack and unpack. Unpack takes the archive and unpacks it into a target directory. Pack takes the directory and packs it again.
Using this subcommand can easily fail, when user do not know that the tarfile should be a gzip compressed file with one top level directory named 'workspace'.