Taskfile.yml

# yaml-language-server: $schema=https://taskr-io.vercel.app/schema.json
version: '3'
banner: true
categories: ["core"]

includes:
  website:
    aliases: [w, docs, d]
    taskfile: ./website
    dir: ./website

vars:
  BIN: "{{.ROOT_DIR}}/bin"
  GOTESTSUM_FORMAT: '{{if .CI}}github-actions{{else}}pkgname{{end}}'
  INSTALL_PATH:
    sh: go env GOPATH
  TASKR_BINARY: "{{.INSTALL_PATH}}/bin/taskr{{exeExt}}"

env:
  CGO_ENABLED: '0'

tasks:
  default:
    category: core
    cmds:
      - taskr --list

  run:
    category: core
    desc: Runs Task
    cmds:
      - go run ./cmd/taskr {{.CLI_ARGS}}

  install:
    category: core
    desc: Installs taskr (incremental build, skips if up-to-date)
    aliases: [i]
    sources:
      - './**/*.go'
      - 'go.mod'
      - 'go.sum'
    generates:
      - "{{.TASKR_BINARY}}"
    method: checksum
    cmds:
      - go install -v ./cmd/taskr

  reinstall:
    category: core
    desc: Force reinstall taskr binary (always rebuilds and installs)
    aliases: [ri]
    cmds:
      - cmd: echo "🗑️  Removing old binary..."
        silent: true
      - rm -f {{.TASKR_BINARY}}
      - cmd: echo "🔨 Rebuilding and installing taskr..."
        silent: true
      - go install -v ./cmd/taskr
      - cmd: echo "✅ taskr reinstalled successfully!"
        silent: true
      - cmd: echo "📍 Location{{":"}} {{.TASKR_BINARY}}"
        silent: true
      - cmd: taskr --version
        silent: true

  verify-install:
    category: core
    desc: Verify taskr is installed and working correctly
    aliases: [verify, check-install]
    cmds:
      - cmd: echo "📍 Checking installation..."
        silent: true
      - cmd: |
          if [ -f "{{.TASKR_BINARY}}" ]; then
            echo "✅ Binary exists{{":"}} {{.TASKR_BINARY}}"
            echo "📦 Version{{":"}}";
            taskr --version;
            echo "✅ Installation verified!";
          else
            echo "❌ Binary not found{{":"}} {{.TASKR_BINARY}}";
            echo "💡 Run 'taskr install' or 'taskr reinstall' to install";
            exit 1;
          fi
        silent: true

  build:
    category: core
    desc: Build taskr binary to ./bin directory (for local testing)
    aliases: [b]
    sources:
      - './**/*.go'
      - 'go.mod'
      - 'go.sum'
    generates:
      - "{{.BIN}}/taskr{{exeExt}}"
    cmds:
      - mkdir -p {{.BIN}}
      - go build -v -o {{.BIN}}/taskr{{exeExt}} ./cmd/taskr
      - cmd: echo "✅ Built{{":"}} {{.BIN}}/taskr{{exeExt}}"
        silent: true

  dev:
    category: core
    desc: Quick development cycle (reinstall + run with args)
    cmds:
      - task: reinstall
      - taskr {{.CLI_ARGS}}

  generate:
    category: generate
    aliases: [gen, g]
    desc: Runs all generate tasks
    cmds:
      - task: generate:mocks
      - task: generate:fixtures

  generate:mocks:
    category: generate
    desc: Runs Mockery to create mocks
    aliases: [gen:mocks, g:mocks]
    deps: [install:mockery]
    sources:
      - "internal/fingerprint/checker.go"
    generates:
      - "internal/mocks/*.go"
    cmds:
      - find . -type f -name *_mock.go -delete
      - "{{.BIN}}/mockery"

  generate:fixtures:
    category: generate
    desc: Runs tests and generates golden fixture files
    aliases: [gen:fixtures, g:fixtures]
    env:
      GOLDIE_UPDATE: 'true'
      GOLDIE_TEMPLATE: 'true'
    cmds:
      - find ./testdata -name '*.golden' -delete
      - go test ./...

  install:mockery:
    category: generate
    index: 1
    desc: Installs mockgen; a tool to generate mock files
    vars:
      MOCKERY_VERSION: v3.2.2
    env:
      GOBIN: "{{.BIN}}"
    status:
      - go version -m {{.BIN}}/mockery | grep github.com/vektra/mockery | grep {{.MOCKERY_VERSION}}
    cmds:
      - GOBIN="{{.BIN}}" go install github.com/vektra/mockery/v3@{{.MOCKERY_VERSION}}

  mod:
    category: maintenance
    desc: Downloads and tidy Go modules
    cmds:
      - go mod download
      - go mod tidy

  clean:
    category: maintenance
    desc: Cleans temp files and folders
    aliases: [clear]
    cmds:
      - rm -rf dist/
      - rm -rf tmp/

  clean:all:
    category: maintenance
    desc: Cleans temp files, folders, and installed binaries
    aliases: [clean-all, clear-all]
    cmds:
      - task: clean
      - rm -f {{.TASKR_BINARY}}
      - rm -f {{.BIN}}/taskr{{exeExt}}
      - cmd: echo "✅ All clean!"
        silent: true

  lint:
    category: core
    desc: Runs golangci-lint
    aliases: [l]
    sources:
      - './**/*.go'
      - .golangci.yml
      - go.mod
    cmds:
      - golangci-lint run

  lint:fix:
    category: core
    desc: Runs golangci-lint and fixes any issues
    sources:
      - './**/*.go'
      - .golangci.yml
      - go.mod
    cmds:
      - golangci-lint run --fix

  format:
    category: core
    desc: Runs golangci-lint and formats any Go files
    aliases: [fmt, f]
    sources:
      - './**/*.go'
      - .golangci.yml
    cmds:
      - golangci-lint fmt

  sleepit:build:
    category: maintenance
    desc: Builds the sleepit test helper
    sources:
      - ./cmd/sleepit/**/*.go
    generates:
      - "{{.BIN}}/sleepit{{exeExt}}"
    cmds:
      - go build -o {{.BIN}}/sleepit{{exeExt}} ./cmd/sleepit

  sleepit:run:
    category: maintenance
    desc: Builds the sleepit test helper
    deps: [sleepit:build]
    cmds:
      - "{{.BIN}}/sleepit {{.CLI_ARGS}}"
    silent: true

  test:
    category: test
    desc: Runs test suite
    aliases: [t]
    deps: [gotestsum:install]
    sources:
      - "**/*.go"
      - "testdata/**/*"
    cmds:
      - gotestsum -f '{{.GOTESTSUM_FORMAT}}' ./...

  test:watch:
    category: test
    desc: Runs test suite with watch tests included
    deps: [sleepit:build, gotestsum:install]
    cmds:
      - gotestsum -f '{{.GOTESTSUM_FORMAT}}' ./... -tags 'watch'

  test:all:
    category: test
    desc: Runs test suite with signals and watch tests included
    deps: [sleepit:build, gotestsum:install]
    cmds:
      - gotestsum -f '{{.GOTESTSUM_FORMAT}}' -tags 'signals watch' ./...

  goreleaser:test:
    category: release
    desc: Tests release process without publishing
    cmds:
      - goreleaser --snapshot --clean

  gotestsum:install:
    category: release
    desc: Installs gotestsum
    status:
      - command -v gotestsum
    cmds:
      - go install gotest.tools/gotestsum@latest

  goreleaser:install:
    category: release
    desc: Installs goreleaser
    cmds:
      - go install github.com/goreleaser/goreleaser/v2@latest

  gorelease:install:
    category: release
    desc: "Installs gorelease: https://pkg.go.dev/golang.org/x/exp/cmd/gorelease"
    status:
      - command -v gorelease
    cmds:
      - go install golang.org/x/exp/cmd/gorelease@latest

  apicheck:
    category: core
    desc: Checks what changes have been made to the public API
    deps: [gorelease:install]
    vars:
      LATEST:
        sh: git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0"
    cmds:
      - gorelease -base={{.LATEST}}

  release:*:
    category: release
    desc: Prepare the project for a new release
    summary: |
      This task will do the following:

      - Update the version and date in the CHANGELOG.md file
      - Update the version in the package.json and package-lock.json files
      - Copy the latest docs to the "current" version on the website
      - Commit the changes
      - Create a new tag
      - Push the commit/tag to the repository
      - Create a GitHub release

      To use the task, run "taskr release:<version>" where "<version>" is is one of:

      - "major" - Bumps the major number
      - "minor" - Bumps the minor number
      - "patch" - Bumps the patch number
      - A semver compatible version number (e.g. "1.2.3")
    vars:
      VERSION:
        sh: "go run ./cmd/release --version {{index .MATCH 0}}"
      COMPLETE_MESSAGE: |
        Creating release with GoReleaser: https://github.com/vikbert/taskr/actions/workflows/release.yml

        Please wait for the CI to finish and then do the following:

        - Copy the changelog for v{{.VERSION}} to the GitHub release
        - Run 'taskr release:package-managers' to publish to package managers
    preconditions:
      - sh: test $(git rev-parse --abbrev-ref HEAD) = "main"
        msg: "You must be on the main branch to release"
      - sh: "[[ -z $(git diff --shortstat main) ]]"
        msg: "You must have a clean working tree to release"
    prompt: "Are you sure you want to release version {{.VERSION}}?"
    cmds:
      - cmd: echo "Releasing v{{.VERSION}}"
        silent: true
      - "go run ./cmd/release {{.VERSION}}"
      - "git add --all"
      - "git commit -m v{{.VERSION}}"
      - "git push"
      - "git tag v{{.VERSION}}"
      - "git push origin tag v{{.VERSION}}"
      - cmd: printf "%s" '{{.COMPLETE_MESSAGE}}'
        silent: true

  release:package-managers:
    category: release
    desc: Manual steps to publish Taskr to various package managers
    summary: |
      This task provides step-by-step instructions for manually publishing Taskr
      to various package managers after a release has been created.

      Required: Run this after 'taskr release:<version>' has completed and GoReleaser has finished.
    cmds:
      - cmd: echo "🚀 Taskr Package Manager Publishing Guide"
        silent: true
      - cmd: |
          echo ""
          echo "📋 Prerequisites:"
          echo "   - Release created with: taskr release:<version>"
          echo "   - GoReleaser CI completed: https://github.com/vikbert/taskr/actions/workflows/release.yml"
          echo "   - Release tag created and pushed"
          echo ""
          echo "📦 Package Managers to Update:"
          echo ""
        silent: true
      - cmd: |
          echo "1. 🏠 Homebrew (macOS/Linux)"
          echo "   • Fork: https://github.com/go-task/homebrew-tap"
          echo "   • Create your tap: https://github.com/vikbert/homebrew-taskr"
          echo "   • Update Formula/taskr.rb with new version and SHA256"
          echo "   • Submit PR to your tap repository"
          echo ""
        silent: true
      - cmd: |
          echo "2. 📦 npm (Cross-platform)"
          echo "   • Publish to npm: npm publish"
          echo "   • Package name: @vikbert/taskr or @taskr/cli"
          echo "   • Update package.json with correct version"
          echo ""
        silent: true
      - cmd: |
          echo "3. 📱 Snap (Linux)"
          echo "   • Repository: https://github.com/vikbert/snap"
          echo "   • Update snap/snapcraft.yaml with new version"
          echo "   • Push changes to trigger automated build"
          echo ""
        silent: true
      - cmd: |
          echo "4. 🪟 WinGet (Windows)"
          echo "   • Repository: https://github.com/microsoft/winget-pkgs"
          echo "   • Submit PR to add/update Taskr.Task package manifest"
          echo "   • Use the installer URL from GitHub releases"
          echo ""
        silent: true
      - cmd: |
          echo "5. 🌐 Cloudsmith (RPM/DEB)"
          echo "   • Create Taskr repository: https://cloudsmith.io/~vikbert/repos/taskr"
          echo "   • Upload RPM/DEB packages from GoReleaser artifacts"
          echo "   • Update repository metadata"
          echo ""
        silent: true
      - cmd: |
          echo "6. 🤝 Community Package Managers"
          echo "   • Chocolatey: Submit PR to https://github.com/chocolatey-community/chocolatey-coreteampackages"
          echo "   • Scoop: Submit PR to https://github.com/ScoopInstaller/Main"
          echo "   • Arch Linux: Submit PR to https://gitlab.archlinux.org/archlinux/packaging/packages/go-task"
          echo "   • Fedora: Submit PR to https://src.fedoraproject.org/rpms/golang-github-task"
          echo "   • Nix: Submit PR to https://github.com/NixOS/nixpkgs"
          echo "   • FreeBSD: Submit PR to https://cgit.freebsd.org/ports/tree/devel/task"
          echo ""
        silent: true
      - cmd: |
          echo "🔧 Automation Helpers:"
          echo "   • GitHub Action: Create fork of go-task/setup-task"
          echo "   • Mise integration: Already configured for vikbert/taskr"
          echo "   • pkgx: Already configured for taskr-io.vercel.app"
          echo ""
          echo "📋 Quick Commands Reference:"
          echo ""
          echo "   # Check current release status"
          echo "   gh release list --repo vikbert/taskr"
          echo ""
          echo "   # Download release artifacts (if needed)"
          echo "   gh release download v{{.VERSION}} --repo vikbert/taskr"
          echo ""
          echo "   # Update Homebrew formula example:"
          echo "   brew bump-formula-pr --url https://github.com/vikbert/taskr/archive/v{{.VERSION}}.tar.gz taskr"
          echo ""
          echo "📝 Remember to update installation docs after publishing!"
        silent: true