Skip to content
This repository has been archived by the owner on May 3, 2022. It is now read-only.

Unclear or misleading usage for duffle upgrade and duffle uninstall #831

Open
itowlson opened this issue Aug 8, 2019 · 2 comments
Open
Labels
Milestone

Comments

@itowlson
Copy link
Contributor

itowlson commented Aug 8, 2019

duffle upgrade and duffle uninstall both have the following usage string:

duffle <verb> [NAME] [flags]

where the flags include -b for a bundle name and --bundle-file for a bundle.json on the filesystem.

The usage implies that the installation name is optional. I don't think this is true; if I omit it, I get Error: accepts 1 arg(s), received 0.

The documentation does not clearly explain the use of the bundle flags and how they interact with the (optional?) claim. I think from duffle upgrade that if you don't supply a bundle then it reruns the invocation image from the last installation record, potentially with different parameters but still the same version. If you do supply a bundle then it runs the invocation image specified in that bundle. I assume uninstall is the same, but that doesn't mention it in the help text so it will be unclear to someone who doesn't cross-reference to upgrade.

If someone can confirm the behaviour then I am happy to send a documentation PR. Thanks!

@jeremyrickard jeremyrickard added this to the Duffle 1.0 milestone Aug 12, 2019
@jeremyrickard
Copy link
Member

This appears to be a duplicate of #641

@itowlson
Copy link
Contributor Author

They certainly overlap, but I think #641 was pushing to make the commands more consistent whereas this issue is saying that the usage documentation doesn't actually match what the commands accept. They are probably part of the same fix though!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants