Rename plugin command #12865
Merged
Rename plugin command #12865
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lbajolet-hashicorp
force-pushed
the
rename_plugin_command
branch
from
45d0ee2 to
8ae73e2
Compare
nywilken
reviewed
Mar 8, 2024
lbajolet-hashicorp
force-pushed
the
rename_plugin_command
branch
from
8ae73e2 to
f62ffe7
Compare
nywilken
approved these changes
Mar 11, 2024
The plugin and plugins command had a name that was close, and while plugin is not supposed to be directly called by Packer users, this could happen by accident while trying to execute packer plugins subcommands, and when it does, the error messages are far from explicit, so unless they understand what Packer is doing here, they'll likely be lost. To reduce the risk of confusion, we rename the command to run packer embedded components as execute.
lbajolet-hashicorp
force-pushed
the
rename_plugin_command
branch
from
f62ffe7 to
6da1264
Compare
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The plugin command existed so that Packer was able to invoke its embedded components for a build.
The name however is a bit close to
plugins, and the help messages aren't clear if invoked by mistake, which can be quite confusing when trying to use Packer to manage installed plugins.Since we're doubling down on using Packer to manage those, the problem may become exacerbated in the future, so we are renaming the command to invoke a component to
execute. No other command is close in name to this, so it's less likely to be mistakenly invoked by a user.In addition to
execute, we are also usingpluginas an alias forplugins, so thatpacker plugins installedandpacker plugin installedare in effect the same command (this is true for all the other subcommands).