feat: workflow and configuration

Author: ldez

.github/workflows/basic.yml

@@ -0,0 +1,70 @@
+name: golangci-lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  linter:
+    name: golangci-lint
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        go-version: ['1.20', 1.x ]
+        os: [ubuntu-latest, macos-latest] # Go plugins are only supported on linux, freebsd, and darwin.
+    env:
+      CGO_ENABLED: 0
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-go@v4
+        with:
+          go-version: '1.20'
+          cache: false
+
+      - name: Cache Go modules
+        uses: actions/cache@v3
+        with:
+          # In order:
+          # * Module download cache
+          # * Build cache (Linux)
+          # * Build cache (Mac)
+          path: |
+            ~/go/pkg/mod
+            ~/.cache/go-build
+            ~/Library/Caches/go-build
+          key: ${{ runner.os }}-${{ matrix.go-version }}-go-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ matrix.go-version }}-go-
+
+      - name: Check and get dependencies
+        run: |
+          go mod tidy
+          git diff --exit-code go.mod
+          # git diff --exit-code go.sum
+
+      - name: Install plugins
+        run: |
+          git clone https://github.com/golangci/example-plugin-linter.git
+          cd example-plugin-linter
+          go build -o '${{ github.workspace }}/.plugins/example.so' -buildmode=plugin plugin/example.go
+        working-directory: ${{ runner.temp }}
+        env:
+          CGO_ENABLED: 1
+
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.53.2
+          # The installation mode `goinstall` always uses `CGO_ENABLED=1`.
+          install-mode: goinstall
+          args: --timeout=10m
+
+      - name: Test
+        run: go test -v -cover ./...
+
+      - name: Build
+        run: go build -v -ldflags "-s -w" -trimpath

.golangci.yml

@@ -0,0 +1,25 @@
+run:
+  timeout: 10m
+  skip-files: []
+
+linters-settings:
+  custom:
+    example:
+      # Path to the `.so` file of the plugin
+      path: .plugins/example.so
+      # Only used for documentation purposes.
+      description: The description of the linter. Shows up when running `golangci-lint linters`.
+      # Only used for documentation purposes.
+      original-url: github.com/golangci/example-linter
+
+linters:
+  disable-all: true
+  enable:
+    - example
+    - typecheck
+
+issues:
+  exclude-use-default: false
+  max-per-linter: 0
+  max-same-issues: 0
+

readme.md

@@ -1,3 +1,32 @@
-# Golangci-lint-action Example
+# Golangci-lint-action and Plugins Example
 
-TODO
+This repository is an example to explain how to use [custom linters](https://golangci-lint.run/contributing/new-linters/#how-to-add-a-private-linter-to-golangci-lint) (plugins) with the [GitHub Action of golangci-lint](https://github.com/golangci/golangci-lint-action).
+
+## Build and Install Plugins
+
+```yml
+      - name: Build and install plugins
+        run: |
+          git clone https://github.com/golangci/example-plugin-linter.git
+          cd example-plugin-linter
+          go build -o '${{ github.workspace }}/.plugins/example.so' -buildmode=plugin plugin/example.go
+        working-directory: ${{ runner.temp }}
+        env:
+          CGO_ENABLED: 1
+```
+
+## Install and Run golangci-lint
+
+```yml
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          version: v1.53.2
+          # The installation mode `goinstall` always uses `CGO_ENABLED=1`.
+          install-mode: goinstall
+          args: --timeout=5m
+```
+
+## Full Example
+
+The [Workflow](https://github.com/golangci/golangci-lint-action-example/blob/main/.github/workflows/basic.yml).