Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.78 KB

README.md

File metadata and controls

37 lines (27 loc) · 1.78 KB
Raw

Packer Plugin Scaffolding

This repository is a template for a Packer multi-plugin. It is intended as a starting point for creating Packer plugins, containing:

  • A builder (builder/scaffolding)
  • A provisioner (provisioner/scaffolding)
  • A post-processor (post-processor/scaffolding)
  • A data source (datasource/scaffolding)
  • Docs (docs/)

These folders contain boilerplate code that you will need to edit to create your own Packer multi-plugin. A full guide to creating Packer plugins can be found at Extending Packer.

In this repository you will also find a pre-defined GitHub Action configuration for the release workflow (.goreleaser.yml and .github/workflows/release.yml). The release workflow configuration makes sure the GitHub release artifacts are created with the correct binaries and naming conventions.

Please see the GitHub template repository documentation for how to create a new repository from this template on GitHub.

Running Acceptance Tests

Make sure to install the plugin with go install . and to have Packer installed locally.
Then source the built binary to the plugin path with ln -s $GOPATH/bin/packer-plugin-scaffolding ~/.packer.d/plugins/packer-plugin-scaffolding
Once everything needed is set up, run:

PACKER_ACC=1 go test -count 1 -v ./... -timeout=120m

This will run the acceptance tests for all plugins in this set.

Requirements

Packer Compatibility

This scaffolding template is compatible with Packer >= v1.7.0 (to be released)