Pbm 1600 add confirmation prompt description#364
Pbm 1600 add confirmation prompt description#364radoslawszulgo merged 6 commits intoRelease-notes-2.14.0from
Conversation
…running a restore command Co-authored-by: Copilot <copilot@github.com>
There was a problem hiding this comment.
Pull request overview
Updates PBM documentation to reflect the new confirmation prompt behavior for restore/delete flows and documents the -y/--yes bypass flag, plus a small repo hygiene update.
Changes:
- Add “Version added: 2.14.0” callouts describing the new restore confirmation prompt and the
-y/--yesbypass across restore/PITR docs. - Update deletion/cleanup docs to mention confirmation prompts and
-y/--yes. - Document the
-y/--yesflag in thepbm restorereference and ignorevenv/in.gitignore.
Reviewed changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/usage/restore.md | Adds 2.14.0 confirmation prompt note to logical restore flows. |
| docs/usage/restore-selective.md | Notes confirmation prompt behavior for selective restore scenarios. |
| docs/usage/restore-physical.md | Adds 2.14.0 confirmation prompt note for physical restore. |
| docs/usage/restore-incremental.md | Adds 2.14.0 confirmation prompt note for incremental restore. |
| docs/usage/restore-external.md | Adds 2.14.0 confirmation prompt note to external restore workflows. |
| docs/usage/restore-external-agent-restart.md | Adds 2.14.0 confirmation prompt note for restart-at-copyReady workflow. |
| docs/usage/pitr-tutorial.md | Adds 2.14.0 confirmation prompt note for PITR tutorial restore command. |
| docs/usage/pitr-selective.md | Restructures selective PITR page and adds 2.14.0 confirmation prompt note. |
| docs/usage/pitr-physical.md | Adds 2.14.0 confirmation prompt note for physical PITR restore. |
| docs/usage/delete-backup.md | Updates cleanup/delete sections to mention confirmation prompts and bypass flag. |
| docs/reference/pbm-commands.md | Adds -y/--yes to pbm restore flags table. |
| docs/features/restore-remapping.md | Adds 2.14.0 confirmation prompt note near restore remapping usage. |
| docs/features/physical.md | Adds 2.14.0 confirmation prompt note in partial restore section. |
| docs/features/multi-storage.md | Adds 2.14.0 confirmation prompt note in external-storage restore section. |
| .gitignore | Ignores venv/. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 14 out of 15 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| During the cleanup, you see the backups and oplog slices to be deleted and are asked to confirm the action (to bypass it, add the `-y` or `--yes` flag): | ||
|
|
||
| ```bash | ||
| pbm cleanup --older-than=`%Y-%M-%D --yes | ||
| pbm cleanup --older-than="2023-04-20" | ||
| ``` |
There was a problem hiding this comment.
The sentence says you can bypass the confirmation by adding -y/--yes, but the example that follows doesn’t include either flag. Either include a -y/--yes example (or add a second example) or adjust the sentence so it’s clear the shown command is the interactive (default) behavior.
| pbm-restore --time=<timestamp> --base-snapshot <backup-name> | ||
| ``` | ||
|
|
||
| !!! admonition "Version added: [2.14.0](../release-notes/2.14.0.md)" | ||
| Before a restore operation is executed you have to confirm the action (to bypass it, add the `-y` or `--yes` flag). |
There was a problem hiding this comment.
The command example uses pbm-restore, but elsewhere the CLI is documented as pbm restore. If pbm-restore isn’t an actual binary, this should be corrected to avoid users copying a non-existent command.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…y cleanup confirmation Co-authored-by: Copilot <copilot@github.com>
The sample output is in the release notes.