GitHub Actions

Configure Flaky Tests detection using a GitHub Action

Before you start these steps, see the Test Frameworks docs for instructions on producing Trunk-compatible reports for your test runner.

Trunk Flaky Tests integrates with your CI by adding a step in your GitHub Action workflow to upload tests with the Trunk Uploader CLI.

Before you start on these steps, see the Test Frameworks docs for instructions on producing a Trunk-compatible output for your test framework.

Checklist

By the end of this guide, you should achieve the following.

• Get your Trunk organization slug and token

• Set your slug and token as secrets in GitHub Actions

• Configure GitHub Actions to upload to Trunk

• Validate your uploads in Trunk

After completing these checklist items, you'll be integrated with Trunk.

Trunk Organization Slug and Token

Before setting up uploads to Trunk, you must sign in to app.trunk.io and obtain your Trunk organization slug and token.

Trunk Slug

You can find your organization slug under Settings > Organization > General > Organization > Name. You'll save this as a variable in CI in a later step.

Trunk Token

You can find your token under Settings > Organization > General > API > API Key. Since this is a secret, do not leak it publicly. Ensure you get your organization token, not your project/repo token.

Add Your Trunk Token and Organization Slug as Secrets

Store the Trunk slug and API token obtained in the previous step in your repo as GitHub secrets named TRUNK_ORG_URL_SLUG and TRUNK_API_TOKEN respectively.

Upload to Trunk

Add an Upload Test Results step after running tests in each of your CI jobs that run tests. This should minimally include all jobs that run on pull requests, as well as jobs that run on your main or stable branches, for example, main, master, or develop.

It is important to upload test results from CI runs on stable branches, such as main, master, or develop. This will give you a stronger signal about the health of your code and tests.

Trunk can also detect test flakes on PR and merge branches. To best detect flaky tests, it is recommended to upload test results from stable, PR, and merge branch CI runs.

Learn more about detection

Example GitHub Actions Workflow

The following is an example of a GitHub Actions workflow step to upload test results after your tests using Trunk's Analytics Uploader Action.

To find out how to produce the report files the uploader needs, see the instructions for your test framework in the Test Frameworks docs.

JUnit XML

jobs:
  test:
    name: Upload Tests
    runs-on: ubuntu-latest

    steps:
      - name: Run Tests
        run: ...

      - name: Upload Test Results to Trunk.io
        if: ${{ !cancelled() }} # Upload the results even if the tests fail
        continue-on-error: true # don't fail this job if the upload fails
        uses: trunk-io/analytics-uploader@v1
        with:
          junit-paths: **/junit.xml        
          org-slug: <TRUNK_ORG_SLUG>
          token: ${{ secrets.TRUNK_TOKEN }}

XCResult Path

Bazel BEP JSON

RSpec plugin

See the GitHub Actions Reference page for all available CLI arguments and usage.

Enable quarantining

You can quarantine flaky tests by wrapping the test command or as a follow-up step.

GitHub Actions Workflow

Using the Trunk Analytics Uploader Action in your GitHub Actions Workflow files, may need modifications to your workflow files to support quarantining.

If you upload your test results as a second step after you run your tests, you need to add continue-on-error: true on your test step so your CI job will continue even on failures.

Here's an example file.

name: Run Tests And Upload Results
on:
  workflow_dispatch:
jobs:
  upload-test-results:
    runs-on: ubuntu-latest
    timeout-minutes: 60
    steps:   
    - name: Run Tests
      id: unit_tests
      shell: bash
      run: <COMMAND TO RUN TESTS> # command to run tests goes here
      continue-on-error: true # ensure CI job continues to upload step on errors
        
    - name: Upload test results
      if: always()
      uses: trunk-io/analytics-uploader@v1
      with:
        junit-paths: <TEST OUTPUT PATH>
        org-slug: my-trunk-org-slug
        token: ${{ secrets.TRUNK_API_TOKEN }}

If you want to run the test command and upload in a single step, the test command must be run via the Analytics Uploader through the run: <COMMAND TO RUN TESTS> parameter.

This will override the response code of the test command. Make sure to set continue-on-error: false so un-quarantined tests are blocking.

name: Run Tests And Upload Results
on:
  workflow_dispatch:
jobs:
  upload-test-results:
    runs-on: ubuntu-latest
    timeout-minutes: 60
    steps:
      - name: Checkout
        uses: actions/checkout@v3

      - name: Run tests and upload results
        uses: trunk-io/analytics-uploader@v1
        with:
          junit-paths: <TEST OUTPUT PATH>
          run: <COMMAND TO RUN TESTS> # command to run tests goes here
          org-slug: my-trunk-org-slug
          token: ${{ secrets.TRUNK_API_TOKEN }}

Using The Trunk CLI Directly

Stale files

Ensure you report every test run in CI and clean up stale files produced by your test framework. If you're reusing test runners and using a glob like **/junit.xml to upload tests, stale files not cleaned up will be included in the current test run, throwing off detection of flakiness. You should clean up all your results files after every upload step.

Have questions?

Join us and 1500+ fellow engineers on Slack to get help with Trunk.