test(ci): improve CI caching; cancel concurrent runs to prioritize latest; add .cursorignore (#89)

test(ci): improve CI caching; cancel concurrent runs to prioritize latest; add `.cursorignore`

Author: Unique-Divine

.cursorignore

@@ -0,0 +1,35 @@
+# .cursorignore
+#
+# ## .cursorignore Syntax Exmaple
+# It's generally close to .gitignore syntax with. Examples:
+# config.json     # Specific file
+# dist/           # Directory
+# *.log           # File extension
+# **/logs         # Nested directories
+# !app/           # Exclude from ignore (negate)
+#
+# -----------------------------------------------------------------
+# Files in the .gitignore are ignored by default.
+# To intentionally NOT ignore patterns from .gitignore, uncomment the following:
+# !.gitignore
+
+# Additional patterns specific to Cursor
+.env*
+**/credentials/*
+**/secrets/*
+private/
+confidential/
+
+# Large binary files and datasets
+*.bin
+*.dat
+*.db
+*.sqlite
+*.sqlite3
+
+# Temporary files
+*.tmp
+*~
+
+# This is git ignored, so it needs to be explicitly negated for your agent to see it.
+!out.txt 

.github/workflows/golangcli-lint.yml

@@ -11,8 +11,8 @@ jobs:
       - uses: seferov/pr-lint-action@v1.2.0
         with:
           # taken from https://gist.github.com/marcojahn/482410b728c31b221b70ea6d2c433f0c
-          title-regex: '^(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\([\w\-\.]+\))?(!)?: ([\w ])+([\s\S]*)'
+          title-regex: '^(evm|build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test){1}(\([\w\-\.\/]+\))?(!)?: ([\w ])+([\s\S]*)'
           # title-regex-flags (Optional)
-          title-regex-flags: "g" 
+          title-regex-flags: "g"
           # error-message (Optional)
-          error-message: "Please follow conventional commit style: https://www.conventionalcommits.org/en/v1.0.0/" 
+          error-message: "Please follow conventional commit style: https://www.conventionalcommits.org/en/v1.0.0/"

.github/workflows/pr-tittle-lint.yml

@@ -2,41 +2,132 @@ name: Tests
 
 on:
   pull_request:
-    paths: ["**.go", "go.mod", "go.sum"]
   push:
-    branches:
-      - main
+    branches: ["main"]
+  workflow_dispatch:
+
+# Allow concurrent runs on main/release branches but isolates other branches
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.head_ref }}
+  cancel-in-progress: ${{ ! (github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/heads/release/')) }}
 
 jobs:
   unit-tests:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
 
+      - name: "Check for Go-related changes"
+        id: check_go
+        uses: dorny/paths-filter@v3
+        with:
+          filters: |
+            check_go:
+              - "**/*.go"
+              - "go.mod"
+              - "go.sum"
+              - "justfile"
+
       - name: Set up Go
+        if: steps.check_go.outputs.check_go == 'true'
         uses: actions/setup-go@v5
         with:
           go-version-file: go.mod
+          # cache: "The action has a built-in functionality for caching and
+          # restoring go modules and build outputs. It uses [actions/cache@v4]."
+          # - Handles go module cache (go env GOMODCACHE).
+          # - Handles go build cache (go env GOCACHE).
           cache: true
 
       - name: "Install just"
+        if: steps.check_go.outputs.check_go == 'true'
         # casey/just: https://just.systems/man/en/chapter_6.html
         # taiki-e/install-action: https://github.com/taiki-e/install-action
         uses: taiki-e/install-action@just
 
-      - name: Run all tests.
-        run: just test
+      - run: just test
+        if: steps.check_go.outputs.check_go == 'true'
 
   build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
 
+      - name: "Check for Go-related changes"
+        id: check_go
+        uses: dorny/paths-filter@v3
+        with:
+          filters: |
+            check_go:
+              - "**/*.go"
+              - "go.mod"
+              - "go.sum"
+              - "justfile"
+
       - name: Set up Go
+        if: steps.check_go.outputs.check_go == 'true'
         uses: actions/setup-go@v5
         with:
           go-version-file: go.mod
+          # cache: "The action has a built-in functionality for caching and
+          # restoring go modules and build outputs. It uses [actions/cache@v4]."
+          # - Handles go module cache (go env GOMODCACHE).
+          # - Handles go build cache (go env GOCACHE).
           cache: true
 
-      - name: Run all tests.
+      - if: steps.check_go.outputs.check_go == 'true'
         run: make build
+
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: "Check for Go-related changes"
+        id: check_go
+        uses: dorny/paths-filter@v3
+        with:
+          filters: |
+            check_go:
+              - "**/*.go"
+              - "go.mod"
+              - "go.sum"
+              - "justfile"
+
+      - uses: actions/setup-go@v5
+        if: steps.check_go.outputs.check_go == 'true'
+        with:
+          go-version-file: go.mod
+          # cache: "The action has a built-in functionality for caching and
+          # restoring go modules and build outputs. It uses [actions/cache@v4]."
+          # - Handles go module cache (go env GOMODCACHE).
+          # - Handles go build cache (go env GOCACHE).
+          cache: true # Note that golangci-lint action already caches for us (https://github.com/golangci/golangci-lint-action#performance)
+
+      - name: golangci-lint
+        if: steps.check_go.outputs.check_go == 'true'
+        uses: golangci/golangci-lint-action@v8
+        with:
+          # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
+          version: v2.6.1
+
+          # Optional: working directory, useful for monorepos
+          # working-directory: somedir
+
+          # Optional: golangci-lint command line arguments.
+          args: --fix=false
+
+          # Optional: show only new issues if it's a pull request. The default
+          #   value is `false`.
+          # only-new-issues: true
+
+          # Optional: if set to true then the all caching functionality will be
+          # completely disabled. Takes precedence over all other caching options.
+          skip-cache: false
+
+          # Optional: if set to true then the action won't cache or restore ~/go/pkg.
+          # skip-pkg-cache: true
+
+          # Optional: if set to true then the action won't cache or restore ~/.cache/go-build.
+          # skip-build-cache: true

.github/workflows/skip-golangci-lint.yml

@@ -24,7 +24,7 @@ test *ARGS:
   echo "Note that you can pass args to augment the test command."
   echo "For example: just test ./feeder/... -run TestFeeder"
   echo "  becomes -> go test ./feeder/... -run TestFeeder 2>&1 | tee out.txt"
-  echo -e "\nThis takes a few minutes to run. The '.' getting printed signifies 2 seconds have passed."
+  echo -e "\nThis takes a ~4 minutes to run. The '.' getting printed signifies 2 seconds have passed."
 
   args="{{ARGS}}"
   args="${args:-./...}"
@@ -77,6 +77,18 @@ install:
 # Alias for both build and install
 build-install: build install
 
-# Runs golang formatter (gofumpt)
+# Run golang formatter (gofumpt)
 fmt:
   gofumpt -w .
+
+# Run `golangci-lint` with docker
+lint: 
+  #!/usr/bin/env bash
+  echo "Running golangci-lint with docker!"
+  image_version="v2.6.1"
+  docker run --rm \
+    -v "$(pwd)":/app \
+    -v ~/.cache/golangci-lint/$image_version:/root/.cache \
+    -w /app \
+    golangci/golangci-lint:$image_version \
+    golangci-lint run -v --fix 2>&1