Skip to main content

Example Workflows

Complete workflow examples for common scenarios. Mix and match outputs from the setup guide.

Pull Request — Full Reporting​

PR comments, workflow summary, checks, and HTML artifact:

name: CI

on:
  pull_request:
  push:
    branches: [main]

permissions:
  contents: read
  pull-requests: write
  checks: write

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Run tests
        run: dotnet test --logger "trx;LogFileName=results.trx"

      - name: Publish test report
        uses: mzbrau/actions-insights@v1
        with:
          test-results: '**/*.trx'
          comment-mode: update
          generate-job-summary: true
          upload-html-report: true
          publish-checks: true

Main Branch — No PR Comments​

- uses: mzbrau/actions-insights@v1
  with:
    test-results: '**/*.trx'
    comment-mode: off
    generate-job-summary: true
    upload-html-report: true

Minimal — Summary Only​

permissions:
  contents: read

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: dotnet test --logger "trx;LogFileName=results.trx"
      - uses: mzbrau/actions-insights@v1
        with:
          test-results: '**/*.trx'
          comment-mode: off
          upload-html-report: false
          publish-checks: false

With History Repository​

permissions:
  contents: read
  pull-requests: write
  checks: write

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: dotnet test --logger "trx;LogFileName=results.trx"
      - uses: mzbrau/actions-insights@v1
        with:
          test-results: '**/*.trx'
          history-enabled: true
          history-repository: 'my-org/actions-insights-history'
          history-token: ${{ secrets.HISTORY_REPO_TOKEN }}

See History Repository Deployment for one-time setup.

Java (JUnit)​

- run: mvn test
- uses: mzbrau/actions-insights@v1
  with:
    test-results: '**/TEST-*.xml'

Migrating from GitHub Pages​

If you previously used a separate deploy-pages job, see Migrate from GitHub Pages Publishing.

Full Reference​

Configuration Reference — every input, output, and deprecated option.