add lint (#191)

Signed-off-by: wfan <[email protected]>

Author: WindzCUHK

.github/workflows/github-releases.yaml

@@ -110,7 +110,7 @@ jobs:
         id: setup_go
         # You may pin to the exact commit or the version.
         # uses: https://github.com/actions/setup-go/tags
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           # go-version: stable
           go-version-file: './go.mod'

.github/workflows/go-test.yaml

@@ -7,6 +7,9 @@ name: Build and Publish Docker Image
 
 on:
   workflow_call:
+    secrets:
+      CODECOV_TOKEN:
+        required: true
 
 jobs:
 
@@ -49,7 +52,7 @@ jobs:
         id: setup_go
         # You may pin to the exact commit or the version.
         # uses: https://github.com/actions/setup-go/tags
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           # go-version: stable
           go-version-file: './go.mod'
@@ -64,6 +67,30 @@ jobs:
           go version
           make test
 
+      # This action uploads coverage to Codecov.
+      # https://github.com/codecov/codecov-action
+      -
+        name: Upload coverage reports to Codecov
+        id: go-coverage
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }} # Repository upload token: https://app.codecov.io/gh/AthenZ/k8s-athenz-sia/config/general
+          files: ./coverage.out
+          flags: unittests
+          fail_ci_if_error: true # set to false temporarily if the CI failed
+          verbose: true
+          version: "latest"
+
+      # This action runs golangci-lint and reports issues from linters.
+      # https://github.com/golangci/golangci-lint-action
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v7
+        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: "latest"
+          # Optional: golangci-lint command line arguments.
+          args: --issues-exit-code=0 -c ./.golangci.yml # or set "continue-on-error: true" in Github Actions
+
       # https://github.com/apache/skywalking-eyes
       # issue: go version hard-coded: https://github.com/apache/skywalking-eyes/blob/5dfa68f93380a5e57259faaf95088b7f133b5778/header/action.yml#L47-L51
       - name: Check License Header

.github/workflows/lint.yaml

@@ -0,0 +1,35 @@
+name: lint
+
+on:
+  # If any commit message in your push or the HEAD commit of your PR contains the strings
+  # [skip ci], [ci skip], [no ci], [skip actions], or [actions skip]
+  # workflows triggered on the push or pull_request events will be skipped.
+  # https://github.blog/changelog/2021-02-08-github-actions-skip-pull-request-and-push-workflows-with-skip-ci/
+  push:
+    branches: [ main ]
+    # Publish semver tags as releases.
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+  pull_request:
+    branches: [ main ]
+
+jobs:
+
+  # This job runs markdownlint and reports issues from linters.
+  # https://github.com/DavidAnson/markdownlint-cli2-action
+  markdownlint:
+    name: markdownlint
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: markdownlint
+        uses: DavidAnson/markdownlint-cli2-action@v19
+        continue-on-error: true
+        with:
+          globs: |
+            README.md
+            CHANGELOG.md
+            docs/*.md

.github/workflows/trigger-workflows.yaml

@@ -27,6 +27,8 @@ jobs: # https://docs.github.com/en/actions/learn-github-actions/contexts#context
   go-test:
     name: "Run unit test"
     uses: ./.github/workflows/go-test.yaml
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
   set-platforms:
     runs-on: ubuntu-latest

.golangci.yml

@@ -0,0 +1,10 @@
+version: "2"
+issues:
+  max-same-issues: 0
+linters:
+  # example to exclude glg lint error
+  # settings:
+  #   errcheck:
+  #     exclude-functions:
+  #       - "glg.*"
+  default: all

.remarkrc

@@ -0,0 +1,9 @@
+{
+  "plugins": [
+    "remark-preset-lint-consistent",
+    "remark-preset-lint-recommended",
+    ["remark-lint-list-item-indent", false],
+    ["remark-lint-list-item-bullet-indent", false],
+    ["remark-lint-list-item-content-indent", false]
+  ]
+}

Makefile

@@ -73,7 +73,9 @@ build: submodule-update
 test:
 	@echo "Testing..."
 	go test -v -failfast -timeout 1m -race -covermode=atomic -coverprofile=coverage.out ./...
-	go tool cover -html=coverage.out -o coverage.html
+
+lint:
+	golangci-lint run -c ./.golangci.yml
 
 upgrade:
 	go list -u -m all