Installing TestGlance for Jest

1. Make tests emit JUnit XML

Install the JUnit reporter:

npm install --save-dev jest-junit
# or: pnpm add -D jest-junit
# or: yarn add -D jest-junit

Update jest.config.js (or whatever config file your project uses) to register the reporter:

// jest.config.js
module.exports = {
  reporters: ['default', 'jest-junit'],
};

Set the output path via env var in CI so the report lands under test-results/. Add this to the test job's environment in .github/workflows/*.yml:

env:
  JEST_JUNIT_OUTPUT_DIR: test-results
  JEST_JUNIT_OUTPUT_NAME: junit.xml

2. Add the TestGlance step to CI

If the project already has a CI workflow that runs the tests, add this step to the test job (after the test step), and merge the permissions: block at the workflow's top level:

permissions:
  contents: read
  pull-requests: write
 
# ...inside the test job, after the test step:
- uses: testglance/action@v1
  if: always()
  with:
    github-token: ${{ github.token }}

If no CI workflow runs the tests yet, create .github/workflows/testglance.yml that runs the project's tests and then runs the TestGlance step.

if: always() matters — TestGlance should still run when tests fail. TestGlance auto-discovers anything matching **/test-results/*.xml, so no report-path is needed when reports land under test-results/.

3. Confirm with the user before committing

Summarize the diff and ask the user to confirm before staging or committing. Do not push.