TeamCity
Last updated
Last updated
Trunk Flaky Tests integrates with your CI by adding a step in your TeamCity Pipelines 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 TeamCity project by navigating to Admin > Build > Parameters > Add new parameter and adding new environment variables as TRUNK_ORG_SLUG and TRUNK_TOKEN respectively.
Add an upload 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 stable branches, for example, main, master, or develop.
Add the following command as a build step after your test run to upload test results. Note: you must either run trunk from the repo root when uploading test results or pass a --repo-root argument.
In your build step settings under the Show advanced options toggle, find the Execute step settings and select Always, even if build stop command was issued to ensure that the Upload step will still run if tests have failed.
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.
You can do this in TeamCity by omitting your JUnit XML path in the saved artifacts. Learn more about artifacts in TeamCity.
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.
By the end of this guide, you should achieve the following.
After completing these checklist items, you'll be integrated 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.