goreleaser/Taskfile.yml

# https://taskfile.dev

version: "3"

env:
  GO111MODULE: on
  GOPROXY: https://proxy.golang.org,direct

tasks:
  dev:
    desc: Setup git hooks
    cmds:
      - cp -f scripts/pre-commit.sh .git/hooks/pre-commit

  setup:
    desc: Install dependencies
    cmds:
      - go mod tidy

  docker:setup:
    desc: Setup Docker for multi-arch image builds
    cmds:
      - "docker buildx create --name=goreleaser --driver-opt network=host --use || true"
      - docker run --privileged --rm tonistiigi/binfmt --install all

  build:
    desc: Build the binary
    sources:
      - ./**/*.go
    generates:
      - ./goreleaser
    cmds:
      - go build

  test:
    desc: Run tests
    env:
      LC_ALL: C
    vars:
      TEST_OPTIONS: '{{default "" .TEST_OPTIONS}}'
      SOURCE_FILES: '{{default "./..." .SOURCE_FILES}}'
      TEST_PATTERN: '{{default "." .TEST_PATTERN}}'
    cmds:
      - go test {{.TEST_OPTIONS}} -failfast -race -coverpkg=./... -covermode=atomic -coverprofile=coverage.txt {{.SOURCE_FILES}} -run {{.TEST_PATTERN}} -timeout=15m

  fuzz:tmpl:
    cmds:
      - scripts/fuzz.sh ./internal/tmpl 30s

  fuzz:artifact:
    cmds:
      - scripts/fuzz.sh ./internal/artifact 30s

  fuzz:
    desc: Run fuzz tests
  cmds:
    - task: fuzz:tmpl
    - task: fuzz:artifact

  test:golden:update:
    desc: Run all tests that write goldne files, updating the files.
    sources:
      - ./pkg/config/*.go
      - ./pkg/context/*.go
    cmds:
      - ./scripts/test-golden.sh

  cover:
    desc: Open the cover tool
    cmds:
      - go tool cover -html=coverage.txt

  fmt:
    desc: gofumpt all code
    cmds:
      - gofumpt -w -l .

  lint:
    desc: Lint the code with golangci-lint
    cmds:
      - golangci-lint run --config ./.golangci.yaml ./...

  ci:
    desc: Run all CI steps
    cmds:
      - task: setup
      - task: build
      - task: test

  default:
    desc: Runs the default tasks
    cmds:
      - task: ci

  nix:licenses:generate:
    desc: Generate nix/licenses.go
    cmds:
      - ./scripts/gen-nix-licenses.sh
    generates:
      - ./internal/pipe/nix/licenses.go

  schema:generate:
    desc: Generate JSONSchema
    cmds:
      - go run . schema -o ./www/docs/static/schema.json
    sources:
      - pkg/config/config.go
    generates:
      - ./www/docs/static/schema.json

  schema:validate:
    desc: Validate JSONSchema
    cmds:
      - jv ./www/docs/static/schema.json
    sources:
      - ./www/docs/static/schema.json

  docs:generate:
    desc: Generate docs
    cmds:
      - cp -rf CONTRIBUTING.md www/docs/contributing.md
      - cp -rf USERS.md www/docs/users.md
      - cp -rf EULA.md www/docs/eula.md
      - cp -rf SECURITY.md www/docs/security.md
    sources:
      - CONTRIBUTING.md
      - USERS.md
      - EULA.md
      - SECURITY.md
    generates:
      - www/docs/contributing.md
      - www/docs/users.md
      - www/docs/eula.md
      - www/docs/security.md

  docs:releases:
    desc: Generate releases.json and latest files
    cmds:
      - ./scripts/get-releases.sh
    generates:
      - www/docs/static/releases.json
      - www/docs/static/releases-pro.json
      - www/docs/static/latest
      - www/docs/static/latest-pro

  docs:imgs:
    desc: Download and resize images
    cmds:
      - wget -O www/docs/static/logo.png https://raw.githubusercontent.com/goreleaser/artwork/master/goreleaserfundo.png
      - wget -O www/docs/static/card.png https://raw.githubusercontent.com/goreleaser/artwork/master/twitter-card.png
      - wget -O www/docs/static/avatar.png https://github.com/goreleaser.png
      - convert www/docs/static/avatar.png -define icon:auto-resize=64,48,32,16 www/docs/static/favicon.ico
      - convert www/docs/static/avatar.png -resize x120 www/docs/static/apple-touch-icon.png

  docs:container:build:
    desc: "Build our mkdocs Docker image"
    sources:
      - ./www/Dockerfile
      - ./www/requirements.txt
    cmds:
      - "docker build -t material-mkdocs ./www"

  docs:serve:
    desc: Start documentation server
    cmds:
      - task: docs:container:build
      - task: docs:generate
      - "docker run --rm -p 8000:8000 -v ./www:/docs material-mkdocs"

  docs:build:
    desc: Build docs
    sources:
      - ./www/docs/
      - ./www/Dockerfile
      - ./www/mkdocs.yml
      - ./www/requirements.txt
    generates:
      - ./www/site
    cmds:
      - task: docs:container:build
      - task: docs:generate
      - "docker run --rm -v ./www:/docs material-mkdocs build"

  docs:test:
    desc: Test docs with htmltest
    cmds:
      - task: docs:build
      - "docker run -v ./www:/test --rm wjdp/htmltest /test/site -c /test/htmltest.yml"

  release:
    desc: Create a new tag
    vars:
      NEXT:
        sh: svu n
    prompt: "This will release {{.NEXT}}. Continue?"
    preconditions:
      - sh: '[ $(git symbolic-ref --short HEAD) = "main" ]'
        msg: Not on main branch
      - sh: "[ $(git status --porcelain=2 | wc -l) = 0 ]"
        msg: "Git is dirty"
    cmds:
      - git tag -d nightly
      - git tag {{.NEXT}}
      - echo {{.NEXT}}
      - git push origin --tags

  release:watch:
    vars:
      RUN_ID:
        sh: "gh run list --workflow=release.yml --limit 1 --json databaseId | jq -r '.[] | .databaseId'"
    cmds:
      - gh run watch {{.RUN_ID}}

  goreleaser:test:pkg:
    desc: Test a package
    cmds:
      - docker run --platform linux/{{.Platform}} --rm --workdir /tmp -v $PWD/dist:/tmp {{.Image}} sh -c '{{.Cmd}} && goreleaser --version'

  goreleaser:test:rpm:
    desc: Tests rpm packages
    vars:
      rpm: "rpm --nodeps -ivh"
    cmds:
      - task: goreleaser:test:pkg
        vars:
          Platform: "386"
          Image: centos:centos7
          Cmd: "{{.rpm}} goreleaser-*.i386.rpm"
      - task: goreleaser:test:pkg
        vars:
          Platform: "amd64"
          Image: fedora
          Cmd: "{{.rpm}} goreleaser-*.x86_64.rpm"
      - task: goreleaser:test:pkg
        vars:
          Platform: "arm64"
          Image: fedora
          Cmd: "{{.rpm}} goreleaser-*.aarch64.rpm"

  goreleaser:test:deb:
    desc: Tests deb packages
    vars:
      dpkg: "dpkg --ignore-depends=git -i"
    cmds:
      - task: goreleaser:test:pkg
        vars:
          Platform: "amd64"
          Image: ubuntu
          Cmd: "{{.dpkg}} goreleaser*_amd64.deb"
      - task: goreleaser:test:pkg
        vars:
          Platform: "arm64"
          Image: ubuntu
          Cmd: "{{.dpkg}} goreleaser*_arm64.deb"
      - task: goreleaser:test:pkg
        vars:
          Platform: "arm/7"
          Image: ubuntu
          Cmd: "{{.dpkg}} goreleaser*_armhf.deb"

  goreleaser:test:apk:
    desc: Tests apk packages
    vars:
      apk: "apk add --allow-untrusted -U"
    cmds:
      - task: goreleaser:test:pkg
        vars:
          Platform: "386"
          Image: alpine
          Cmd: "{{.apk}} goreleaser*_x86.apk"
      - task: goreleaser:test:pkg
        vars:
          Platform: "amd64"
          Image: alpine
          Cmd: "{{.apk}} goreleaser*_x86_64.apk"
      - task: goreleaser:test:pkg
        vars:
          Platform: "arm64"
          Image: alpine
          Cmd: "{{.apk}} goreleaser*_aarch64.apk"
      - task: goreleaser:test:pkg
        vars:
          Platform: "arm/7"
          Image: alpine
          Cmd: "{{.apk}} goreleaser*_armv7.apk"

  goreleaser:test:
    desc: Test built linux packages
    cmds:
      - task: goreleaser:test:apk
      - task: goreleaser:test:deb
      - task: goreleaser:test:rpm

  goreleaser:
    desc: Run GoReleaser either in snapshot or release mode
    deps:
      - build
    vars:
      SNAPSHOT:
        sh: 'if [[ $GITHUB_REF != refs/tags/v* ]]; then echo "--snapshot"; fi'
    cmds:
      - ./goreleaser release --clean --timeout 60m {{.SNAPSHOT}}

  nightly:watch:
    vars:
      RUN_ID:
        sh: "gh run list --workflow=nightly-oss.yml --limit 1 --json databaseId | jq -r '.[] | .databaseId'"
    cmds:
      - gh run watch {{.RUN_ID}}

  nightly:
    cmds:
      - gh run list --workflow=nightly-oss.yml
      - gh workflow run nightly-oss.yml
      - sleep 5
      - task: nightly:watch

  licenses:check:
    cmds:
      - |
        go run github.com/google/go-licenses/v2@latest check \
          --allowed_licenses=MIT,Apache-2.0,BSD-3-Clause,BSD-2-Clause,ISC,MPL-2.0 \
          --ignore github.com/in-toto \
          --ignore github.com/multiformats/go-base36 \
          --ignore github.com/ipfs/bbloom \
          --ignore github.com/cyberphone/json-canonicalization/go/src/webpki.org/jsoncanonicalizer \
          ./...