GitHub Actions
Configure Flaky Tests detection using a GitHub Action
Last updated
Configure Flaky Tests detection using a GitHub Action
Last updated
Before you start these steps, see the 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 .
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.
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 repo as named TRUNK_ORG_URL_SLUG and TRUNK_API_TOKEN respectively.
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 , for example, main, master, or develop.
You must upload tests from both PR and , 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 GitHub Actions workflow step to upload test results after your tests using Trunk's .
See the for all available command line arguments and usage.
Join us and 1500+ fellow engineers to get help with Trunk.