GitLab
Configure Flaky Tests using GitLab CI
Last updated
Configure Flaky Tests using GitLab CI
Last updated
Trunk Flaky Tests integrates with your CI by adding a step in your GitLab CI/CD pipelines to upload tests with the .
Before you start on these steps, see the docs for instructions on producing a Trunk-compatible output for your test framework.
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 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.
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.
The following is an example of a GitLab pipeline step 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?
Store the Trunk slug and API token obtained in the previous step in your GitLab CI/CD pipelines as new named 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 , for example, main, master, or develop.
It is important to upload test results from CI runs on , such as main, master, or develop. This will give you a stronger signal about the health of your code and tests.
To find out how to produce the report files the uploader needs, see the instructions for your test framework in the docs.
Join us and 1500+ fellow engineers 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, to get started.