Skip to content

Commit

Permalink
Update registration process
Browse files Browse the repository at this point in the history
* Add initial issue template
  • Loading branch information
nywilken committed Nov 29, 2023
1 parent 3cc161f commit b4a4dac
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 13 deletions.
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/plugin_integration.md
Original file line number Diff line number Diff line change
@@ -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

23 changes: 10 additions & 13 deletions website/content/docs/plugins/creation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit b4a4dac

Please sign in to comment.