Skip to main content
Trunk Flaky Tests integrates with your CI provider by adding an upload step in each of your testing CI jobs via the trunk CLI.
Not using GitHub for source control?Flaky Test support for source control providers like GitLab and BitBucket is still experimental. If you’re using a source control provider other than GitHub, contact us to get started.
Before you start on these steps, see the Test Frameworks docs for instructions on producing JUnit XML output for your test runner, supported by virtually all test frameworks, which is what Trunk ingests.

Setup steps

Work through the steps below in order. Once you’ve finished the last one, you’re set up — navigate to app.trunk.io to see your results.

Trunk Organization Slug and API Key

Before setting up uploads to Trunk, you must sign in to app.trunk.io and obtain your Trunk organization slug, an API key, and the ID of the test collection to upload to.

Trunk Slug

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

Trunk API Key

Create an API key under Settings → Developer → API Keys with the Create Key button, and select the Upload test results permission. The key starts with trunk_v2_ and is shown only once. See Create an API key.

Test Collection ID

Create a test collection under Flaky Tests → Collections, or open an existing one, and copy its ID from the collection’s page header. It is not a secret, so you can include it directly in your upload command.

Add the API Key as a Secret

Store the API key in your CI provider as a secret named TRUNK_API_KEY. Store the organization slug as a variable named TRUNK_ORG_URL_SLUG.

Upload to Trunk

Add an Upload Test Results step after running tests in each of your CI jobs that run tests. This should be minimally all jobs that run on pull requests, as well as from 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 Upload Script

The following script installs the trunk CLI, stores your API key, and uploads test results after your tests run. Run trunk flakytests from the repository root, or pass --repo-root. To find out how to produce the report files the uploader needs, see the instructions for your test framework in the frameworks docs.
To run your tests and upload in one step, so that quarantined failures don’t fail the job, wrap the test command instead:
The installer supports Linux and macOS 14 or later. If it reports that its install directory isn’t on your PATH, add it, or pass --install-dir. Most CI providers set CI=true, which turns off the CLI’s automatic updates; to pin the CLI and the Trunk Analytics CLI it runs, see Pin versions.
Run trunk flakytests validate --junit-paths <PATH_TO_REPORTS> on your reports before you upload to catch malformed JUnit XML early.
See the CLI reference for all available command line arguments and usage.

Running trunk-analytics-cli directly

You can also download the Trunk Analytics CLI and run it yourself, without the trunk CLI. Pass it the API key with --token or the TRUNK_API_TOKEN environment variable:
For the other platforms and for pinning a version, see Manual Download.

Environment Variables

Set these environment variables before running trunk flakytests upload on unsupported CI systems:
Config Requirement: CUSTOM must be set to true for environment variables to take effect and override the auto-detection of CI.All other variables are optional but recommended.

About JOB_URL

The JOB_URL variable controls where the “Logs” link in Trunk Flaky Tests points to. When users click “Logs” on a test failure, they’ll be taken to this URL to view the complete CI job output. Best practice: Provide the most specific link possible:
  • Direct link to the specific job/build where the test ran
  • Link that shows the full logs and test output
  • Avoid dashboard or workflow overview links (less helpful for debugging)
For GitHub Actions users: While GitHub Actions is auto-detected, you can override the default workflow URL with a direct job URL. See GitHub Actions - Getting Direct Links to Job Logs for instructions.

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.

Validate Your Uploads

Once your pipeline has run on a stable branch, navigate to app.trunk.io and confirm Trunk received your results.
  • The Uploads tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on).
  • The Tests tab shows individual test cases once an upload has been processed.
If a recent run isn’t showing up, check your CI logs for upload errors and confirm your TRUNK_API_KEY secret and TRUNK_ORG_URL_SLUG variable are set on the project running the pipeline, the key has the Upload test results permission, and the collection ID is correct.