lint.yml

name: Lint
# This workflow is run on every pull request and push to master
# The `golangci` will pass without running if no *.{go, mod, sum} files have been changed.
on:
  pull_request:
    paths:
      - "**.go"
      - "go.mod"
      - "go.sum"
  push:
    branches:
      - main
      - "release/*"
    paths:
      - "**.go"
      - "go.mod"
      - "go.sum"

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  golangci:
    env:
      GOPRIVATE: github.com/initia-labs
      GITHUB_ACCESS_TOKEN: ${{ secrets.GH_READ_TOKEN }}
      GOLANGCI_LINT_VERSION: v1.59.1
    name: golangci-lint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-go@v5
        with:
          go-version: 1.22
          check-latest: true
      - uses: technote-space/get-diff-action@v6.1.2
        id: git_diff
        with:
          PATTERNS: |
            **/**.go
            go.mod
            go.sum
      - run: git config --global url.https://${GITHUB_ACCESS_TOKEN}:x-oauth-basic@github.com/.insteadOf https://github.com/
      # install golangci-lint
      - run: go install github.com/golangci/golangci-lint/cmd/golangci-lint@${GOLANGCI_LINT_VERSION}
      - name: run go linters (long)
        if: env.GIT_DIFF
        id: lint_long
        run: |
          make lint
        env:
          GIT_DIFF: ${{ env.GIT_DIFF }}
      - uses: technote-space/get-diff-action@v6.1.2
        if: steps.lint_long.outcome == 'skipped'
        with:
          PATTERNS: |
            **/**.go
            go.mod
            go.sum
      - name: run go linters (short)
        if: steps.lint_long.outcome == 'skipped' && env.GIT_DIFF
        run: |
          make lint
        env:
          GIT_DIFF: ${{ env.GIT_DIFF }}
          LINT_DIFF: 1
  # Use --check or --exit-code when available (Go 1.19?)
  # https://github.com/golang/go/issues/27005
  tidy:
    env:
      # for private repo access
      GOPRIVATE: github.com/initia-labs,github.com/skip-mev/slinky
      GITHUB_ACCESS_TOKEN: ${{ secrets.GH_READ_TOKEN }}
    runs-on: ubuntu-latest
    name: tidy
    steps:
      - uses: actions/checkout@v4
      - name: Setup go
        uses: actions/setup-go@v5
        with:
          go-version: 1.22
          check-latest: true
      - run: git config --global url.https://${GITHUB_ACCESS_TOKEN}:x-oauth-basic@github.com/.insteadOf https://github.com/
      - run: |
          go mod tidy
          CHANGES_IN_REPO=$(git status --porcelain)
          if [[ -n "$CHANGES_IN_REPO" ]]; then
            echo "Repository is dirty. Showing 'git status' and 'git --no-pager diff' for debugging now:"
            git status && git --no-pager diff
            exit 1
          fi