Add lint CI

Author: RebeccaMahany

.gitattributes

@@ -0,0 +1,5 @@
+# set line endings got go files. Mostly needed for golang-ci
+*.go text eol=lf
+
+# go.sum merges can just concat. Cuts down on merge conflicts
+go.sum merge=union

.github/actionlint-matcher.json

@@ -0,0 +1,17 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "actionlint",
+      "pattern": [
+        {
+          "regexp": "^(?:\\x1b\\[\\d+m)?(.+?)(?:\\x1b\\[\\d+m)*:(?:\\x1b\\[\\d+m)*(\\d+)(?:\\x1b\\[\\d+m)*:(?:\\x1b\\[\\d+m)*(\\d+)(?:\\x1b\\[\\d+m)*: (?:\\x1b\\[\\d+m)*(.+?)(?:\\x1b\\[\\d+m)* \\[(.+?)\\]$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "message": 4,
+          "code": 5
+        }
+      ]
+    }
+  ]
+}

.github/workflows/lint.yml

@@ -0,0 +1,76 @@
+name: lint
+
+permissions:
+  contents: read
+  pull-requests: read
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: '**'
+  merge_group:
+    types: [checks_requested]
+
+jobs:
+  golangci:
+    strategy:
+      fail-fast: false
+    name: lint
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version-file: './go.mod'
+          check-latest: true
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@4696ba8babb6127d732c3c6dde519db15edab9ea
+        with:
+          skip-save-cache: true
+
+  govulncheck:
+    strategy:
+      fail-fast: false
+    name: govulncheck
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - id: govulncheck
+        uses: golang/govulncheck-action@v1
+        with:
+          go-version-file: './go.mod'
+          check-latest: true
+          go-package: ./...
+
+  actionlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v5
+        with:
+          go-version-file: './go.mod'
+          check-latest: true
+          cache: false
+      - name: install actionlint
+        run: go install github.com/rhysd/actionlint/cmd/actionlint@latest
+      - name: actionlint
+        run: |
+          echo "::add-matcher::.github/actionlint-matcher.json"
+          actionlint -color
+
+
+  # This job is here as a github status check -- it allows us to move
+  # the merge dependency from being on all the jobs to this single
+  # one.
+  lint_mergeable:
+    runs-on: ubuntu-latest
+    steps:
+      - run: true
+    needs:
+      - golangci
+      - govulncheck
+      - actionlint

.golangci.yml

@@ -0,0 +1,95 @@
+run:
+  timeout: 5m
+
+linters:
+  enable:
+    - bodyclose
+    - containedctx
+    - gofmt
+    - govet
+    - ineffassign
+    - misspell
+    - noctx
+    - perfsprint
+    - rowserrcheck
+    - sloglint
+    - sqlclosecheck
+    - staticcheck
+    - usetesting
+    - unconvert
+    - unused
+    - gocritic
+    - nakedret
+    - predeclared
+    - revive
+    - exhaustive
+  disable:
+    - errcheck
+    - gosec
+    - gosimple
+
+linters-settings:
+  errcheck:
+    exclude-functions: [github.com/go-kit/kit/log:Log]
+  gofmt:
+    simplify: false
+  gocritic:
+    disabled-checks:
+      - ifElseChain
+      - elseif
+  sloglint:
+    kv-only: true
+    context: "all"
+    key-naming-case: snake
+    static-msg: true
+  revive:
+    rules:
+      - name: superfluous-else
+        severity: warning
+        disabled: false
+        arguments:
+          - "preserveScope"
+      - name: package-comments
+        disabled: false
+      - name: context-as-argument
+        disabled: false
+      - name: context-keys-type
+        disabled: false
+      - name: error-return
+        disabled: false
+      - name: errorf
+        disabled: false
+      - name: unreachable-code
+        disabled: false
+      - name: early-return
+        disabled: false
+      - name: confusing-naming
+        disabled: false
+      - name: defer
+        disabled: false
+  staticcheck:
+    checks: ["all"]
+
+issues:
+  exclude-rules:
+    # False positive: https://github.com/kunwardeep/paralleltest/issues/8.
+    - linters:
+        - paralleltest
+      text: "does not use range value in test Run"
+    # We prefer fmt.Sprintf over string concatenation for readability
+    - linters: [perfsprint]
+      text: "fmt.Sprintf can be replaced with string concatenation"
+    - linters: [perfsprint]
+      text: "fmt.Sprintf can be replaced with faster hex.EncodeToString"
+    - linters: [perfsprint]
+      text: "fmt.Sprintf can be replaced with faster strconv.FormatBool"
+    - linters: [perfsprint]
+      text: "fmt.Sprintf can be replaced with faster strconv.FormatInt"
+    - linters: [perfsprint]
+      text: "fmt.Sprintf can be replaced with faster strconv.FormatUint"
+    - linters: [perfsprint]
+      text: "fmt.Sprintf can be replaced with faster strconv.Itoa"
+    - linters: [perfsprint]
+      text: "fmt.Sprint can be replaced with faster strconv.Itoa"
+  exclude-dirs:
+    - test-cmds