Vitest Integration with CI Insights

This guide explains how to integrate Vitest with CI Insights using the @mergifyio/vitest reporter. Once installed, test results are automatically uploaded to CI Insights without any extra workflow changes.

You need to install the @mergifyio/vitest package to automatically upload your test results to CI Insights.

npm install --save-dev @mergifyio/vitest

yarn add --dev @mergifyio/vitest

pnpm add --save-dev @mergifyio/vitest

Add the Mergify reporter to your vitest.config.ts (or vite.config.ts):

import { defineConfig } from 'vitest/config';
import MergifyReporter from '@mergifyio/vitest';

export default defineConfig({
  test: {
    reporters: ['default', new MergifyReporter()],
  },
});

The 'default' reporter keeps the standard console output alongside the Mergify reporter.

Your workflow should run your tests as usual while exporting the secret MERGIFY_TOKEN as an environment variable. You’ll need to add the following code to the GitHub Actions step running your tests:

env:
  MERGIFY_TOKEN: ${{ secrets.MERGIFY_TOKEN }}

For example:

- name: Run Tests 🧪
  env:
    MERGIFY_TOKEN: ${{ secrets.MERGIFY_TOKEN }}
  run: npm test

The reporter automatically collects your test results and sends them to CI Insights.

Check the CI Insights dashboard afterward to view execution metrics, detect flaky tests, and gather actionable feedback.