From 73085203560690ad92ca76342a1ead3c28baf528 Mon Sep 17 00:00:00 2001 From: Lucas Bajolet Date: Fri, 24 Nov 2023 15:43:21 -0500 Subject: [PATCH 1/2] .web-docs: add description for the plugin --- .web-docs/metadata.hcl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.web-docs/metadata.hcl b/.web-docs/metadata.hcl index e5c0c57..13edf02 100644 --- a/.web-docs/metadata.hcl +++ b/.web-docs/metadata.hcl @@ -2,7 +2,7 @@ # https://github.com/hashicorp/integration-template#metadata-configuration integration { name = "Parallels" - description = "TODO" + description = "The Parallels plugin can be used with HashiCorp Packer to create custom images on Parallels." identifier = "packer/Parallels/parallels" component { type = "builder" From 24e7c7baf2c21a7c0ee428d9437e3c04cf4adf87 Mon Sep 17 00:00:00 2001 From: Lucas Bajolet Date: Fri, 24 Nov 2023 15:43:33 -0500 Subject: [PATCH 2/2] Makefile: replace build-docs by generate --- .github/workflows/ensure-docs-compiled.yaml | 4 ++-- GNUmakefile | 11 ++--------- 2 files changed, 4 insertions(+), 11 deletions(-) diff --git a/.github/workflows/ensure-docs-compiled.yaml b/.github/workflows/ensure-docs-compiled.yaml index 8d10ac7..00c3620 100644 --- a/.github/workflows/ensure-docs-compiled.yaml +++ b/.github/workflows/ensure-docs-compiled.yaml @@ -9,14 +9,14 @@ jobs: uses: actions/checkout@v2 - uses: actions/setup-go@v4 - shell: bash - run: make build-docs + run: make generate - shell: bash run: | if [[ -z "$(git status -s)" ]]; then echo "OK" else echo "Docs have been updated, but the compiled docs have not been committed." - echo "Run 'make build-docs', and commit the result to resolve this error." + echo "Run 'make generate', and commit the result to resolve this error." exit 1 fi diff --git a/GNUmakefile b/GNUmakefile index 3df9bba..d33ebf7 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -20,10 +20,6 @@ test: install-packer-sdc: ## Install packer sofware development command @go install github.com/hashicorp/packer-plugin-sdk/cmd/packer-sdc@${HASHICORP_PACKER_PLUGIN_SDK_VERSION} -ci-release-docs: install-packer-sdc - @packer-sdc renderdocs -src docs -partials docs-partials/ -dst docs/ - @/bin/sh -c "[ -d docs ] && zip -r docs.zip docs/" - plugin-check: install-packer-sdc build @packer-sdc plugin-check ${BINARY} @@ -32,11 +28,8 @@ testacc: dev generate: install-packer-sdc @go generate ./... - packer-sdc renderdocs -src ./docs -dst ./.docs -partials ./docs-partials - # checkout the .docs folder for a preview of the docs - -build-docs: install-packer-sdc @if [ -d ".docs" ]; then rm -r ".docs"; fi - @packer-sdc renderdocs -src "docs" -partials docs-partials/ -dst ".docs/" + packer-sdc renderdocs -src "docs" -partials docs-partials/ -dst ".docs/" @./.web-docs/scripts/compile-to-webdocs.sh "." ".docs" ".web-docs" "Parallels" @rm -r ".docs" + # checkout the .docs folder for a preview of the docs