Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migration plugin docs to integration framework #73

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

nywilken
Copy link
Contributor

@nywilken nywilken commented Aug 8, 2023

👋 fellow Packer maintainer working on migrating your plugin to the Packer integration framework.

This change takes the necessary steps to register this plugin as an official Packer integration.
Integrations can be found on the Packer integration portal at https://developer.hashicorp.com/packer/integrations.


The pull-request consists of the following changes:

  • Adds controlling, metadata file, metadata.hcl for registering the plug-in and it components as integrations.
    Details on the contents, along with a description of the attributes, can be found at https://github.com/hashicorp/integration-template.
  • Adds the GitHub action workflows for triggering manual and automatic integration updates.
  • Restructures the plug-in documentation to match the expected format of the integration framework.
  • Adds a .web-docs directory for serving the fully render documentation as the integration docs.
  • Adds the build-docs make target make build-docs for syncing changes to the docs directory to the .web-docs directory.

Changes to the integration docs can be made at plugin release via the notify-integration-release-via-tag workflow or
manually by running the notify-integration-release-via-manual workflow.

Details on how the Integration framework pipeline works can be found at hashicorp/packer#12702

TODOs

  • Open pull-request against external plugin.
  • Update integration description .web-docs/metadata.hcl.
  • Packer team open internal pull-request to enable integration.
  • Review plugin integration on Packer integration portal .... Iterate

@nywilken
Copy link
Contributor Author

👋 the external plugin documentation setup for this plugins is pending migration to Packer's integration framework. This means that your plugin is no longer listed as a Packer integration. To re-register your plugin with the integration portal please work to merge in this pull-request. Then open an integration-request issue to have a member of the Packer team complete the integration process.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants