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

Register plug-in as Packer integration #106

Merged
merged 7 commits into from
Nov 28, 2023
Merged

Conversation

nywilken
Copy link
Contributor

@nywilken nywilken commented Nov 22, 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

@edigaryev
Copy link
Contributor

edigaryev commented Nov 22, 2023

Hello @nywilken,

The Tart seems to be already registered as an integration on the website you've linked:

Screenshot 2023-11-22 at 20 35 34

I am missing something here?

.web-docs/metadata.hcl Outdated Show resolved Hide resolved
@nywilken
Copy link
Contributor Author

Hello @nywilken,

The Tart seems to be already registered as an integration on the website you've linked:
Screenshot 2023-11-22 at 20 35 34

I am missing something here?

Hi @edigaryev the current setup is using the old documentation system. We have the plugin listed as an integration but in the backend it is actually just redirecting to the plugins page https://developer.hashicorp.com/packer/plugins/builders/tart

This PR migrates the plugin to the integration framework, which you can then managed directly via the metadata.hcl file and the provided workflows.

@edigaryev edigaryev self-requested a review November 28, 2023 15:18
Co-authored-by: Wilken Rivera <dev@wilkenrivera.com>
@fkorotkov fkorotkov merged commit dc23513 into cirruslabs:main Nov 28, 2023
2 checks passed
@nywilken
Copy link
Contributor Author

@fkorotkov thanks for merging in the changes. At your connivence can you please run the notify integrations manual action to refresh the integrations portal. You should set the version to 1.6.1 to refresh the documentation for the latest release.

@fkorotkov
Copy link
Contributor

done!

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.

4 participants