GITBOOK-641: No subject

trunk-io · Nov 12, 2024 · d68b625 · d68b625
1 parent 8c09c40
commit d68b625
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 9 deletions.
diff --git a/flaky-tests/get-started/README.md b/flaky-tests/get-started/README.md
@@ -8,7 +8,7 @@ Trunk Flaky Tests works by changing all of your CI jobs that run tests to upload
 
 You must create an account and Trunk organization to complete the steps below.&#x20;
 
-### 2. Configure your test framework to output test results
+### 2. Configure your test framework to output compatible test results
 
 For Trunk to start detecting flaky tests, it needs to ingest the results from all of your CI test runs. To get started, configure your test framework (jest, pytest, gtest, etc) to output results. You'll do this only for CI jobs, _not_ for running tests locally.
 
@@ -20,14 +20,6 @@ After you've set your test framework to output test results, you're ready to act
 
 Check out our guides to the most popular CI systems: [ci-providers](ci-providers/ "mention")
 
-{% hint style="info" %}
-#### Stale files
-
-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 `./results/*.xml` to upload tests, stale files not cleaned up will be included as a part of the current test run.
-
-You should clean up all your results files after every upload step.
-{% endhint %}
-
 Once you've merged changes to your CI test jobs, make sure you've run at least 1 testing job, and your newly added upload step has completed.
 
 ### 4. Confirm your configuration, analyze your dashboard

diff --git a/flaky-tests/get-started/ci-providers/buildkite.md b/flaky-tests/get-started/ci-providers/buildkite.md
@@ -53,6 +53,10 @@ steps:
 
 See the [uploader.md](../../uploader.md "mention") for all available command line arguments and usage.
 
+#### Stale files
+
+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.
+
 #### Need Help?
 
 Join the [Trunk Slack Community](https://slack.trunk.io) for live support.
diff --git a/flaky-tests/get-started/ci-providers/circleci.md b/flaky-tests/get-started/ci-providers/circleci.md
@@ -55,6 +55,10 @@ jobs:
 
 See the [Uploader CLI Reference](https://docs.trunk.io/flaky-tests/uploader) for all available command line arguments and usage.
 
+#### Stale files
+
+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.
+
 **Need Help?**
 
 Join the [Trunk Slack Community](https://slack.trunk.io/) for live support.

diff --git a/flaky-tests/get-started/ci-providers/droneci.md b/flaky-tests/get-started/ci-providers/droneci.md
@@ -58,6 +58,10 @@ steps:
 
 See the [uploader.md](../../uploader.md "mention") for all available command line arguments and usage.
 
+#### Stale files
+
+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.
+
 #### Need Help?
 
 Join the [Trunk Slack Community](https://slack.trunk.io) for live support.
diff --git a/flaky-tests/get-started/ci-providers/github-actions.md b/flaky-tests/get-started/ci-providers/github-actions.md
@@ -59,6 +59,10 @@ jobs:
 
 See the [uploader.md](../../uploader.md "mention") for all available command line arguments and usage.
 
+#### Stale files
+
+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.
+
 #### Need Help?
 
 Join the [Trunk Slack Community](https://slack.trunk.io) for live support.\
diff --git a/flaky-tests/get-started/ci-providers/gitlab.md b/flaky-tests/get-started/ci-providers/gitlab.md
@@ -56,6 +56,10 @@ upload_test_results: # This job uploads tests results run in the last stage
 
 See the [uploader.md](../../uploader.md "mention") for all available command line arguments and usage.
 
+#### Stale files
+
+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.
+
 #### Need Help?
 
 Join the [Trunk Slack Community](https://slack.trunk.io) for live support.
diff --git a/flaky-tests/get-started/ci-providers/jenkins.md b/flaky-tests/get-started/ci-providers/jenkins.md
@@ -55,6 +55,10 @@ pipeline {
 
 See the [uploader.md](../../uploader.md "mention") for all available command line arguments and usage.
 
+#### Stale files
+
+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.
+
 #### Need Help?
 
 Join the [Trunk Slack Community](https://slack.trunk.io) for live support.
diff --git a/flaky-tests/get-started/ci-providers/otherci.md b/flaky-tests/get-started/ci-providers/otherci.md
@@ -43,6 +43,10 @@ curl -fsSLO --retry 3 https://trunk.io/releases/trunk && chmod +x trunk
 
 See the [uploader.md](../../uploader.md "mention") for all available command line arguments and usage.
 
+#### Stale files
+
+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.
+
 #### Need Help?
 
 Join the [Trunk Slack Community](https://slack.trunk.io) for live support.
diff --git a/flaky-tests/get-started/ci-providers/semaphoreci.md b/flaky-tests/get-started/ci-providers/semaphoreci.md
@@ -68,6 +68,10 @@ blocks:
 
 See the [uploader.md](../../uploader.md "mention") for all available command line arguments and usage.
 
+#### Stale files
+
+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.
+
 #### Need Help?
 
 Join the [Trunk Slack Community](https://slack.trunk.io) for live support.

diff --git a/flaky-tests/get-started/ci-providers/travisci.md b/flaky-tests/get-started/ci-providers/travisci.md
@@ -50,6 +50,10 @@ script:
 
 See the [uploader.md](../../uploader.md "mention") for all available command line arguments and usage.
 
+#### Stale files
+
+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.
+
 #### Need Help?
 
 Join the [Trunk Slack Community](https://slack.trunk.io) for live support.