diff --git a/website/content/docs/extending/plugins.mdx b/website/content/docs/extending/plugins.mdx index 4cd2ce443..65d82dd5f 100644 --- a/website/content/docs/extending/plugins.mdx +++ b/website/content/docs/extending/plugins.mdx @@ -259,13 +259,13 @@ the logs to be helpful. ### Creating a GitHub Release -To create a GitHub release with the right assets that will be consumed by Packer, we provide a pre-defined release workflow configuration -using [GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions). We strongly encourage maintainers to use this configuration, -to make sure the release contains the necessary expected by Packer when loading a plugin. +To create a GitHub release with the assets that will be consumed by Packer, we provide a pre-defined release workflow configuration +using [GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions). We strongly encourage maintainers to use this configuration +to make sure the release contains the expected by Packer when loading a plugin. [GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions) allow you to execute workflows when events on your repository occur. You can use this to create releases whenever a new version tag is created on your repository. -Here's what you need to use GitHub Actions to create releases: +Here's what you need to create releases using GitHub Actions: 1. Generate a GPG key to be used when signing releases (See [GitHub's detailed instructions](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/generating-a-new-gpg-key) for help with this step) 2. Copy the [GoReleaser configuration from the packer-plugin-scaffolding repository](https://github.com/hashicorp/packer-plugin-scaffolding) to the root of your repository. @@ -273,9 +273,12 @@ for help with this step) 4. Go to Settings > Secrets in your repository, and add the following secrets: - `GPG_PRIVATE_KEY` - Your ASCII-armored GPG private key. You can export this with `gpg --armor --export-secret-keys [key ID or email]`. - `PASSPHRASE` - The passphrase for your GPG private key. -5. Push a new valid version tag (e.g. `v1.2.3`) to test that the GitHub Actions releaser is working. +5. Push a new valid version tag (e.g. `v1.2.3`) to test that the GitHub Actions releaser is working. The tag must be a valid [Semantic Version](https://semver.org/) preceded with a `v`. 6. Make sure to [register your plugin](#registering-the-plugin) with us. +~> **Important:** Avoid modifying or replacing an already-released version of a plugin. Instead, if changes are necessary, +please release as a new version. + ### Registering the Plugin We like to keep all of our products and external plugins release assets together in the same place. To publish