SlackLogin

GitHub Actions

Configure Flaky Tests detection using a GitHub Action

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

To upload test results to Trunk, you'll need to pass a Trunk Organization Slug to the upload command. To get your organization slug, In app.trunk.io, navigate to:

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.

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 > Manage > Organization Name > Slug. You'll save this as a variable in CI in a later step.

Trunk Token

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

Add the Trunk Token as a Secret

Store the Trunk slug and API token obtained in the previous step in your as GitHub secrets named TRUNK_ORG_SLUG and TRUNK_TOKEN respectively.

Upload to Trunk

You must upload tests from both PR and stable branches, such as main, master, or develop in CI for Trunk to detect flaky tests. Trunk will not detect flaky tests without uploads from both PR and stable branches.

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.

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@main
        with:
          junit-paths: "**/junit.xml"        
          org-slug: <TRUNK_ORG_SLUG>
          token: ${{ secrets.TRUNK_TOKEN }}

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

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@main
        with:
          junit-paths: "<XML_GLOB_PATH>"       
          org-slug: <TRUNK_ORG_SLUG>
          token: ${{ secrets.TRUNK_TOKEN }}

See the Uploader CLI Reference for all available command line arguments and usage.

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.

Last updated