docs(week5): week 5 prep #147
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: Coverage Badge | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| workflow_dispatch: {} | |
| permissions: | |
| contents: write | |
| jobs: | |
| coverage-badge: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v4 | |
| - name: Use Node.js | |
| uses: actions/setup-node@v4 | |
| with: | |
| node-version: 20 | |
| cache: npm | |
| - name: Install deps | |
| run: npm ci | |
| - name: Run tests with coverage | |
| run: npm run test:coverage | |
| - name: Parse coverage percentage | |
| id: coverage | |
| run: | | |
| # Pull statement coverage percentage from Vitest json-summary | |
| if [ -f coverage/coverage-summary.json ]; then | |
| PCT=$(node -e "console.log(require('./coverage/coverage-summary.json').total.statements.pct)") | |
| else | |
| echo "coverage summary not found" && exit 1 | |
| fi | |
| echo "coverage=$PCT" >> $GITHUB_OUTPUT | |
| - name: Generate badge | |
| if: ${{ always() }} | |
| run: | | |
| PCT=${{ steps.coverage.outputs.coverage }} | |
| COLOR=yellow | |
| if [ "${PCT%.*}" -ge 80 ]; then COLOR=green; elif [ "${PCT%.*}" -ge 65 ]; then COLOR=yellowgreen; elif [ "${PCT%.*}" -lt 50 ]; then COLOR=red; fi | |
| echo "Generating badge for $PCT% -> $COLOR" | |
| mkdir -p .github/badges | |
| cat <<SVG > .github/badges/coverage.svg | |
| <svg xmlns='http://www.w3.org/2000/svg' width='120' height='20' role='img' aria-label='coverage: ${PCT}%'><linearGradient id='s' x2='0' y2='100%'><stop offset='0' stop-color='#bbb' stop-opacity='.1'/><stop offset='1' stop-opacity='.1'/></linearGradient><mask id='m'><rect width='120' height='20' rx='3' fill='#fff'/></mask><g mask='url(#m)'><rect width='62' height='20' fill='#555'/><rect x='62' width='58' height='20' fill='${COLOR}'/><rect width='120' height='20' fill='url(#s)'/></g><g fill='#fff' text-anchor='middle' font-family='Verdana,Geneva,DejaVu Sans,sans-serif' text-rendering='geometricPrecision' font-size='11'><text x='31' y='14'>coverage</text><text x='90' y='14'>${PCT}%</text></g></svg> | |
| SVG | |
| - name: Write coverage to job summary | |
| if: ${{ always() }} | |
| run: | | |
| { | |
| echo '### Test coverage' | |
| echo | |
| echo "Statements: ${{ steps.coverage.outputs.coverage }}% (v8 provider)" | |
| } >> "$GITHUB_STEP_SUMMARY" | |
| - name: Commit badge | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| run: | | |
| git config user.name 'github-actions' | |
| git config user.email 'actions@github.com' | |
| git add .github/badges/coverage.svg | |
| git commit -m "chore: update coverage badge" || echo "No changes" | |
| git push || echo "Note: push to main was blocked (likely branch protection). Badge will update after a maintainer merges a PR." | |
| - name: Upload coverage artifact (PRs only) | |
| if: ${{ github.event_name == 'pull_request' }} | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-report | |
| path: | | |
| coverage/** | |
| .github/badges/coverage.svg |