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 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.
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.
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.
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.
See the GitHub Actions Reference page for all available command line arguments and usage.
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.
By the end of this guide, you should achieve the following.
After completing these checklist items, you'll be integrated with Trunk.
You must upload tests from both PR and stable branchs, 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.