From b4a4dacdc39cc6a3a4d7cf60e0960c62af97f545 Mon Sep 17 00:00:00 2001 From: Wilken Rivera Date: Wed, 29 Nov 2023 13:49:02 -0500 Subject: [PATCH] Update registration process * Add initial issue template --- .github/ISSUE_TEMPLATE/plugin_integration.md | 12 ++++++++++ .../content/docs/plugins/creation/index.mdx | 23 ++++++++----------- 2 files changed, 22 insertions(+), 13 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/plugin_integration.md diff --git a/.github/ISSUE_TEMPLATE/plugin_integration.md b/.github/ISSUE_TEMPLATE/plugin_integration.md new file mode 100644 index 00000000000..d68248ed52b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/plugin_integration.md @@ -0,0 +1,12 @@ +--- +name: Plugin Integration +about: Open request to add your plugin as a Packer integration (https://developer.hashicorp.com/packer/integrations) +labels: integration-request +--- + +#### Description + +A written description of your plugin along with a link to the plugin repository. + +#### Checklist + diff --git a/website/content/docs/plugins/creation/index.mdx b/website/content/docs/plugins/creation/index.mdx index 5bb9d6a6e02..9d39340ef12 100644 --- a/website/content/docs/plugins/creation/index.mdx +++ b/website/content/docs/plugins/creation/index.mdx @@ -221,31 +221,28 @@ Here's what you need to create releases using GitHub Actions: `packer init` allows users to require and install remote Packer plugins published to GitHub. To help with the discovery of remote Packer plugins, plugins maintainers can choose to register their plugin as a [Packer Integration](/packer/integrations). -The registration process requires changes to your plugin repository for configuring the Packer integration pipeline and plugin documentation for rendering +The registration process requires [metadata configuration](https://github.com/hashicorp/integration-template#metadata-configuration) be added to your plugin repository for configuring the Packer integration pipeline and plugin documentation for rendering on the [Packer Integrations](/packer/integrations) portal. -Once in place, an integration request can be made on Packer GitHub repository. By opening an integration request, you are asking a member of the to Packer -team to review your plugin integration configuration, plugin documentation, and, finally, to open an internal pull-request to finalize the integration setup. - -Once completed your the plugin integration will be listed as a [Packer Integration](/packer/integrations), with details on how to install and usage your the plugin. - -Plugin integrations, once deployed, can be updated manually, or automatically upon a new release, by the plugin authors. Changes to the defined documentation structure -or parent repository should be communicated to the Packer team to ensure a working integration pipeline. - The following steps are required for registering your plugin as an integration -1. Open a request for integration issue with the Packer team - [LINK](). -Please provide all the requested information to help expedite the integration request. 1. Update your plugin documentation structure according to the templated defined with the [Packer Plugin Scaffolding template]. -New plugin generated from this template may have the necessary structure in place. If so you can jump to step 4. +New plugins generated from this template may have the necessary structure in place. If so you can jump to step 4. 1. For the integrations library, only one top-level README per integration is supported. Any top-level index.mdx files that exist within a plugins existing documentation will need to migrate to a top-level README. 1. Update your top-level integration README to include a description, plugin installation steps, available components section, and, any, additional sections needed to inform users on how to work with your integration. Refer to [Packer scaffolding plugin](https://github.com/hashicorp/packer-plugin-scaffolding/blob/main/docs/README.md) for an example. 1. Update the top-level README for each of the components within your integration to follow the structure defined in the scaffolding template. +1. Open a request for integration issue with the Packer team - [LINK](). +Please provide all the requested information to help expedite the integration request. -### Testing Plugin Documentation +By opening an integration request, you are asking a member of the to Packer team to review your plugin integration configuration, plugin documentation, +and, finally, to open an internal pull-request to finalize the integration setup. +Plugin integrations will be listed as a [Packer Integration](/packer/integrations), with details on how to install and use your the plugin. + +Plugin integrations, once deployed, can be updated manually, or automatically upon a new release, by the plugin authors. Changes to the defined documentation structure +or parent repository should be communicated to the Packer team to ensure a working integration pipeline. ## Plugin Development Tips and FAQs