add ci-lint gha for chaincli (#10732)

* add ci-lint gha for chaincli * remove composite setup-go action * fix go build path * use GITHUB_WORKSPACE for absolute path * use cd instead direct build * fix build bug * golangci-lint target only core/scripts/chaincli * fix args * use working-directory flag * add back remove flags * change job name * fix report stored path * revert removal of asset change * add core/web/assets/index.html to workflow step * refactor: update setup-go@v4 and cleaner implementation * name match * refactor golangci-lint into a composite action * add actions/checkout * add shell: bash * add shell: bash * fix bugs * more fixes * fix key * fix key * add working-directory * correct place * remove go-directory in setup-go * refactor core-ci to use ci-golang-lint composite action * rename composite gha ci-golang-lint to golangci-lint
smartcontractkit · Oct 10, 2023 · 37673f4 · 37673f4
1 parent 5e51734
commit 37673f4
Show file tree

Hide file tree

Showing 6 changed files with 158 additions and 70 deletions.
diff --git a/.github/actions/golangci-lint/action.yml b/.github/actions/golangci-lint/action.yml
@@ -0,0 +1,77 @@
+name: CI lint for Golang
+description: Runs CI lint for Golang
+inputs:
+  # general inputs
+  name:
+    description: Name of the lint action
+    default: lint
+  go-directory:
+    description: Go directory to run commands from
+    default: "."
+  # setup-go inputs
+  only-modules:
+    description: Set to 'true' to only cache modules
+    default: "false"
+  cache-version:
+    description: Set this to cache bust
+    default: "1"
+  go-version-file:
+    description: Set where the go version file is located at
+    default: "go.mod"
+  go-module-file:
+    description: Set where the go module file is located at
+    default: "go.sum"
+  # grafana cloud inputs
+  gc-host:
+    description: "grafana cloud hostname"
+  gc-basic-auth:
+    description: "grafana cloud basic auth"
+
+runs:
+  using: composite
+  steps:
+    - uses: actions/checkout@v4
+    - name: Setup Go
+      uses: ./.github/actions/setup-go
+      with:
+        only-modules: ${{ inputs.only-modules }}
+        cache-version: ${{ inputs.cache-version }}
+        go-version-file: ${{ inputs.go-version-file }}
+        go-module-file: ${{ inputs.go-module-file }}
+    - name: Touching core/web/assets/index.html
+      shell: bash
+      run: mkdir -p core/web/assets && touch core/web/assets/index.html
+    - name: Build binary
+      if: ${{ inputs.go-directory == '.' }}
+      shell: bash
+      run: go build ./...
+    - name: Build binary
+      if: ${{ inputs.go-directory != '.' }}
+      working-directory: ${{ inputs.go-directory }}
+      shell: bash
+      run: go build
+    - name: golangci-lint
+      uses: golangci/golangci-lint-action@3a919529898de77ec3da873e3063ca4b10e7f5cc # v3.7.0
+      with:
+        version: v1.54.2
+        # We already cache these directories in setup-go
+        skip-pkg-cache: true
+        skip-build-cache: true
+        # only-new-issues is only applicable to PRs, otherwise it is always set to false
+        only-new-issues: true
+        args: --out-format colored-line-number,checkstyle:golangci-lint-report.xml
+        working-directory: ${{ inputs.go-directory }}
+    - name: Store lint report artifact
+      if: always()
+      uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
+      with:
+        name: golangci-lint-report
+        path: ${{ inputs.go-directory }}/golangci-lint-report.xml
+    - name: Collect Metrics
+      if: always()
+      uses: smartcontractkit/push-gha-metrics-action@d2c2b7bdc9012651230b2608a1bcb0c48538b6ec
+      with:
+        basic-auth: ${{ inputs.gc-basic-auth }}
+        hostname: ${{ inputs.gc-host }}
+        this-job-name: ${{ inputs.name }}
+      continue-on-error: true
diff --git a/.github/actions/setup-go/action.yml b/.github/actions/setup-go/action.yml
@@ -1,53 +1,64 @@
 name: Setup Go
-description: Setup Golang with efficient caching 
+description: Setup Golang with efficient caching
 inputs:
   only-modules:
     description: Set to 'true' to only cache modules
-    default: 'false'
+    default: "false"
   cache-version: 
     description: Set this to cache bust
     default: "1"
+  go-version-file:
+    description: Set where the go version file is located at
+    default: "go.mod"
+  go-module-file:
+    description: Set where the go module file is located at
+    default: "go.sum"
 
 runs:
   using: composite
   steps:
-      - name: Set up Go
-        uses: actions/setup-go@v3
-        with:
-          go-version-file: "go.mod"
-          cache: false
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version-file: ${{ inputs.go-version-file }}
+        cache: false
 
-      - name: Get branch name
-        if: ${{ inputs.only-modules == 'false' }}
-        id: branch-name
-        uses: tj-actions/branch-names@2e5354c6733793113f416314375826df030ada23 #v6.5
+    - name: Get branch name
+      if: ${{ inputs.only-modules == 'false' }}
+      id: branch-name
+      uses: tj-actions/branch-names@2e5354c6733793113f416314375826df030ada23 #v6.5
 
-      - name: Set go cache keys
-        shell: bash
-        id: go-cache-dir
-        run: | 
-          echo "gomodcache=$(go env GOMODCACHE)" >> $GITHUB_OUTPUT 
-          echo "gobuildcache=$(go env GOCACHE)" >> $GITHUB_OUTPUT
+    - name: Set go cache keys
+      shell: bash
+      id: go-cache-dir
+      run: |
+        echo "gomodcache=$(go env GOMODCACHE)" >> $GITHUB_OUTPUT
+        echo "gobuildcache=$(go env GOCACHE)" >> $GITHUB_OUTPUT
 
-      - uses: actions/cache@v3
-        name: Cache Go Modules
-        with:
-          path: |
-            ${{ steps.go-cache-dir.outputs.gomodcache }}
-          # The lifetime of go modules is much higher than the build outputs, so we increase cache efficiency
-          # here by not having the primary key contain the branch name
-          key: ${{ runner.os }}-gomod-${{ inputs.cache-version }}-${{ hashFiles('./go.sum') }}
-          restore-keys: |
-            ${{ runner.os }}-gomod-${{ inputs.cache-version }}-
+    - name: Set go module path
+      id: go-module-path
+      shell: bash
+      run: echo "path=./${{ inputs.go-module-file }}" >> $GITHUB_OUTPUT
 
-      - uses: actions/cache@v3
-        if: ${{ inputs.only-modules == 'false' }}
-        name: Cache Go Build Outputs
-        with:
-          path: |
-            ${{ steps.go-cache-dir.outputs.gobuildcache }}
-          # The lifetime of go build outputs is pretty short, so we make our primary cache key be the branch name
-          key: ${{ runner.os }}-gobuild-${{ inputs.cache-version }}-${{ hashFiles('./go.sum') }}-${{ steps.branch-name.outputs.current_branch }}
-          restore-keys: |
-            ${{ runner.os }}-gobuild-${{ inputs.cache-version }}-${{ hashFiles('./go.sum') }}-
-            ${{ runner.os }}-gobuild-${{ inputs.cache-version }}-
+    - uses: actions/cache@v3
+      name: Cache Go Modules
+      with:
+        path: |
+          ${{ steps.go-cache-dir.outputs.gomodcache }}
+        # The lifetime of go modules is much higher than the build outputs, so we increase cache efficiency
+        # here by not having the primary key contain the branch name
+        key: ${{ runner.os }}-gomod-${{ inputs.cache-version }}-${{ hashFiles(steps.go-module-path.output.path) }}
+        restore-keys: |
+          ${{ runner.os }}-gomod-${{ inputs.cache-version }}-
+
+    - uses: actions/cache@v3
+      if: ${{ inputs.only-modules == 'false' }}
+      name: Cache Go Build Outputs
+      with:
+        path: |
+          ${{ steps.go-cache-dir.outputs.gobuildcache }}
+        # The lifetime of go build outputs is pretty short, so we make our primary cache key be the branch name
+        key: ${{ runner.os }}-gobuild-${{ inputs.cache-version }}-${{ hashFiles(steps.go-module-path.output.path) }}-${{ steps.branch-name.outputs.current_branch }}
+        restore-keys: |
+          ${{ runner.os }}-gobuild-${{ inputs.cache-version }}-${{ hashFiles(steps.go-module-path.output.path) }}-
+          ${{ runner.os }}-gobuild-${{ inputs.cache-version }}-
diff --git a/.github/workflows/ci-chaincli.yml b/.github/workflows/ci-chaincli.yml
@@ -0,0 +1,26 @@
+name: chaincli CI
+
+on:
+  push:
+    paths:
+      - "core/scripts/chaincli/**"
+  pull_request:
+    paths:
+      - "core/scripts/chaincli/**"
+
+jobs:
+  golangci:
+    if: ${{ github.event_name == 'pull_request' ||  github.event_name == 'schedule' }}
+    name: chaincli-lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Golang Lint
+        uses: ./.github/actions/golangci-lint
+        with:
+          name: chaincli-lint
+          go-directory: core/scripts/chaincli
+          go-version-file: core/scripts/go.mod
+          go-module-file: core/scripts/go.sum
+          gc-basic-auth: ${{ secrets.GRAFANA_CLOUD_BASIC_AUTH }}
+          gc-host: ${{ secrets.GRAFANA_CLOUD_HOST }}
diff --git a/.github/workflows/ci-core.yml b/.github/workflows/ci-core.yml
@@ -23,36 +23,11 @@ jobs:
     runs-on: ubuntu20.04-8cores-32GB
     steps:
       - uses: actions/checkout@v4
-      - name: Setup Go
-        uses: ./.github/actions/setup-go
-      - name: Touching core/web/assets/index.html
-        run: mkdir -p core/web/assets && touch core/web/assets/index.html
-      - name: Build binary
-        run: go build ./...
-      - name: golangci-lint
-        uses: golangci/golangci-lint-action@3a919529898de77ec3da873e3063ca4b10e7f5cc # v3.7.0
-        with:
-          version: v1.54.2
-          # We already cache these directories in setup-go
-          skip-pkg-cache: true
-          skip-build-cache: true
-          # only-new-issues is only applicable to PRs, otherwise it is always set to false
-          only-new-issues: true
-          args: --out-format colored-line-number,checkstyle:golangci-lint-report.xml
-      - name: Store lint report artifact
-        if: always()
-        uses: actions/upload-artifact@3cea5372237819ed00197afe530f5a7ea3e805c8 # v3.1.0
+      - name: Golang Lint
+        uses: ./.github/actions/golangci-lint
         with:
-          name: golangci-lint-report
-          path: golangci-lint-report.xml
-      - name: Collect Metrics
-        if: always()
-        uses: smartcontractkit/push-gha-metrics-action@d2c2b7bdc9012651230b2608a1bcb0c48538b6ec
-        with:
-          basic-auth: ${{ secrets.GRAFANA_CLOUD_BASIC_AUTH }}
-          hostname: ${{ secrets.GRAFANA_CLOUD_HOST }}
-          this-job-name: lint
-        continue-on-error: true
+          gc-basic-auth: ${{ secrets.GRAFANA_CLOUD_BASIC_AUTH }}
+          gc-host: ${{ secrets.GRAFANA_CLOUD_HOST }}
 
   core:
     strategy:

diff --git a/.gitignore b/.gitignore
@@ -45,7 +45,7 @@ core/cmd/TestClient_ImportExportP2PKeyBundle_test_key.json
 output.txt
 race.*
 golangci-lint-output.txt
-golangci-lint/
+/golangci-lint/
 
 # DB state
 ./db/

diff --git a/core/scripts/chaincli/README.md b/core/scripts/chaincli/README.md
@@ -15,8 +15,7 @@ Before starting, you will need:
 The example .env in this repo is for the Polygon Mumbai testnet. You can use [this faucet](https://faucets.chain.link/mumbai) to send testnet LINK
 to your wallet ahead of executing the next steps
 
->Note: Be careful with your key. When using testnets, it's best to use a separate
->account that does not hold real funds.
+>Note: Be careful with your key. When using testnets, it's best to use a separate account that does not hold real funds.
 
 ## Run OCR2Keepers locally