Other CI Providers
Configure Flaky Tests using any CI Provider
Last updated
Configure Flaky Tests using any CI Provider
Last updated
Trunk Flaky Tests integrates with your CI provider by adding an upload step in each of your testing CI jobs via the Trunk Uploader CLI.
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.
By the end of this guide, you should achieve the following.
After completing these checklist items, you'll be integrated with Trunk.
Before setting up uploads to Trunk, you must sign in to app.trunk.io and obtain your Trunk organization slug and token.
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.
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.
Store the Trunk slug and API token obtained in the previous step in your CI provider as a secret, environment variable, or an equivalent concept and name them TRUNK_ORG_SLUG and TRUNK_TOKEN respectively.
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.
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.
The following is an example of a script to upload test results after your tests run. Note: you must either run trunk from the repo root when uploading test results or pass a --repo-root argument.
To find out how to produce the report files the uploader needs, see the instructions for your test framework in the Test Frameworks docs.
See the Uploader CLI Reference for all available command line arguments and usage.
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.
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.