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.

Sign up for GitHub

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

Update makefile generate #95

Merged
merged 2 commits into from
Nov 28, 2023
Merged

Update makefile generate #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7308520
.web-docs: add description for the plugin
lbajolet-hashicorp Nov 24, 2023
24e7c7b
Makefile: replace build-docs by generate
lbajolet-hashicorp Nov 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ensure-docs-compiled.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

2 changes: 1 addition & 1 deletion .web-docs/metadata.hcl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
11 changes: 2 additions & 9 deletions GNUmakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand All @@ -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
Loading