ci: add coverage badge with auto-update on main #25
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: CI | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| workflow_call: # Allow release.yml to call this as a gate | |
| jobs: | |
| test: | |
| name: Tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: go.mod | |
| cache: true | |
| - name: Run unit tests with coverage | |
| run: go test -coverpkg=github.com/numberly/opentofu-provider-flashblade/internal/... -coverprofile=coverage.out ./internal/... -count=1 -timeout 5m | |
| - name: Generate coverage badge | |
| if: github.ref == 'refs/heads/main' && github.event_name == 'push' | |
| run: | | |
| PCT=$(go tool cover -func=coverage.out | grep total | awk '{print $3}' | tr -d '%') | |
| # Color: red < 50, yellow < 70, green >= 70 | |
| if (( $(echo "$PCT < 50" | bc -l) )); then COLOR="e05d44" | |
| elif (( $(echo "$PCT < 70" | bc -l) )); then COLOR="dfb317" | |
| else COLOR="44cc11"; fi | |
| mkdir -p .github/badges | |
| cat > .github/badges/coverage.svg << BADGE | |
| <svg xmlns="http://www.w3.org/2000/svg" width="106" height="20"> | |
| <linearGradient id="b" x2="0" y2="100%"> | |
| <stop offset="0" stop-color="#bbb" stop-opacity=".1"/> | |
| <stop offset="1" stop-opacity=".1"/> | |
| </linearGradient> | |
| <mask id="a"><rect width="106" height="20" rx="3" fill="#fff"/></mask> | |
| <g mask="url(#a)"> | |
| <path fill="#555" d="M0 0h61v20H0z"/> | |
| <path fill="#${COLOR}" d="M61 0h45v20H61z"/> | |
| <path fill="url(#b)" d="M0 0h106v20H0z"/> | |
| </g> | |
| <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,sans-serif" font-size="11"> | |
| <text x="30.5" y="15" fill="#010101" fill-opacity=".3">coverage</text> | |
| <text x="30.5" y="14">coverage</text> | |
| <text x="83" y="15" fill="#010101" fill-opacity=".3">${PCT}%</text> | |
| <text x="83" y="14">${PCT}%</text> | |
| </g> | |
| </svg> | |
| BADGE | |
| - name: Commit coverage badge | |
| if: github.ref == 'refs/heads/main' && github.event_name == 'push' | |
| run: | | |
| git config user.name "github-actions[bot]" | |
| git config user.email "github-actions[bot]@users.noreply.github.com" | |
| git add .github/badges/coverage.svg | |
| git diff --cached --quiet || git commit -m "ci: update coverage badge [skip ci]" && git push | |
| lint: | |
| name: Lint | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: go.mod | |
| cache: true | |
| - name: Run golangci-lint | |
| uses: golangci/golangci-lint-action@v7 | |
| docs-check: | |
| name: Docs up to date | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-go@v5 | |
| with: | |
| go-version-file: go.mod | |
| cache: true | |
| - name: Install Terraform | |
| uses: hashicorp/setup-terraform@v3 | |
| with: | |
| terraform_wrapper: false | |
| - name: Regenerate docs | |
| run: go generate ./... | |
| - name: Check for uncommitted doc changes | |
| run: git diff --exit-code docs/ |