chore(ci): add codecov upload to tests GHA run & update dev guide (#433)

lwasser · JimMadge · web-flow · commit e85e9df3f064 · 2026-02-09T19:02:52.000-07:00
* chore: add codcov upload, secret and docs chore: add docs for codecov and secret to workflow chore: double check cov file exists? yay Apply suggestion from @lwasser sdf * Apply suggestion from @JimMadge Co-authored-by: Jim Madge <jim+github@jmadge.com> * Apply suggestions from code review Co-authored-by: Jim Madge <jim+github@jmadge.com> * Update DEVELOPMENT.md * lint --------- Co-authored-by: Jim Madge <jim+github@jmadge.com>
diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml
@@ -30,13 +30,14 @@ jobs:
         run: pnpm build
 
       - name: Run tests
-        run: pnpm test
+        run: pnpm test -- --coverage
         env:
           NODE_OPTIONS: --experimental-vm-modules
 
-      - name: Upload coverage
-        uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5.5.2
         with:
-          name: coverage
-          path: coverage/
-          retention-days: 7
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ./coverage/lcov.info
+          fail_ci_if_error: false
+          verbose: true
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -1,5 +1,93 @@
 # Development Documentation
 
+## Testing and Code Coverage
+
+### Running Tests
+
+The project uses Jest for testing. To run the test suite you can use:
+
+```bash
+npm test
+```
+
+This runs all tests with code coverage analysis enabled.
+
+### Test Configuration
+
+Test configuration is in `jest.config.js`, which extends `kcd-scripts/jest` with
+project-specific settings:
+
+```javascript
+const jestConfig = require('kcd-scripts/jest')
+
+module.exports = Object.assign(jestConfig, {
+  coverageThreshold: {
+    global: {
+      branches: 50,
+      functions: 40,
+      lines: 50,
+      statements: 50,
+    },
+  },
+  forceExit: true,
+})
+```
+
+### Coverage Thresholds
+
+The project enforces minimum code coverage thresholds through the jest
+configuration above:
+
+| Coverage Type | Percentage |
+| ------------- | ---------- |
+| Branches      | 50%        |
+| Functions     | 40%        |
+| Lines         | 50%        |
+| Statements    | 50%        |
+
+Tests will fail if coverage drops below these thresholds.
+
+### Coverage Reports
+
+When you run tests, coverage reports are automatically generated in the
+`coverage/` directory:
+
+- **`coverage/lcov-report/index.html`** — Interactive HTML report (open in
+  browser)
+- **`coverage/lcov.info`** — LCOV format (used by Codecov)
+- **`coverage/clover.xml`** — Clover XML format
+- **`coverage/coverage-final.json`** — JSON format
+
+The HTML report provides a visual breakdown of which files are covered by tests.
+
+### Codecov Integration
+
+The project uses Codecov to track code coverage over time and on pull requests.
+
+#### CI Integration
+
+- The GitHub Actions workflow (`.github/workflows/test-deploy.yml`)
+  automatically uploads coverage to Codecov after running tests
+- Coverage reports appear as comments on pull requests (if enabled)
+- The workflow uses `codecov/codecov-action@vxxx` (whatever version is most
+  recent) to upload the `lcov.info` file
+
+#### Configuration
+
+Codecov behavior is configured in `.codecov.yml`:
+
+- Patch coverage is tracked (checks coverage of changed code in PRs)
+- Project-level status checks are disabled
+- PR comments are disabled
+- Codecov now requires a token for all uploads so we have one generated in the
+  repo as a secret `secrets.CODECOV_TOKEN`.
+
+#### Local Usage
+
+You don't need a Codecov account to view coverage locally—just run `pnpm test`
+and open the HTML report. Codecov integration is primarily for tracking coverage
+trends and to simplify PR reviews in the CI/CD pipeline.
+
 ## Linting
 
 2026 update: The project is now using ESLint 9 and the flat config format. As we
