ci: refactor and fix gitignore & make targets

refactor of CI jobs:
divide the checks b/n code vs non-code which helps in easily turning off
one or the other during fixing any CI issues and also consolidates
jobs by similarity.

gitignore fix:
PR 311 brought new vendor dependency and that is being git ignored
unintentionally which created failures while running in CI, previous PR
was merged as not to get blocked by explicitly doing a `go mod tidy`
and `go mod vendor` which masked the original issue.

as not to hit this again, added a new condition for verifying deps from
mandatory parts for build if they are being git ignored.

golang cache:
as we were using `vendor/` for the project there is no need to cache mod
dependencies again and this is removed except for a single job where it
makes sense, infact storing & loading cache is increasing the overall
time w/ no added benefit.

concurrency of jobs:
added a concurrency check to the action as to cancel running jobs if PR
is pushed in quick successions as not to do work on older changes.

makefile:
do not update dependencies implicitiy before testing as that could mask
potentially issues which effectively makes updating dependencies a
separate step.

Signed-off-by: Leela Venkaiah G <[email protected]>

Author: leelavg

.github/workflows/codespell.yaml

@@ -1,5 +1,8 @@
+---
 name: image-publisher
-
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 on:
   workflow_dispatch:
     inputs:
@@ -9,25 +12,22 @@ on:
       IMAGE_TAG:
         required: false
         default: ""
-
 jobs:
   docker-push:
     name: docker-push
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v4
-
     - uses: actions/setup-go@v5
       with:
           go-version-file: go.mod
-
+          cache: false
     - name: Login to Quay
       uses: docker/login-action@v3
       with:
         registry: quay.io
         username: ${{ secrets.QUAY_USERNAME }}
         password: ${{ secrets.QUAY_ROBOT_TOKEN }}
-
     - name: Build and push docker images
       env:
         REGISTRY_NAMESPACE: ${{ github.event.inputs.REGISTRY_NAMESPACE }}

.github/workflows/commitlint.yaml

@@ -0,0 +1,49 @@
+---
+name: lint-and-spellcheck
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+on:
+  pull_request:
+    branches: ['*']
+jobs:
+  codespell:
+    name: codespell
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: codespell
+        uses: codespell-project/actions-codespell@v2
+        with:
+          exclude_file: go.sum
+          check_filenames: true
+          check_hidden: true
+          skip: vendor
+  commitlint:
+    name: commitlint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # we check commitlint for every 20 commits
+          fetch-depth: 20
+      - name: run commitlint
+        uses: wagoid/commitlint-github-action@v5
+        with:
+          configFile: './.github/workflows/conf/commitlintrc.json'
+          helpURL: |
+            Some helpful links
+            Contribution Guide -> https://github.com/red-hat-storage/odf-operator/blob/main/CONTRIBUTING.md#commit-structure
+            Naming Conventions -> https://commitlint.js.org/#/concepts-commit-conventions
+            Rules -> https://commitlint.js.org/#/reference-rules
+            How to Write a Good Git Commit Message -> https://chris.beams.io/posts/git-commit
+  yamllint:
+    name: yamllint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: yamllint
+        uses: ibiqlik/action-yamllint@v3
+        with:
+          config_file: ./.github/workflows/conf/yamllint.yaml
+          file_or_dir: .  # Recursive on all yaml files

.github/workflows/docker-push.yaml .github/workflows/dispatch-image-push.yaml

@@ -1,63 +1,59 @@
 ---
-name: image-builder
-
+name: operator-build-pipeline
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 on:
-  push:
-    branches: ['*']
   pull_request:
     branches: ['*']
-
 jobs:
+  golangci-lint:
+    name: golangci-lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+            go-version-file: go.mod
+            cache: false
+      - name: Source build env variables
+        run: |
+          grep -v '^#' hack/build.env >> $GITHUB_ENV
+      - uses: golangci/golangci-lint-action@v6
+        with:
+          version: ${{ env.GO_LINT_IMG_TAG }}
+          args: --config=.golangci.yaml -v
   container-build:
     name: operator-build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-
       - uses: actions/setup-go@v5
         with:
             go-version-file: go.mod
-
-      - name: Run go mod tidy
-        run: |
-          make godeps-update
-
+            cache: false
       - name: Build operator container image
         run: make build
-
   bundle-build:
     name: bundle-build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-
       - uses: actions/setup-go@v5
         with:
             go-version-file: go.mod
             cache: false
-
-      - name: Run go mod tidy
-        run: |
-          make godeps-update
-
       - name: Build operator bundle container image
         run: make bundle-build
-
   catalog-build:
     name: catalog-build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-
       - uses: actions/setup-go@v5
         with:
             go-version-file: go.mod
             cache: false
-
-      - name: Run go mod tidy
-        run: |
-          make godeps-update
-
       - name: Build catalog container image
         env:
           IMAGE_REGISTRY: localhost:5000

.github/workflows/golangci-lint.yaml

@@ -1,16 +1,9 @@
 ---
 name: verify-generated
-
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 on:
-  push:
-    branches: ['*']
-    paths:
-      - hack/**
-      - Makefile
-      - config/manager/csi-images.yaml
-      - go.mod
-      - go.sum
-      - vendor
   pull_request:
     branches: ['*']
     paths:
@@ -20,7 +13,6 @@ on:
       - go.mod
       - go.sum
       - vendor
-
 jobs:
   csi-images-manifest:
     name: verify-generated-changes
@@ -30,14 +22,14 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v4
-
       - uses: actions/setup-go@v5
         with:
           go-version-file: go.mod
-
+          cache-dependency-path: |
+            ./go.sum
+            api/go.sum
       - name: Verify go deps
         run: make godeps-verify
-
       - name: Verify bundle
         run: |
           make bundle

.github/workflows/lint-and-spellcheck.yaml

@@ -1,8 +1,8 @@
 bin/
 testbin/
 
-catalog
-catalog.Dockerfile
+./catalog
+./catalog.Dockerfile
 
 # Created by https://www.toptal.com/developers/gitignore/api/go,vim,visualstudiocode,git
 # Edit at https://www.toptal.com/developers/gitignore?templates=go,vim,visualstudiocode,git

.github/workflows/docker-build.yaml .github/workflows/operator-build-pipeline.yaml

@@ -3,7 +3,9 @@
 # options for analysis running
 run:
   # timeout for analysis, e.g. 30s, 5m, default is 1m
-  timeout: 2m
+  timeout: 5m
+  modules-download-mode: vendor
+  allow-parallel-runners: true
 linters:
   disable-all: true
   enable:

.github/workflows/verify-generated.yaml

@@ -56,7 +56,7 @@ godeps-verify: godeps-update
 	@echo "Verifying go-deps"
 	./hack/godeps-verify.sh
 
-test-setup: godeps-update generate fmt vet envtest ## Run setup targets for tests
+test-setup: generate fmt vet envtest ## Run setup targets for tests
 
 go-test: ## Run go test against code.
 	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(BIN_DIR) -p path)" go test -coverprofile cover.out `go list ./... | grep -v "e2e"`

.github/workflows/yamllint.yaml

@@ -6,5 +6,8 @@ if [[ -n "$(git status --porcelain "${paths[@]}")" ]]; then
 	git diff -u "${paths[@]}"
 	echo "Inconsistency found in dependency files. Run 'make godeps-update' and commit results."
 	exit 1
+elif [[ -n "$(git status --ignored --porcelain "${paths[@]}")" ]]; then
+	echo ".gitignore file is excluding required files for build from [${paths[@]}]"
+	exit 1
 fi
 echo "Success: no out of source tree changes found for dependency files"