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

Merged
merged 9 commits into from
Dec 26, 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

.web-docs/metadata.hcl Outdated Show resolved Hide resolved
@Codelax Codelax self-requested a review November 28, 2023 08:50
Copy link
Member

@Codelax Codelax left a comment

Choose a reason for hiding this comment

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

Hello, thanks for this PR and your work on packer

Comment on lines +41 to +54
- name: Checkout integration-release-action
uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
with:
repository: hashicorp/integration-release-action
path: ./integration-release-action
- name: Notify Release
uses: ./integration-release-action
with:
# The integration identifier will be used by the Packer team to register the integration
# the expected format is packer/<GitHub Org Name>/<plugin-name>
integration_identifier: "packer/scaleway/scaleway"
release_version: ${{ needs.strip-version.outputs.packer-version }}
release_sha: ${{ github.ref }}
github_token: ${{ secrets.GITHUB_TOKEN }}
Copy link
Member

Choose a reason for hiding this comment

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

Do you plan to do a proper release of your action hashicorp/integration-release-action ?
So it can be used and versioned.

.github/workflows/notify-integration-release-via-tag.yaml Outdated Show resolved Hide resolved

- [builder](/docs/builders/scaleway.mdx) - The Scaleway Packer builder is able to create new images for use with Scaleway Compute Instance servers.
- [scaleway](/packer/integrations/scaleway/scaleway/latest/components/builder/scaleway) - The Scaleway Packer builder is able to create new images for use with Scaleway Compute Instance servers.
Copy link
Member

Choose a reason for hiding this comment

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

Is there any plan to have translated links ? I don't see a way to have links validated here.
There could be issues found after release with this new format

@Codelax Codelax added this pull request to the merge queue Dec 26, 2023
Merged via the queue into scaleway:main with commit 1316808 Dec 26, 2023
5 checks passed
@nywilken
Copy link
Contributor Author

Hi @Codelax apologies for the delayed response the majority of the team was away for holidays.

Thank you for merging in this change. We went ahead and enabled the integration on our end. To publish the new integration could you please trigger a manual notification release job for the current version of the Scaleway plug-in.

@Codelax
Copy link
Member

Codelax commented Jan 17, 2024

Thanks for the followup @nywilken
The manual job just ran, when will we see the changes on packer website ?

@nywilken
Copy link
Contributor Author

Thanks for the followup @nywilken The manual job just ran, when will we see the changes on packer website ?

Thank you. The integration is now live at https://developer.hashicorp.com/packer/integrations/scaleway/scaleway

If you are still seeing the old plugin docs you may need to hard refresh your browser to flush the cache. This change now enables you to have versioned docs for your plugin and can be updated at your convenience using the provided actions.

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