-
Notifications
You must be signed in to change notification settings - Fork 29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
updated docs for semver constraint plugin install/updates #184
Conversation
docs/managing/plugins.md
Outdated
``` | ||
|
||
This will download the aws plugin version 0.0.1 (the one with the `0.0.1` tag) from the hub registry. Note that installing a specific version will NOT create a connection for you - you must create/edit a [connection](/docs/managing/connections) configuration file in order to use the plugin. | ||
This will download the aws plugin version 0.118.0 (the one with the `0.118.0` tag) from the hub registry. Note that installing a specific version will NOT create a connection for you - you must create/edit a [connection](/docs/managing/connections) configuration file in order to use the plugin. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this still true? I know that originally we only copied over the spc file as-is but I had thought that we changed the behavior at some point?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm, it doesn't create it if you have an existing config for the plugin - however if you have no config for the plugin it will create it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated to be a single note that informs user only first installation of a plugin will give connection file, additional versions require amending/creation of new files.
```bash | ||
steampipe plugin update aws@0.1 | ||
steampipe plugin update aws@^0.107 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would expect steampipe plugin update aws
to update to the latest version that meets the current constraint. Does steampipe plugin update aws@^0.107
actually change the constraint in the mod file as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Plugin update requires specifying the installed version you wish to update (omitting it is same as latest
)
For example, you can install 3x versions of aws
:
- plugin install aws (this could be version 3.0.1)
- plugin install aws@^1.0 (this could be 1.0.0)
- plugin install aws@^2.0 (this could be 2.2.2)
plugin update requires you to target the installation you wish to update
- plugin update aws (3.0.1 -> 3.0.2)
- plugin update aws@^2.0 (2.2.2 -> 2.3.0)
- plugin update aws@^3.0 (error plugin not installed)
* updated docs for semver constraint plugin install/updates (#184) * updated docs for semver constraint plugin install/updates * reworked text around when you need to create connection/connection file * add docs for verbose timing option * update docs for verbose timing --------- Co-authored-by: Graza <code@graza.io>
No description provided.