senzing-factory/build-resources#69 add linting (#108)

senzing-garage · Feb 14, 2024 · 203d9b5 · 203d9b5
1 parent 6444b55
commit 203d9b5
Show file tree

Hide file tree

Showing 13 changed files with 104 additions and 70 deletions.
diff --git a/.github/linters/.yaml-lint.yml b/.github/linters/.yaml-lint.yml
@@ -0,0 +1,9 @@
+# Extends the default yamllint config by adjusting some options.
+extends: default
+
+rules:
+  comments-indentation: disable
+  line-length:
+    level: warning
+    allow-non-breakable-inline-mappings: true
+  truthy: disable
diff --git a/.github/workflows/add-labels-standardized.yaml b/.github/workflows/add-labels-standardized.yaml
@@ -1,4 +1,4 @@
-name: 'add labels standardized'
+name: add labels standardized
 
 on:
   issues:

diff --git a/.github/workflows/add-to-project-garage-dependabot.yaml b/.github/workflows/add-to-project-garage-dependabot.yaml
@@ -1,14 +1,13 @@
-name: 'add to project garage dependabot'
+name: add to project garage dependabot
 
 on:
   pull_request:
     branches: [main]
 
 jobs:
-
   add-to-project-dependabot:
     secrets:
       SENZING_GITHUB_PROJECT_RW_TOKEN: ${{ secrets.SENZING_GITHUB_PROJECT_RW_TOKEN }}
-    uses: senzing-factory/build-resources/.github/workflows/add-to-project-dependabot.yaml@main
+    uses: senzing-factory/build-resources/.github/workflows/add-to-project-dependabot.yaml@v1
     with:
       project: ${{ vars.SENZING_PROJECT_GARAGE }}
diff --git a/.github/workflows/add-to-project-garage.yaml b/.github/workflows/add-to-project-garage.yaml
@@ -1,4 +1,4 @@
-name: 'add to project garage'
+name: add to project garage
 
 on:
   issues:
@@ -8,11 +8,12 @@ on:
 
 jobs:
   add-to-project:
-    name: Add issue to project
+    name: add issue to project
     runs-on: ubuntu-latest
+
     steps:
-      - name: Assign issue to project
+      - name: assign issue to project
         uses: actions/[email protected]
         with:
-          project-url: https://github.com/orgs/${{ vars.SENZING_GITHUB_ACCOUNT_NAME }}/projects/${{ vars.SENZING_PROJECT_GARAGE }}
           github-token: ${{ secrets.SENZING_GITHUB_ACCESS_TOKEN }}
+          project-url: https://github.com/orgs/${{ vars.SENZING_GITHUB_ACCOUNT_NAME }}/projects/${{ vars.SENZING_PROJECT_GARAGE }}
diff --git a/.github/workflows/dependabot-approve-and-merge.yaml b/.github/workflows/dependabot-approve-and-merge.yaml
@@ -1,12 +1,14 @@
-name: dependabot-approve-and-merge.yaml
+name: dependabot approve and merge
+
 on:
   pull_request:
     branches: [main]
+
 jobs:
   dependabot-approve-and-merge:
     permissions:
       contents: write
       pull-requests: write
-    uses: senzing-factory/build-resources/.github/workflows/dependabot-approve-and-merge.yaml@main
     secrets:
       SENZING_GITHUB_CODEOWNER_PR_RW_TOKEN: ${{ secrets.SENZING_GITHUB_CODEOWNER_PR_RW_TOKEN }}
+    uses: senzing-factory/build-resources/.github/workflows/dependabot-approve-and-merge.yaml@v1
diff --git a/.github/workflows/go-proxy-pull.yaml b/.github/workflows/go-proxy-pull.yaml
@@ -1,10 +1,4 @@
-# Based on
-# - https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
-# - https://github.com/marketplace/actions/go-proxy-warming
-# - https://github.com/andrewslotin/go-proxy-pull-action
-# - https://futurestud.io/tutorials/github-actions-run-a-workflow-when-creating-a-tag
-
-name: go-proxy-pull.yaml
+name: go proxy pull
 
 on:
   push:
@@ -17,8 +11,9 @@ permissions:
 jobs:
   go-proxy-pull:
     runs-on: ubuntu-latest
+
     steps:
-      - name: Pull new module version
+      - name: pull new module version
         uses: andrewslotin/[email protected]
         with:
           import_path: github.com/senzing-garage/go-common
diff --git a/.github/workflows/go-test-darwin.yaml b/.github/workflows/go-test-darwin.yaml
@@ -1,7 +1,4 @@
-# Based on
-# - https://github.com/marketplace/actions/setup-go-environment
-
-name: go-test-darwin.yaml
+name: go test darwin
 
 on: [push]
 
@@ -15,29 +12,35 @@ permissions:
 
 jobs:
   go-test-darwin:
+    name: "go test with Senzing: ${{ matrix.senzingapi-version }}; OS: ${{ matrix.os }}; Go: ${{ matrix.go }}"
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         go: ["1.21"]
         os: [macos-latest]
         senzingapi-version: [staging]
-    name: "go test with Senzing: ${{ matrix.senzingapi-version }}; OS: ${{ matrix.os }}; Go: ${{ matrix.go }}"
+
     steps:
-      - name: Checkout repository
+      - name: checkout repository
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Setup go
+
+      - name: setup go
         uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
-      - name: Install Senzing API
-        uses: Senzing/github-action-install-senzing-api@latest
+
+      - name: install Senzing API
+        uses: senzing-factory/github-action-install-senzing-api@v1
         with:
           senzingapi-version: ${{ matrix.senzingapi-version }}
-      - name: Copy /etc files
+
+      - name: copy /etc files
         run: sudo cp testdata/senzing-license/g2.lic /opt/senzing/g2/etc/g2.lic
-      - name: Copy test database files
+
+      - name: copy test database files
         run: mkdir /tmp/sqlite && cp testdata/sqlite/G2C.db /tmp/sqlite/G2C.db
-      - name: Run go test
+
+      - name: run go test
         run: go test -exec /Users/runner/work/go-common/go-common/bin/macos_exec_dyld.sh -v -p 1 ./...
diff --git a/.github/workflows/go-test-linux.yaml b/.github/workflows/go-test-linux.yaml
@@ -1,7 +1,4 @@
-# Based on
-# - https://github.com/marketplace/actions/setup-go-environment
-
-name: go-test-linux.yaml
+name: go test linux
 
 on: [push]
 
@@ -14,29 +11,35 @@ permissions:
 
 jobs:
   go-test-linux:
+    name: "go test with Senzing: ${{ matrix.senzingapi-version }}; OS: ${{ matrix.os }}; Go: ${{ matrix.go }}"
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         go: ["1.21"]
         os: [ubuntu-latest]
         senzingapi-version: [staging]
-    name: "go test with Senzing: ${{ matrix.senzingapi-version }}; OS: ${{ matrix.os }}; Go: ${{ matrix.go }}"
+
     steps:
-      - name: Checkout repository
+      - name: checkout repository
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Setup go
+
+      - name: setup go
         uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
-      - name: Install Senzing API
-        uses: Senzing/github-action-install-senzing-api@latest
+
+      - name: install Senzing API
+        uses: senzing-factory/github-action-install-senzing-api@v1
         with:
           senzingapi-version: ${{ matrix.senzingapi-version }}
-      - name: Copy /etc files
+
+      - name: copy /etc files
         run: sudo cp testdata/senzing-license/g2.lic /etc/opt/senzing/g2.lic
-      - name: Copy test database files
+
+      - name: copy test database files
         run: mkdir /tmp/sqlite && cp testdata/sqlite/G2C.db /tmp/sqlite/G2C.db
-      - name: Run go test
+
+      - name: run go test
         run: go test -v -p 1 ./...
diff --git a/.github/workflows/go-test-windows.yaml b/.github/workflows/go-test-windows.yaml
@@ -1,7 +1,4 @@
-# Based on
-# - https://github.com/marketplace/actions/setup-go-environment
-
-name: go-test-windows.yaml
+name: go test windows
 
 on: [push]
 
@@ -13,31 +10,38 @@ permissions:
 
 jobs:
   go-test-windows:
+    name: "go test with Senzing: ${{ matrix.senzingapi-version }}; OS: ${{ matrix.os }}; Go: ${{ matrix.go }}"
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         go: ["1.21"]
         os: [windows-latest]
         senzingapi-version: [staging]
-    name: "go test with Senzing: ${{ matrix.senzingapi-version }}; OS: ${{ matrix.os }}; Go: ${{ matrix.go }}"
+
     steps:
-      - name: Checkout repository
+      - name: checkout repository
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - name: Setup go
+
+      - name: setup go
         uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
-      - name: Install Senzing API
-        uses: Senzing/github-action-install-senzing-api@latest
+
+      - name: install Senzing API
+        uses: senzing-factory/github-action-install-senzing-api@v1
         with:
           senzingapi-version: ${{ matrix.senzingapi-version }}
-      - name: Add to "Path" environment variable
-        run: echo "C:\Program Files\Senzing\g2\lib" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
-      - name: Copy /etc files
+
+      - name: add to "Path" environment variable
+        run: echo "C:\Program Files\Senzing\g2\lib" | Out-File -FilePath "$env:GITHUB_PATH" -Encoding utf8 -Append
+
+      - name: copy /etc files
         run: copy testdata/senzing-license/g2.lic "C:\Program Files\Senzing\g2\etc\g2.lic"
-      - name: Copy test database files
+
+      - name: copy test database files
         run: mkdir "C:\Temp\sqlite" && copy testdata/sqlite/G2C.db "C:\Temp\sqlite\G2C.db"
-      - name: Run go test
+
+      - name: run go test
         run: go test -v -p 1 ./...
diff --git a/.github/workflows/gofmt.yaml b/.github/workflows/gofmt.yaml
@@ -1,4 +1,4 @@
-name: gofmt.yaml
+name: gofmt
 
 on:
   pull_request:
@@ -9,4 +9,4 @@ permissions:
 
 jobs:
   gofmt:
-    uses: senzing-factory/build-resources/.github/workflows/gofmt.yaml@main
+    uses: senzing-factory/build-resources/.github/workflows/gofmt.yaml@v1
diff --git a/.github/workflows/gosec.yaml b/.github/workflows/gosec.yaml
@@ -1,7 +1,4 @@
-# Based on
-# - https://github.com/securego/gosec
-
-name: gosec.yaml
+name: gosec
 
 on:
   push:
@@ -19,10 +16,12 @@ jobs:
     runs-on: ubuntu-latest
     env:
       GO111MODULE: on
+
     steps:
-      - name: Checkout Source
+      - name: checkout Source
         uses: actions/checkout@v4
-      - name: Run Gosec Security Scanner
-        uses: securego/gosec@master
+
+      - name: run Gosec Security Scanner
+        uses: securego/[email protected]
         with:
           args: ./...
diff --git a/.github/workflows/lint-workflows.yaml b/.github/workflows/lint-workflows.yaml
@@ -0,0 +1,17 @@
+name: lint workflows
+
+on:
+  push:
+    branches-ignore: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+  packages: read
+  pull-requests: read
+  statuses: write
+
+jobs:
+  lint-workflows:
+    uses: senzing-factory/build-resources/.github/workflows/lint-workflows.yaml@v1
diff --git a/.github/workflows/make-go-tag.yaml b/.github/workflows/make-go-tag.yaml
@@ -1,4 +1,4 @@
-name: make-go-tag.yaml
+name: make go tag
 
 on:
   push:
@@ -10,10 +10,12 @@ permissions:
 
 jobs:
   make-go-tag:
-    name: Make a vM.m.P tag
+    name: make a vM.m.P tag
     runs-on: ubuntu-latest
+
     steps:
-      - name: Checkout repository
+      - name: checkout repository
         uses: actions/checkout@v4
-      - name: Make go version tag
-        uses: senzing-factory/github-action-make-go-tag@main
+
+      - name: make go version tag
+        uses: senzing-factory/github-action-make-go-tag@v1