config-file-validator/.github/workflows/goreportcard.yaml at main · Boeing/config-file-validator · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
---
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@8d3c67de8e2fe68ef647c8db1e6a09f647780f40 # v2.19.0
        with:
          egress-policy: audit

      - name: Setup Go ${{ matrix.go }}
        uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.4.0
        with:
          go-version: ${{ matrix.go }}
          cache: false
      - name: Checkout gojp/goreportcard repo
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        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@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: Run goreportcard
        run: |
          # Failure threshold is set to 95% to fail at any errors. Default is 75%.
          goreportcard-cli -t 95