Go Code Quality & Tests #79
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Go Code Quality & Tests | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| schedule: | |
| - cron: "17 15 * * 4" | |
| workflow_dispatch: | |
| jobs: | |
| verify: | |
| name: Verify and Test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Set up Go | |
| uses: actions/setup-go@v6 | |
| with: | |
| go-version-file: go.mod | |
| check-latest: true | |
| cache: true | |
| - name: Install analysis tools | |
| # Pinned versions — review quarterly and update manually. | |
| # gosec: https://github.com/securego/gosec/releases | |
| # nancy: https://github.com/sonatype-nexus-community/nancy/releases | |
| run: | | |
| go install github.com/securego/gosec/v2/cmd/gosec@v2.23.0 | |
| go install github.com/sonatype-nexus-community/nancy@v1.2.0 | |
| - name: Verify dependencies | |
| run: go mod verify | |
| - name: Run go fmt | |
| run: | | |
| if [ "$(gofmt -s -l . | wc -l)" -gt 0 ]; then | |
| echo "The following files are not properly formatted:" | |
| gofmt -s -l . | |
| exit 1 | |
| fi | |
| - name: Run go vet | |
| run: go vet ./... | |
| - name: Run Tests | |
| run: go test -v -race -coverprofile=coverage.txt -covermode=atomic ./... | |
| - name: Generate Documentation | |
| run: | | |
| go doc -all > documentation.txt | |
| if [ ! -s documentation.txt ]; then | |
| echo "Documentation generation failed or is empty" | |
| exit 1 | |
| fi | |
| - name: Run gosec | |
| run: gosec -exclude-dir=vendor ./... | |
| - name: Run nancy | |
| run: | | |
| go list -json -deps ./... | nancy sleuth | |
| - name: Run golangci-lint | |
| uses: golangci/golangci-lint-action@v9 | |
| with: | |
| version: v2.9.0 | |
| args: --timeout=5m | |
| - name: Archive code coverage results | |
| uses: actions/upload-artifact@v7 | |
| with: | |
| name: code-coverage-report | |
| path: coverage.txt | |
| - name: Archive documentation | |
| uses: actions/upload-artifact@v7 | |
| with: | |
| name: documentation | |
| path: documentation.txt |