Taskfile.yml

# https://taskfile.dev
# To run on a system without task installed, `./scripts/run_task.sh` will execute it with `go run`.
# If in the nix dev shell, `task` is available.

version: '3'

env:
  AVALANCHEGO_BUILD_PATH: '{{.AVALANCHEGO_BUILD_PATH | default (printf "%s/avalanchego/build" .TASKFILE_DIR) }}'

tasks:
  default: ./scripts/run_task.sh --list

  actionlint:
    desc: Validate GitHub Actions workflows and ensure scripts use run_task.sh for reproducibility
    cmd: ./scripts/actionlint.sh # ci.yml

  build:
    desc: Compile Coreth binary with git commit and static linking flags
    cmd: ./scripts/build.sh # ci.yml

  build-avalanchego-with-coreth:
    desc: Build AvalancheGo binary with Coreth dependency pointing to local Coreth path
    cmd: ./scripts/build_avalanchego_with_coreth.sh # ci.yml

  build-test:
    desc: Run all Go tests with retry logic for flaky tests, race detection, and coverage reporting
    cmd: ./scripts/build_test.sh # ci.yml

  check-avalanchego-version:
    desc: Ensure consistent avalanchego version by updating and checking for changes
    cmds:
      - task: update-avalanchego-version
      - cmd: git diff --exit-code

  check-clean-branch:
    desc: Checks that the git working tree is clean
    cmds:
      - cmd: git add --all
      - cmd: git update-index --really-refresh >> /dev/null
      - cmd: git status --short # Show the status of the working tree.
      - cmd: git diff-index --quiet HEAD # Exits if any uncommitted changes are found.

  check-generate-codec:
    desc: Checks that generated codec files are up-to-date (requires a clean git working tree)
    cmds:
      - task: generate-codec
      - task: check-clean-branch

  check-generate-mocks:
    desc: Checks that generated mocks are up-to-date (requires a clean git working tree)
    cmds:
      - task: generate-mocks
      - task: check-clean-branch

  check-generate-rlp:
    desc: Checks that generated rlp files are up-to-date (requires a clean git working tree)
    cmds:
      - task: generate-rlp
      - task: check-clean-branch

  check-go-mod-tidy:
    desc: Checks that all go.mod and go.sum files are up-to-date (requires a clean git working tree)
    cmds:
      - cmd: go mod tidy
      - task: check-clean-branch
      - cmd: cd tools && go mod tidy
      - task: check-clean-branch

  coverage:
    desc: Display test coverage statistics from coverage.out file
    cmd: ./scripts/coverage.sh # ci.yml

  generate-codec:
    desc: Generates fjl/gencodec files
    cmds:
      - cmd: grep -lr -E '^// Code generated by github\.com\/fjl\/gencodec\. DO NOT EDIT\.$' . | xargs -r rm
      - cmd: go generate -run gencodec ./...

  generate-mocks:
    desc: Generates testing mocks
    cmds:
      - cmd: grep -lr -E '^// Code generated by MockGen\. DO NOT EDIT\.$' . | xargs -r rm
      - cmd: go generate -run mockgen ./...

  generate-rlp:
    desc: Generates rlp files
    cmds:
      - cmd: grep -lr -E '^// Code generated by rlpgen\. DO NOT EDIT.\.$' . | xargs -r rm
      - cmd: go generate -run rlpgen ./...

  lint:
    desc: Run golangci-lint and check for allowed Ethereum imports in Go code
    cmd: ./scripts/lint.sh

  lint-all:
    desc: Runs all lint checks in parallel
    deps:
      - lint
      - actionlint
      - shellcheck
      - check-generate-codec
      - check-generate-mocks
      - check-generate-rlp

  lint-all-ci:
    desc: Runs all lint checks one-by-one
    cmds:
      - task: lint
      - task: actionlint
      - task: shellcheck
      - task: check-generate-codec
      - task: check-generate-mocks
      - task: check-generate-rlp
  
  lint-fix:
    desc: Run golangci-lint with auto-fix where possible
    cmd: ./scripts/lint_fix.sh

  shellcheck:
    desc: Run shellcheck static analysis on all shell scripts with version management
    cmd: ./scripts/shellcheck.sh # ci.yml

  test-e2e:
    desc: Run AvalancheGo e2e tests from target version against current state of coreth
    cmd: ./scripts/tests.e2e.sh # ci.yml

  test-e2e-ci:
    desc: Run AvalancheGo e2e tests from target version against current state of coreth, cloning and building avalanchego if necessary
    cmds:
      - task: build-avalanchego-with-coreth
      - task: test-e2e

  test-e2e-warp:
    desc: Run end-to-end warp tests using Ginkgo test framework
    cmd: bash -x ./scripts/run_ginkgo_warp.sh # ci.yml

  test-e2e-warp-ci: # consolidated test-e2e-warp
    desc: Run E2E warp tests with CI setup
    cmds:
      - task: build-avalanchego-with-coreth
      - task: build
      - task: test-e2e-warp

  update-avalanchego-version:
    desc: Update AvalancheGo version in go.mod and sync GitHub Actions workflow custom action version
    cmd: bash -x ./scripts/update_avalanchego_version.sh # ci.yml