Update plugin location docs

This change updates the multi-component name to reflect the name
generated by the goreleaser configuration in packer-plugin-scaffolding.

It also adds a small call out about the SHA256SUM file that needs to be
present for binaries installed via `packer init` in case maintainers
want to test packer init locally without having to call out to GitHub.
This commit is contained in:
Wilken Rivera 2021-02-24 13:33:08 -05:00
parent b4b0df44b4
commit e441733cbd
1 changed files with 11 additions and 5 deletions

View File

@ -39,14 +39,20 @@ system with no `PACKER_PLUGIN_PATH` env var set.
During initialization, on a `darwin_amd64` system, Packer will look-up for the
following files:
* `PACKER_EXEC_DIR/github.com/azr/happycloud/packer-plugin-happycloud_*_darwin_amd64_x5.0`
* `./github.com/azr/happycloud/packer-plugin-happycloud_*_darwin_amd64_x5.0`
* `PACKER_HOME_DIR/plugins/github.com/azr/happycloud/packer-plugin-happycloud_*_darwin_amd64_x5.0`
* `PACKER_PLUGIN_PATH/github.com/azr/happycloud/packer-plugin-happycloud_*_darwin_amd64_x5.0`
* `PACKER_EXEC_DIR/github.com/azr/happycloud/packer-plugin-happycloud_*_x5.0_darwin_amd64`
* `./github.com/azr/happycloud/packer-plugin-happycloud_*_x5.0_darwin_amd64`
* `PACKER_HOME_DIR/plugins/github.com/azr/happycloud/packer-plugin-happycloud_*_x5.0_darwin_amd64`
* `PACKER_PLUGIN_PATH/github.com/azr/happycloud/packer-plugin-happycloud_*_x5.0_darwin_amd64`
* `./packer-plugin-happycloud`
The first plugin-name/version files found will take precedence.
For plugins located under the `github.com/azr/happycloud/` directory structure an accompanying SHA256SUM file
will be required in order for `packer init` to ensure the plugin being loaded has not been tampered with.
The SHA256SUM file will be automatically generated when a plugin is installed via `packer init` if the plugin
was installed manually into `PACKER_HOME_DIR/plugins/github.com/azr/happycloud/` then the file
`PACKER_HOME_DIR/plugins/github.com/azr/happycloud/packer-plugin-happycloud_*_x5.0_darwin_amd64_SHA256SUM` must be generated manually as well.
-> Note: `PACKER_HOME_DIR` is not an actual env var and refers to [Packer's home
directory](#packer-s-home-directory). `PACKER_EXEC_DIR` is not an actual env var
and refers to the directory where `packer` is, or the executable directory.