chore: remove reference to wizard mode from recipe upgrade cli docs #733

2025-12-13T04:41:15Z

jade commented

2025-12-13 04:41:15 +00:00

The current CLI help text for recipe upgrade is:

➜  kiwix git:(main) abra recipe upgrade kiwix -h
Upgrade a given <recipe> configuration.

It will update the relevant compose file tags on the local file system.

Some image tags cannot be parsed because they do not follow some sort of
semver-like convention. In this case, all possible tags will be listed and it
is up to the end-user to decide.

The command is interactive and will show a select input which allows you to
make a seclection. Use the "?" key to see more help on navigating this
interface.

You may invoke this command in "wizard" mode and be prompted for input.

Usage:
  abra recipe upgrade <recipe> [flags]

Aliases:
  upgrade, u

Flags:
  -a, --all-tags   list all tags, not just upgrades
  -m, --machine    print machine-readable output
  -x, --major      increase the major part of the version
  -y, --minor      increase the minor part of the version
  -z, --patch      increase the patch part of the version

Global Flags:
  -d, --debug      show debug messages
  -h, --help       help for abra
  -n, --no-input   toggle non-interactive mode
  -o, --offline    prefer offline & filesystem access

The line You may invoke this command in "wizard" mode and be prompted for input. implies that there's a special mode that can be enabled, perhaps with a command line flag. However, there's no flag to enable a wizard mode. Perhaps wizard mode is intended to mean an interactive mode. In which case, that seems to be the default mode, as indicated by the sentence above, with a non interactive mode available with the -n flag.

If my assumptions there are correct, and that there is no wizard mode (there's no other mention of wizard mode that I can see in the code), this line should be removed as I've done here.

Note on testing

This is my first PR, and the tests aren't fully working for me. I get some errors even on the main branch:

(on main)

➜  abra git:(main) make test | grep -B 2 -A 2 FAIL
=== RUN   TestGetTimeoutFromLabel
FATA mkdir /servers: permission denied
FAIL	coopcloud.tech/abra/pkg/app	0.028s
	coopcloud.tech/abra/pkg/autocomplete		coverage: 0.0% of statements
	coopcloud.tech/abra/pkg/catalogue		coverage: 0.0% of statements
--
=== RUN   TestClone
    clone_test.go:19: unable to git clone gitea: pkt-line 3: EOF
--- FAIL: TestClone (4.04s)
=== RUN   TestCancelGitClone

--
=== RUN   TestIsClean
--- PASS: TestIsClean (0.00s)
FAIL
coverage: 16.5% of statements
FAIL	coopcloud.tech/abra/pkg/git	4.055s
=== RUN   TestLoadLocale
--- PASS: TestLoadLocale (0.00s)
--
	coopcloud.tech/abra/pkg/upstream/stack		coverage: 0.0% of statements
	coopcloud.tech/abra/pkg/web		coverage: 0.0% of statements
FAIL
make: *** [Makefile:42: test] Error 1

However, I think I get more errors on this branch. They don't look super related, but perhaps we should let CI take a stab at it:

(on this branch)

➜  abra git:(chore-recipe-upgrade-cli-doc-update) make test | grep -B 2 -A 2 FAIL               
=== RUN   TestGetTimeoutFromLabel
FATA mkdir /servers: permission denied
FAIL	coopcloud.tech/abra/pkg/app	0.025s
	coopcloud.tech/abra/pkg/autocomplete		coverage: 0.0% of statements
	coopcloud.tech/abra/pkg/catalogue		coverage: 0.0% of statements
--
=== RUN   TestReadEnv
    envfile_test.go:47: did not get expected application settings
--- FAIL: TestReadEnv (0.00s)
=== RUN   TestReadAbraShEnvVars
--- PASS: TestReadAbraShEnvVars (0.00s)
--
=== RUN   TestNoOverwriteNonVersionEnvVars
--- PASS: TestNoOverwriteNonVersionEnvVars (0.00s)
FAIL
coverage: 77.1% of statements
FAIL	coopcloud.tech/abra/pkg/envfile	0.022s
=== RUN   TestBoldDirtyDefault
--- PASS: TestBoldDirtyDefault (0.00s)
--
=== RUN   TestClone
    clone_test.go:19: unable to git clone gitea: pkt-line 3: EOF
--- FAIL: TestClone (3.21s)
=== RUN   TestCancelGitClone

--
=== RUN   TestIsClean
--- PASS: TestIsClean (0.00s)
FAIL
coverage: 16.1% of statements
FAIL	coopcloud.tech/abra/pkg/git	3.229s
=== RUN   TestLoadLocale
--- PASS: TestLoadLocale (0.00s)
--
	coopcloud.tech/abra/pkg/upstream/stack		coverage: 0.0% of statements
	coopcloud.tech/abra/pkg/web		coverage: 0.0% of statements
FAIL
make: *** [Makefile:42: test] Error 1

The current CLI help text for `recipe upgrade` is: ``` ➜ kiwix git:(main) abra recipe upgrade kiwix -h Upgrade a given <recipe> configuration. It will update the relevant compose file tags on the local file system. Some image tags cannot be parsed because they do not follow some sort of semver-like convention. In this case, all possible tags will be listed and it is up to the end-user to decide. The command is interactive and will show a select input which allows you to make a seclection. Use the "?" key to see more help on navigating this interface. You may invoke this command in "wizard" mode and be prompted for input. Usage: abra recipe upgrade <recipe> [flags] Aliases: upgrade, u Flags: -a, --all-tags list all tags, not just upgrades -m, --machine print machine-readable output -x, --major increase the major part of the version -y, --minor increase the minor part of the version -z, --patch increase the patch part of the version Global Flags: -d, --debug show debug messages -h, --help help for abra -n, --no-input toggle non-interactive mode -o, --offline prefer offline & filesystem access ``` The line `You may invoke this command in "wizard" mode and be prompted for input.` implies that there's a special mode that can be enabled, perhaps with a command line flag. However, there's no flag to enable a wizard mode. Perhaps wizard mode is intended to mean an interactive mode. In which case, that seems to be the default mode, as indicated by the sentence above, with a non interactive mode available with the `-n` flag. If my assumptions there are correct, and that there is no wizard mode (there's no other mention of wizard mode that I can see in the code), this line should be removed as I've done here. ### Note on testing This is my first PR, and the tests aren't fully working for me. I get some errors even on the main branch: (on main) ``` ➜ abra git:(main) make test | grep -B 2 -A 2 FAIL === RUN TestGetTimeoutFromLabel FATA mkdir /servers: permission denied FAIL coopcloud.tech/abra/pkg/app 0.028s coopcloud.tech/abra/pkg/autocomplete coverage: 0.0% of statements coopcloud.tech/abra/pkg/catalogue coverage: 0.0% of statements -- === RUN TestClone clone_test.go:19: unable to git clone gitea: pkt-line 3: EOF --- FAIL: TestClone (4.04s) === RUN TestCancelGitClone -- === RUN TestIsClean --- PASS: TestIsClean (0.00s) FAIL coverage: 16.5% of statements FAIL coopcloud.tech/abra/pkg/git 4.055s === RUN TestLoadLocale --- PASS: TestLoadLocale (0.00s) -- coopcloud.tech/abra/pkg/upstream/stack coverage: 0.0% of statements coopcloud.tech/abra/pkg/web coverage: 0.0% of statements FAIL make: *** [Makefile:42: test] Error 1 ``` However, I think I get more errors on this branch. They don't look super related, but perhaps we should let CI take a stab at it: (on this branch) ``` ➜ abra git:(chore-recipe-upgrade-cli-doc-update) make test | grep -B 2 -A 2 FAIL === RUN TestGetTimeoutFromLabel FATA mkdir /servers: permission denied FAIL coopcloud.tech/abra/pkg/app 0.025s coopcloud.tech/abra/pkg/autocomplete coverage: 0.0% of statements coopcloud.tech/abra/pkg/catalogue coverage: 0.0% of statements -- === RUN TestReadEnv envfile_test.go:47: did not get expected application settings --- FAIL: TestReadEnv (0.00s) === RUN TestReadAbraShEnvVars --- PASS: TestReadAbraShEnvVars (0.00s) -- === RUN TestNoOverwriteNonVersionEnvVars --- PASS: TestNoOverwriteNonVersionEnvVars (0.00s) FAIL coverage: 77.1% of statements FAIL coopcloud.tech/abra/pkg/envfile 0.022s === RUN TestBoldDirtyDefault --- PASS: TestBoldDirtyDefault (0.00s) -- === RUN TestClone clone_test.go:19: unable to git clone gitea: pkt-line 3: EOF --- FAIL: TestClone (3.21s) === RUN TestCancelGitClone -- === RUN TestIsClean --- PASS: TestIsClean (0.00s) FAIL coverage: 16.1% of statements FAIL coopcloud.tech/abra/pkg/git 3.229s === RUN TestLoadLocale --- PASS: TestLoadLocale (0.00s) -- coopcloud.tech/abra/pkg/upstream/stack coverage: 0.0% of statements coopcloud.tech/abra/pkg/web coverage: 0.0% of statements FAIL make: *** [Makefile:42: test] Error 1 ```

jade added 1 commit 2025-12-13 04:41:16 +00:00

chore: remove reference to wizard mode from recipe upgrade cli docs

continuous-integration/drone/push Build is failing

Details

cc87d5b3da

decentral1se approved these changes 2025-12-14 15:02:31 +00:00

decentral1se left a comment

LGTM, thanks for this!

I can confirm that make test is failing on my side also. Also, I've just noticed the nightly CI is not even running 🤔 I will take a look at this now... thanks for the heads up!

LGTM, thanks for this! I can confirm that `make test` is failing on my side also. Also, I've just noticed the nightly CI is not even running 🤔 I will take a look at this now... thanks for the heads up!

decentral1se merged commit cc87d5b3da into main

2025-12-14 15:02:38 +00:00

decentral1se added this to the Abra v0.13 project 2026-01-01 17:45:33 +00:00

decentral1se moved this to Done in Abra v0.13 on 2026-01-01 17:46:31 +00:00

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: toolshed/abra#733

Allow edits from maintainers