Taskfile.yml

---
version: "3"

vars:
  NAME: vmware
  BINARY: packer-plugin-{{.NAME}}
  PLUGIN_FQN:
    sh: grep -E '^module' <go.mod | sed -E 's/module *//'
  COUNT: '{{.COUNT | default "1"}}'
  TEST:
    sh: go list ./... | tr '\n' ' '
  HASHICORP_PACKER_PLUGIN_SDK_VERSION:
    sh: go list -m github.com/hashicorp/packer-plugin-sdk | cut -d " " -f2

tasks:
  build:
    desc: Build the plugin binary.
    cmds:
      - go build -o {{.BINARY}}

  dev:
    desc: Build and install the plugin locally for development.
    cmds:
      - go build -ldflags="-X '{{.PLUGIN_FQN}}/version.VersionPrerelease=dev'" -o "{{.BINARY}}"
      - packer plugins install --path {{.BINARY}} "{{.PLUGIN_FQN | replace "packer-plugin-" ""}}"

  test:
    desc: Run unit tests.
    cmds:
      - go test -race -count {{.COUNT}} {{.TEST}} -timeout=3m

  install-packer-sdc:
    desc: Install the packer-sdc plugin-check tool for use in other tasks.
    cmds:
      - go install github.com/hashicorp/packer-plugin-sdk/cmd/packer-sdc@{{.HASHICORP_PACKER_PLUGIN_SDK_VERSION}}

  plugin-check:
    desc: Run packer-sdc plugin-check against the built binary to validate it meets the plugin SDK requirements.
    deps: [install-packer-sdc, build]
    cmds:
      - |
        export PATH="$(go env GOPATH)/bin:$PATH"
        packer-sdc plugin-check {{.BINARY}}

  testacc:
    desc: Run acceptance tests.
    deps: [dev]
    cmds:
      - PACKER_ACC=1 go test -count {{.COUNT}} -v {{.TEST}} -timeout=120m

  generate:
    desc: Run code generation for docs and other generated code.
    deps: [install-packer-sdc]
    cmds:
      - |
        export PATH="$(go env GOPATH)/bin:$PATH"
        go generate ./...
        rm -rf .docs
        packer-sdc renderdocs -src "docs" -partials docs-partials/ -dst ".docs/"
        ./.web-docs/scripts/compile-to-webdocs.sh "." ".docs" ".web-docs" "hashicorp"
        rm -r ".docs"

  docs-deps:
    desc: Install Zensical and mike into docs-site/.venv for local docs preview.
    cmds:
      - test -d docs-site/.venv || python3 -m venv docs-site/.venv
      - docs-site/.venv/bin/pip install -r docs-site/requirements.txt

  docs-prepare:
    desc: Stage .web-docs into docs-site/.build/docs for Zensical.
    cmds:
      - ./docs-site/scripts/prepare-docs.sh

  docs-test:
    desc: Run all docs-site script unit tests.
    cmds:
      - ./docs-site/scripts/test/test-all.sh

  docs-test-links:
    desc: Run integration link rewrite tests for staged documentation.
    cmds:
      - ./docs-site/scripts/test/test-rewrite-integration-links.sh

  docs-test-internal-links:
    desc: Run internal link and anchor fix tests for staged documentation.
    cmds:
      - ./docs-site/scripts/test/test-fix-internal-links.sh

  docs-test-admonitions:
    desc: Run Material-to-Zensical admonition conversion tests.
    cmds:
      - ./docs-site/scripts/test/test-convert-admonitions.sh

  docs-test-example-labels:
    desc: Run HCL/JSON example label formatting tests.
    cmds:
      - ./docs-site/scripts/test/test-format-example-labels.sh

  docs-test-group-example-tabs:
    desc: Run HCL/JSON content tab grouping tests.
    cmds:
      - ./docs-site/scripts/test/test-group-example-tabs.sh

  docs-test-normalize:
    desc: Run staged markdown list spacing tests.
    cmds:
      - ./docs-site/scripts/test/test-normalize-list-spacing.sh

  docs-test-strip-codegen:
    desc: Run strip-codegen-comments tests.
    cmds:
      - ./docs-site/scripts/test/test-strip-codegen-comments.sh

  docs-test-repair-fences:
    desc: Run repair-code-fences tests.
    cmds:
      - ./docs-site/scripts/test/test-repair-code-fences.sh

  docs-test-stage-markdown:
    desc: Run staged markdown pipeline integration tests.
    cmds:
      - ./docs-site/scripts/test/test-stage-markdown.sh

  docs-test-github-alerts:
    desc: Run GitHub alert to admonition conversion tests.
    cmds:
      - ./docs-site/scripts/test/test-convert-github-alerts.sh

  docs-build:
    desc: Preview what documentation will look like at the next release (build).
    deps: [generate, docs-deps, docs-prepare]
    cmds:
      - cd docs-site && ../docs-site/.venv/bin/zensical build --config-file zensical.build.toml

  docs-serve:
    desc: Preview what documentation will look like at the next release (live).
    deps: [generate, docs-deps, docs-prepare]
    cmds:
      - cd docs-site && ../docs-site/.venv/bin/zensical serve --config-file zensical.build.toml

  docs-serve-version:
    desc: "Preview documentation from a released version."
    deps: [docs-deps]
    cmds:
      - |
        test -n "{{.VERSION}}" || (echo "VERSION is required" && exit 1)
        rm -rf .web-docs
        git checkout "v{{.VERSION}}" -- .web-docs
        INCLUDE_EXTRA=true ./docs-site/scripts/prepare-docs.sh
        cd docs-site && ../docs-site/.venv/bin/zensical serve --config-file zensical.build.toml

  docs-serve-mike:
    desc: Preview versioned documentation locally with mike (latest=last tag, development=branch name).
    deps: [generate, docs-deps]
    env:
      MIKE_PREVIEW_VERSIONS: "{{.VERSIONS}}"
    cmds:
      - ./docs-site/scripts/mike-preview.sh

  docs-serve-mike-only:
    desc: Serve an existing local mike preview without redeploying.
    deps: [docs-deps]
    cmds:
      - ./docs-site/scripts/mike-preview.sh --serve-only

  docs-backfill:
    desc: Backfill versioned documentation to GitHub Pages.
    deps: [docs-deps]
    env:
      MIKE_BACKFILL_VERSIONS: "{{.VERSIONS}}"
    cmds:
      - ./docs-site/scripts/mike-backfill.sh {{.CLI_ARGS}}