diff --git a/.github/DEBUG.md b/.github/DEBUG.md new file mode 100644 index 0000000..b325820 --- /dev/null +++ b/.github/DEBUG.md @@ -0,0 +1,16 @@ +# Debug + +The recommended way to debug a packer plugin is adding prints and running with logs enabled. +As written in [packer debug documentation](https://developer.hashicorp.com/packer/docs/debugging), you can use `PACKER_LOG=1` to enable verbose logging. + +## Testing local build + +To test a local build, you need to have the plugin in the same folder where you will run packer: + + +``` +> ls +packer-plugin-scaleway build_scaleway.pkr.hcl +> PACKER_LOG=DEBUG SCW_DEBUG=1 packer build build_scaleway.pkr.hcl +... +``` diff --git a/.web-docs/components/builder/scaleway/README.md b/.web-docs/components/builder/scaleway/README.md index 60a50ee..823c8df 100644 --- a/.web-docs/components/builder/scaleway/README.md +++ b/.web-docs/components/builder/scaleway/README.md @@ -111,7 +111,7 @@ can also be supplied to override the typical auto-generated key: It can also be specified via environment variable SCALEWAY_API_TOKEN. You can see and generate tokens in the "Credentials" section of the control panel. - Deprecated, use SecretKey instead + Deprecated: use SecretKey instead - `organization_id` (string) - The organization id to use to identify your organization. It can also be specified via environment variable @@ -119,12 +119,12 @@ can also be supplied to override the typical auto-generated key: "Account" section of the control panel. Previously named: api_access_key with environment variable: SCALEWAY_API_ACCESS_KEY - Deprecated, use ProjectID instead + Deprecated: use ProjectID instead - `region` (string) - The name of the region to launch the server in (par1 or ams1). Consequently, this is the region where the snapshot will be available. - Deprecated, use Zone instead + Deprecated: use Zone instead diff --git a/docs-partials/builder/scaleway/Config-not-required.mdx b/docs-partials/builder/scaleway/Config-not-required.mdx index a6663c1..94c448d 100644 --- a/docs-partials/builder/scaleway/Config-not-required.mdx +++ b/docs-partials/builder/scaleway/Config-not-required.mdx @@ -44,7 +44,7 @@ It can also be specified via environment variable SCALEWAY_API_TOKEN. You can see and generate tokens in the "Credentials" section of the control panel. - Deprecated, use SecretKey instead + Deprecated: use SecretKey instead - `organization_id` (string) - The organization id to use to identify your organization. It can also be specified via environment variable @@ -52,11 +52,11 @@ "Account" section of the control panel. Previously named: api_access_key with environment variable: SCALEWAY_API_ACCESS_KEY - Deprecated, use ProjectID instead + Deprecated: use ProjectID instead - `region` (string) - The name of the region to launch the server in (par1 or ams1). Consequently, this is the region where the snapshot will be available. - Deprecated, use Zone instead + Deprecated: use Zone instead