Imported from testglance/action (AGENTS.md). Install upstream with npx skills add testglance/action. Copyright stays with the author.

AGENTS.md — TestGlance Action

Single source of truth for agent guidance — cross-tool (Cursor, Codex, Copilot, Claude Code, …). CLAUDE.md imports this file via @AGENTS.md, so edit it here, not there. Deep reference docs live in .agents/ and are loaded on demand.

GitHub Action that parses test reports (JUnit XML, CTRF JSON), derives history/analytics, and renders results to the CI summary, PR comments, check-run annotations, and an HTML report — optionally sending them to the TestGlance API.

Overview

• Repo: testglance/action — standalone, separate from the TestGlance SaaS codebase.
• Runtime: GitHub Actions node24 (action.yml → using: 'node24').
• Language: TypeScript (strict). Package manager: pnpm. Tests: Vitest.
• Two modes: API mode (api-key set → POST /api/v1/runs) and local-only mode (no api-key → summary / PR comment / check run still work, nothing is sent).
• Build: @vercel/ncc bundles to dist/index.js. dist/ is gitignored; CI builds it and commits it to main (the release-v1 job). Never commit dist/ from a branch.

Commands

pnpm test          # run tests (vitest run)
pnpm test:watch    # tests in watch mode
pnpm build         # bundle to dist/index.js (ncc) — local verify only
pnpm typecheck     # tsc --noEmit
pnpm lint          # eslint            (lint:fix to autofix)
pnpm format:check  # prettier --check  (format to write)
pnpm e2e:act       # local e2e smoke via act (skips gracefully without docker/act)

Critical rules (non-negotiable)

1. Never call core.setFailed(); always exit 0. This Action must never break a consumer's CI (product req FR5). Route every error through core.warning().
2. Recount results from <testcase>/test elements — never trust suite-level count attributes.
3. Use fast-xml-parser for XML — not xml2js, not cheerio.
4. Never commit dist/. It's gitignored and produced by CI; pnpm build locally only to verify the bundle compiles.
5. Tests use real fixtures from fixtures/ — small ones committed, large ones generated at test time.

See .agents/conventions.md for rationale, and .agents/known-issues.md before "fixing" anything that looks off.

Conventions (cheat-sheet)

• Files: kebab-case.ts · Functions: camelCase, verb-first · Types: PascalCase · Constants: UPPER_SNAKE_CASE
• Tests: {module}.test.ts in __tests__/ dirs.
• Self-documenting code: no WHAT comments; WHY-comments only for non-obvious decisions.

Where to read more — routing table