Skip to content

List backup with several names in interactive mode's command list - #70

Merged
dmccoystephenson merged 1 commit into
mainfrom
feature/interactive-help-multiple-names
Nov 12, 2026
Merged

dmccoystephenson merged 1 commit into
mainfrom
feature/interactive-help-multiple-names

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

  • The command list printed when interactive mode starts, and the one printed by help, now show backup <user/org> [user/org2] ... instead of backup <user/org>. Since Back up each name given to the interactive backup command #68 the command backs up every name it is given, and COMMANDS.md, USER_GUIDE.md and the command's own usage hint already say so; the on-screen list was the only place still suggesting a single name. The other rows are realigned to the wider column.
  • BackupCommandLineRunnerTest gains one test for the start banner and one for the help output (sliced from Available Commands: so the banner cannot satisfy it). The existing help row assertion is updated to the realigned spacing.
  • CHANGELOG.md records the change under [Unreleased] → Fixed.

No documentation file other than CHANGELOG.md needed changing: COMMANDS.md and USER_GUIDE.md already list the multi-name form, and no configuration, flag or endpoint changed. The README GIF (docs/images/gh-backup-interactive.gif) shows the old banner, but it is a dated recording of a real 2026-10-18 run, so it was left as is.

Deferred: #8 (missing LICENSE) still needs the maintainer to choose the license, copyright holder and year.

Test plan

  • mvn test: 227 tests run, 0 failures, 0 errors, 1 skipped (pre-existing)
  • Stash-and-run: with the BackupCommandLineRunner.java change stashed, the two new tests and the updated help test fail (3 failures); with it restored, all 40 BackupCommandLineRunnerTest tests pass
  • CI Build green on the PR head

Closes #69

This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

🤖 Generated with Claude Code


drafted by Claude on behalf of Daniel Stephenson

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric (Copilot reviewer could not be requested: Could not resolve user with login 'copilot'):

  • Scope: PASS — three files: BackupCommandLineRunner.java (the two command lists named in Interactive mode's command list still shows backup taking a single name #69), its test, and the CHANGELOG.md entry. No unrelated churn.
  • Tests-new: PASS — no new public methods; two new tests cover the changed banner and help output.
  • Tests-fix: PASS — with BackupCommandLineRunner.java stashed, testRun_InteractiveMode_StartBannerListsBackupOfSeveralNames, testRun_InteractiveMode_HelpCommandListsBackupOfSeveralNames and testRun_InteractiveMode_HelpCommand fail (3 failures of 40); restored, 40/40 pass. The help test slices the output from Available Commands: so the start banner cannot make it pass.
  • Sibling structure: PASS — no new files; new tests follow the testRun_InteractiveMode_<Scenario> naming and provideInput/stdout() helpers of their neighbours.
  • Sibling renames: PASS — both command lists (banner and help) changed together; all four rows of each realigned to the same 35-character column.
  • Docs: PASS — COMMANDS.md and USER_GUIDE.md already list backup <user/org> [user/org2] ...; CHANGELOG.md [Unreleased] → Fixed updated; CONFIG.md/README.md unaffected (no property, flag or endpoint changed).
  • Issue resolution: PASS — both locations named in Interactive mode's command list still shows backup taking a single name #69 changed and each is covered by a test.
  • CI: PASS — build and docker-build green on the PR head; locally mvn test ran 227 tests, 0 failures, 1 pre-existing skip.
  • Config-doc parity: PASS — no configuration key touched.
  • Command-doc parity: PASS — no new flag, property or endpoint; the interactive command table in COMMANDS.md already matches the new text.
  • Package placement: PASS — no new classes.
  • No credential leakage: PASS — only static help strings changed.

Out-of-diff observation: docs/images/gh-backup-interactive.gif shows the old single-name banner. It is a dated recording of a real 2026-10-18 run, documented as such in README.md, so it is left unedited; a future re-recording would pick up the new text.

Judgment call (non-blocking): the descriptions keep the existing verb "Backup" (noun form) rather than "Back up", to limit the change to what #69 names.

This review was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit 9b87ea1 into main Nov 12, 2026
2 checks passed
@dmccoystephenson
dmccoystephenson deleted the feature/interactive-help-multiple-names branch November 12, 2026 04:04
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.

Interactive mode's command list still shows backup taking a single name

1 participant