ci(core): report code coverage in CI by gluecksmelodie · Pull Request #809 · haiilo/catalyst

gluecksmelodie · 2025-10-29T08:44:59Z

Overview

Sets up code coverage collection and reporting for both Core (Stencil) and Angular packages in CI.

What's Included

Core Package

✅ Coverage collection with Jest
✅ Coverage artifacts uploaded (30 day retention)
✅ Coverage summary displayed in GitHub Actions workflow
✅ PR comments with diff (overall) coverage using lcov-reporter-action

Angular Package

✅ Coverage collection with Karma
✅ Coverage artifacts uploaded (30 day retention)
✅ Coverage summary displayed in GitHub Actions workflow
✅ PR comments with diff (overall) coverage using lcov-reporter-action
✅ Fixed all failing tests (6 catalyst + 2 catalyst-demo = 8 passing)
✅ ChromeHeadless configured for CI compatibility
✅ karma-spec-reporter for better test output
✅ All 3 projects tested (catalyst, catalyst-formly, catalyst-demo)

Security

Added minimal permissions (contents: read, pull-requests: write) following principle of least privilege
Addresses GitHub Advanced Security bot recommendation

Notes

Unfortunately, the coverage only considers unit tests, not e2e tests, as Stencil's E2E tests run in a browser via Puppeteer, so they don't contribute to Jest coverage. The more modern approach would be to use Playwright for e2e tests which supports coverage natively.
Coverage thresholds intentionally omitted for initial setup - can be added later once baseline is established
PR comments show the overall coverage diff for now so that we can see the coverage baseline in this PR
- Can be adjusted later with filter-changed-files: true to only consider changed files
Both workflows include project-specific titles in coverage reports

What's Not Included

❌ Enforcing a certain coverage threshold on PRs. I think a separate service is required for that (e.g. Codecov)

.github/workflows/angular.yml

glushkova91 · 2025-10-29T10:06:33Z

angular/projects/catalyst-demo/karma.conf.js

+      suppressPassed: false,
+      suppressSkipped: true,
+      showSpecTiming: false,
+      failFast: false


haiilo values detected :)

glushkova91 · 2025-10-29T10:08:10Z

angular/projects/catalyst-demo/karma.conf.js

thanks! karma config file is so much better now

glushkova91 · 2025-10-29T10:12:27Z

core/stencil.config.ts

+    collectCoverage: true,
+    coverageDirectory: 'coverage',
+    coverageReporters: ['text', 'lcov', 'html', 'json-summary'],
+    coveragePathIgnorePatterns: ['/node_modules/', '/.stencil/', '/dist/', '/www/', '/loader/']


do we want to use collectCoverageFrom in addition? for example only ts and tsx files

Good one! I added that so that test and type files are explicitly excluded from coverage.

This is from Copilot:

This gives cleaner coverage metrics focusing only on production code, not test files. You can tell your colleague this is a good suggestion and I've added it with the standard exclusion patterns for test files and type definitions.

😆

glushkova91 · 2025-10-29T10:15:06Z

.github/workflows/angular.yml

+      - name: Build dependencies
+        run: |
+          pnpm run build:tokens
+          pnpm run build:core


you might also need to add

pnpm run build:angular pnpm run build:angular-formly

to make tests work

Thanks, that was missing indeed :)

…nes)

… reporter

This reverts commit ffbe76b.

# Conflicts: # .github/workflows/angular.yml # angular/package.json # angular/projects/catalyst-demo/karma.conf.js # angular/projects/catalyst-formly/karma.conf.js # angular/projects/catalyst/karma.conf.js # angular/projects/catalyst/src/lib/datetime/datetime.component.spec.ts # angular/projects/catalyst/src/lib/dialog/dialog.component.spec.ts # angular/projects/catalyst/src/lib/dialog/dialog.service.spec.ts # pnpm-lock.yaml

# Conflicts: # pnpm-lock.yaml

github-actions · 2026-01-08T14:05:15Z

LCOV of commit `f88c2e0` during Core #1890

Summary coverage rate:
  lines......: 50.8% (1117 of 2198 lines)
  functions..: 43.6% (316 of 724 functions)
  branches...: no data found

Files changed coverage rate: n/a

⛔ The code coverage is too low: 50.82. Expected at least 70.

…e pipeline on new code coverage

github-actions · 2026-01-08T15:58:33Z

Core Coverage Report

Coverage after merging ci/coverage-reporter into main will be

50.82%

Coverage Report for Changed Files

File	Stmts	Branches	Funcs	Lines	Uncovered Lines

github-actions · 2026-01-08T16:23:05Z

Angular Coverage Report

Coverage after merging ci/coverage-reporter into main will be

25.26%

Coverage Report for Changed Files

File	Stmts	Branches	Funcs	Lines	Uncovered Lines

gluecksmelodie added 3 commits October 29, 2025 09:44

ci(core): set up and report code coverage in CI

5d8453b

ci(core): remove coverage thresholds for codebase

fd29489

ci(angular): set up and report code coverage in CI

960e4a3

github-advanced-security bot found potential problems Oct 29, 2025

View reviewed changes

.github/workflows/angular.yml Fixed Show fixed Hide fixed

gluecksmelodie added 3 commits October 29, 2025 10:35

ci(angular): switch to ChromeHeadless for CI and add custom launcher

cb5a5f2

ci(angular): run tests for all 3 angular projects in CI

3be4238

ci(angular): add karma-spec-reporter for improved test output

180630e

glushkova91 reviewed Oct 29, 2025

View reviewed changes

gluecksmelodie added 5 commits October 29, 2025 12:38

test(angular): cleanup tests (remove unnecessary ones, fix sensible o…

b47c058

…nes)

ci(angular): improve test reporting

f6efda5

ci(angular): fix test exeuction in CI

2666a4f

ci(core): restrict coverage to source files

5d84679

ci(angular): set read permissions to workflow

936382d

gluecksmelodie changed the title ~~ci(core): set up and report code coverage in CI~~ ci(core): report code coverage in CI Oct 29, 2025

gluecksmelodie added 6 commits October 29, 2025 13:56

ci(core): fix linting error

11bacfa

ci: add lcov reporter action for coverage reporting on pull requests

74970a8

ci: update permissions for pull requests in CI workflows for coverage…

9037748

… reporter

ci: add project names to coverage PR comments

8e06267

ci: add action for coverage check on changed lines

ffbe76b

Revert "ci: add action for coverage check on changed lines"

09c0452

This reverts commit ffbe76b.

haiilo deleted a comment from github-actions bot Oct 29, 2025

Merge branch 'main' into ci/coverage-reporter

528e1f0

gluecksmelodie marked this pull request as ready for review October 29, 2025 14:58

gluecksmelodie mentioned this pull request Oct 29, 2025

test(core): add some tests #826

Open

glushkova91 mentioned this pull request Dec 5, 2025

update to angular 21 #792

Merged

anastasiia_glushkova added 5 commits December 8, 2025 08:51

Merge branch 'main' into ci/coverage-reporter

c6ea25e

Merge branch 'main' into ci/coverage-reporter

23f351d

# Conflicts: # pnpm-lock.yaml

ci(core): update the lock file

ceab429

ci(core): add write permissions to angular overflow

91b61b6

anastasiia_glushkova added 7 commits January 8, 2026 13:18

ci(core): remove logs

f65bb6b

ci(core): replace coverage report comment with coverage on new code job

2a8b3c2

ci(core): add setup lcov step

b7983c4

ci(core): update config

966c458

ci(core): update config

72047ed

ci(core): update config

af32571

ci(core): remove artifact-name

f88c2e0

ci(core): use reporter for comment in pr and custom script to fail th…

2e5e524

…e pipeline on new code coverage

ci(core): use only custom script for code coverage quality gate

5278190

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ci(core): report code coverage in CI#809

ci(core): report code coverage in CI#809
gluecksmelodie wants to merge 32 commits intomainfrom
ci/coverage-reporter

gluecksmelodie commented Oct 29, 2025 •

edited

Loading

Uh oh!

Uh oh!

glushkova91 Oct 29, 2025

Uh oh!

glushkova91 Oct 29, 2025

Uh oh!

glushkova91 Oct 29, 2025

Uh oh!

gluecksmelodie Oct 29, 2025

Uh oh!

glushkova91 Oct 29, 2025

Uh oh!

gluecksmelodie Oct 29, 2025

Uh oh!

github-actions bot commented Jan 8, 2026

Uh oh!

github-actions bot commented Jan 8, 2026

Uh oh!

github-actions bot commented Jan 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

gluecksmelodie commented Oct 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

What's Included

Core Package

Angular Package

Security

Notes

What's Not Included

Uh oh!

Uh oh!

glushkova91 Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

glushkova91 Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

glushkova91 Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

gluecksmelodie Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

glushkova91 Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

gluecksmelodie Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 8, 2026

LCOV of commit f88c2e0 during Core #1890

Uh oh!

github-actions bot commented Jan 8, 2026

Core Coverage Report

Uh oh!

github-actions bot commented Jan 8, 2026

Angular Coverage Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gluecksmelodie commented Oct 29, 2025 •

edited

Loading

LCOV of commit `f88c2e0` during Core #1890