ci(goreportcard): Add step for goreportcard check (Boeing#149)

Go report card for repo: https://goreportcard.com/report/github.com/Boeing/config-file-validator Fixes Boeing#120 Signed-off-by: Bhargav Ravuri <[email protected]>
shiina4119 · Aug 23, 2024 · cc1667f · cc1667f
1 parent cc6fea8
commit cc1667f
Showing 1 changed file with 58 additions and 0 deletions.
diff --git a/.github/workflows/goreportcard.yaml b/.github/workflows/goreportcard.yaml
@@ -0,0 +1,58 @@
+name: Go Report Card
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:  # added using https://github.com/step-security/secure-repo
+  contents: read
+
+jobs:
+  goreportcard:
+    strategy:
+      matrix:
+        go: ['stable']
+        os: [ubuntu-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+    - name: Harden Runner
+      uses: step-security/harden-runner@f086349bfa2bd1361f7909c78558e816508cdc10 # v2.8.0
+      with:
+        egress-policy: audit
+
+    - name: Setup Go ${{ matrix.go }}
+      uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1
+      with:
+        go-version: ${{ matrix.go }}
+        cache: false
+    - name: Checkout gojp/goreportcard repo
+      uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+      with:
+        repository: gojp/goreportcard
+        path: goreportcard
+    - name: Install goreportcard-cli
+      # goreportcard-cli requires the following linters:
+      #  1. gometalinter
+      #  2. golint
+      #  3. gocyclo
+      #  4. ineffassign
+      #  5. misspell
+      # among which, the linter gometalinter is deprecated. However, goreportcard repo has a vendor version of it.
+      # Hence installing from the repo instead of `go install`. Refer https://github.com/gojp/goreportcard/issues/301
+      run: |
+        cd goreportcard
+
+        # Install prerequisite linter binaries: gometalinter, golint, gocyclo, ineffassign & misspell
+        # Refer: https://github.com/gojp/goreportcard?tab=readme-ov-file#command-line-interface
+        make install
+
+        # Install goreportcard-cli binary
+        go install ./cmd/goreportcard-cli
+    - name: Checkout Boeing/config-file-validator repo
+      uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+    - name: Run goreportcard
+      run: |
+        # Failure threshold is set to 100% to fail at any errors. Default is 75%.
+        goreportcard-cli -t 100