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 #91

Merged
merged 9 commits into from
Dec 1, 2023

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

.web-docs/metadata.hcl Outdated Show resolved Hide resolved
Copy link
Owner

@ethanmdavidson ethanmdavidson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Judging by the open TODO items, it seems this shouldn't be merged yet, is that correct?

docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
@nywilken
Copy link
Contributor Author

nywilken commented Dec 1, 2023

Judging by the open TODO items, it seems this shouldn't be merged yet, is that correct?

Hi @ethanmdavidson thanks for reviewing. I updated the todo list to reflect the work done on our end. I'll address the feedback in your review and we should be good to go.

Are you okay with this description https://github.com/ethanmdavidson/packer-plugin-git/pull/91/files#diff-013fb697039a6813910d135e4a2702a133cee049a7d224d50388d674087eca85R5

Co-authored-by: Ethan Davidson <ethanmdavidson@gmail.com>
@nywilken
Copy link
Contributor Author

nywilken commented Dec 1, 2023

@ethanmdavidson At your connivence can you please merge and run the notify integrations manual actionn to refresh the integrations portal. You should set the version to 0.4.3 to refresh the documentation for the latest release.

@ethanmdavidson ethanmdavidson merged commit 4deccd9 into ethanmdavidson:main Dec 1, 2023
1 check passed
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.

None yet

3 participants