| description |
|---|
Configure Flaky Tests using any CI Provider |
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.
{% include "../../../.gitbook/includes/ci-provider-checklist.md" %}
{% include "../../../.gitbook/includes/trunk-organization-slug-and....md" %}
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.
{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
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 frameworks docs.
curl -fsSLO --retry 3 https://trunk.io/releases/trunk && chmod +x trunk
./trunk flakytests upload --junit-paths "**/report.xml" --org-url-slug <TRUNK_ORG_SLUG> --token "${TRUNK_TOKEN}"See the uploader.md 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.
{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}