Taskfile.yml

# https://taskfile.dev
version: 3

includes:
  go:
    taskfile: https://github.com/unikraft-cloud/x.git//Taskfile.go.yml?ref=prod-staging
    vars:
      goreleaser_version: v2.13.3

vars:
  go_bin:
    ref: .go_bin | default "go"

  workdir:
    sh: pwd
  distdir: "{{.workdir}}/dist"

  ytt_version: v0.52.0
  ytt_bin: "{{.go_bin}} run carvel.dev/ytt/cmd/ytt@{{.ytt_version}}"

  # HACK: hot-fix for svu, see go.mod replace
  # svu_version: v3.2.3
  # svu_bin: "{{.go_bin}} run github.com/caarlos0/svu/v3@{{.svu_version}}"
  svu_bin: "{{.go_bin}} run github.com/caarlos0/svu/v3"

  task_version: v3.48.0
  task_bin:
    sh: command -v task >/dev/null 2>&1 && echo "task --yes" || echo "{{.go_bin}} run github.com/go-task/task/v3/cmd/task@{{.task_version}} --yes"

  cli_name: unikraft-cli
  cli_docs: https://unikraft.com/docs/cli
  cli_issues: https://github.com/unikraft-cloud/cli/issues

tasks:
  default:
    cmds:
    - task: cli

  cli:
    desc: The `unikraft` CLI.
    silent: true
    cmds:
    - task: go:build
      vars:
        package: ./cmd/unikraft
        name: '{{.cli_name}}'
        docs: '{{.cli_docs}}'
        issues: '{{.cli_issues}}'

  wasm:
    desc: The `unikraft` CLI compiled to WebAssembly for JavaScript hosts.
    silent: true
    vars:
      outdir: '{{.distdir}}/wasm'
      git_tag:
        sh: git update-index -q --refresh && git describe --abbrev=0 --tags --dirty || printf "0.0.0"
      git_sha:
        sh: git update-index -q --refresh && git rev-parse HEAD || printf "dev"
      build_time:
        sh: TZ=UTC git log -1 --date=format-local:%Y-%m-%dT%H:%M:%SZ --format=%cd || date -u +%Y-%m-%dT%H:%M:%SZ
      goroot:
        sh: '{{.go_bin}} env GOROOT'
      go_version:
        sh: '{{.go_bin}} env GOVERSION'
      go_debug:
        ref: eq "true" (printf "%v" .debug)
      go_gcflags: >-
        {{- ternary "-N -l" "" .go_debug }}
      go_ldflags_extra:
        ref: .go_ldflags_extra | default ""
      go_ldflags: >-
        {{- ternary "" "-s -w" .go_debug }}
        -X "unikraft.com/x/version.Name={{.cli_name}}"
        -X "unikraft.com/x/version.Docs={{.cli_docs}}"
        -X "unikraft.com/x/version.Issues={{.cli_issues}}"
        -X "unikraft.com/x/version.Version={{.git_tag}}"
        -X "unikraft.com/x/version.Commit={{.git_sha}}"
        -X "unikraft.com/x/version.BuildTime={{.build_time}}"
        {{.go_ldflags_extra}}
    cmds:
    - mkdir -p '{{.outdir}}'
    - install -m 0644 '{{.goroot}}/lib/wasm/wasm_exec.js' '{{.outdir}}/wasm_exec.js'
    - >-
      GOOS=js GOARCH=wasm {{.go_bin}} build -v {{.CLI_ARGS}}
      -trimpath
      -gcflags=all='{{.go_gcflags}}'
      -ldflags='{{.go_ldflags}}'
      -tags='{{.go_tags}}'
      -o '{{.outdir}}/unikraft.wasm'
      ./cmd/unikraft
    - gzip -9 -n -k -f '{{.outdir}}/unikraft.wasm'
    - >-
      printf '{"version":"%s","commit":"%s","goVersion":"%s"}\n'
      '{{.git_tag}}' '{{.git_sha}}' '{{.go_version}}'
      > '{{.outdir}}/unikraft.wasm.json'
    - ls -la '{{.outdir}}'

  lint:
    desc: Lint the project.
    silent: true
    cmds:
      - task: go:lint
        vars:
          disable: [""]

  license:
    desc: Check the project licensing.
    silent: true
    cmds:
      - task: go:license

  unit:
    aliases: [test]
    desc: Run unit tests.
    silent: true
    cmds:
    - task: go:test

  unit-race:
    desc: Run unit tests with the race detector.
    silent: true
    cmds:
    - task: go:test
      vars:
        CLI_ARGS: "-race"

  integration:
    desc: Run integration tests. Use TEST=<pattern> to filter (e.g., TEST=Instances).
    silent: true
    cmds:
    - task: go:test
      vars:
        go_tags: "integration"
        package: ./cmd/unikraft/integration ./internal/cmd
        CLI_ARGS: '{{if .TEST}}-run "{{.TEST}}"{{end}}'

  golden:
    desc: Run offline golden tests.
    cmd: >-
      {{.go_bin}} test -v ./cmd/unikraft ./internal/cmd -run "TestHelp|TestOutput"

  golden-update:
    desc: Update golden files for offline tests.
    cmd: >-
      {{.go_bin}} test -v ./cmd/unikraft ./internal/cmd --update -run "TestHelp|TestOutput"

  docs:
    desc: Generate all documentation.
    silent: true
    deps:
    - task: docs:man
    - task: docs:mdx

  docs:man:
    desc: Generate man page documentation.
    silent: true
    cmd: |
      {{.go_bin}} run {{.workdir}}/tools/gendocs man --compress {{.workdir}}/dist/docs/man
    generates:
    - "{{.workdir}}/dist/docs/man/**/*"

  docs:mdx:
    desc: Generate markdown documentation.
    silent: true
    cmd: |
      {{.go_bin}} run {{.workdir}}/tools/gendocs mdx {{.workdir}}/dist/docs/mdx
    generates:
    - "{{.workdir}}/dist/docs/mdx/**/*"

  goreleaser.yaml:
    desc: Generate the GoReleaser configuration file.
    sources:
    - .goreleaser.ytt
    generates:
    - .goreleaser.yaml
    cmds:
    - |
      cat {{.workdir}}/.goreleaser.ytt | {{.ytt_bin}} --data-values-env YTT -f- > {{.workdir}}/.goreleaser.yaml

  hash-version:
    desc: Show the version of the CLI based on repo state.
    silent: true
    cmds:
    - |
      HASH_COMMIT=HEAD
      HASH=$(git update-index -q --refresh && git describe --tags)
      DIRTY=$(git update-index -q --refresh && git diff-index --quiet HEAD -- {{.WORKDIR}} || echo "-dirty")
      echo "${HASH}${DIRTY}"

  last-version:
    desc: Show the last version of the CLI.
    silent: true
    cmds:
    - |
      {{.svu_bin}} current

  next-stable:
    desc: Show the next stable version of the CLI.
    silent: true
    cmds:
    - |
      PRERELEASE="${PRERELEASE:-}"
      {{.svu_bin}} next --always --v0 --tag.prefix "v" --tag.pattern "v[0-9]*.[0-9]*.[0-9]*" --prerelease "$PRERELEASE"

  next-staging:
    desc: Show the next staging version of the CLI.
    silent: true
    cmds:
    - |
      NEXT=$({{.svu_bin}} current)
      if [[ "$NEXT" == *"staging"* ]]; then
        NEXT=$(echo "$NEXT" | awk -F. '{print $1 "." $2 "." $3 "." $4 + 1}')
      else
        NEXT=$(PRERELEASE=staging.1 {{.task_bin}} next-stable)
      fi
      echo $NEXT

  last-stable:
    desc: Show the last stable version of the CLI.
    silent: true
    cmds:
    - git describe --tags --match 'v[0-9]*.[0-9]*.[0-9]*' --exclude='*-*' --abbrev=0

  snapshot:
    desc: Generate a snapshot release.
    silent: true
    deps:
    - goreleaser.yaml
    cmds:
    - |
      {{.goreleaser_bin}} release \
        --snapshot \
        --skip=publish \
        --clean