GITBOOK-731: No subject

gewenyu99 · gitbook-bot · commit 89b0dde86e37 · 2025-03-12T22:34:56.000Z
diff --git a/.gitbook/includes/have-questions-join-us-and-....md b/.gitbook/includes/have-questions-join-us-and-....md
@@ -0,0 +1,9 @@
+---
+title: Have questions?Join us and ...
+---
+
+{% hint style="success" %}
+**Have questions?**
+
+Join us and 1500+ fellow engineers [on Slack](https://slack.trunk.io/) to get help with Trunk.
+{% endhint %}
diff --git a/.gitbook/includes/you-must-upload-tests-from-....md b/.gitbook/includes/you-must-upload-tests-from-....md
@@ -0,0 +1,9 @@
+---
+title: You must upload tests from ...
+---
+
+{% hint style="danger" %}
+You must upload tests from both PR and [**stable branchs**](https://docs.trunk.io/flaky-tests/detection#stable-branches), 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.&#x20;
+
+[Learn more about detection](../../flaky-tests/detection.md)
+{% endhint %}
diff --git a/flaky-tests/get-started/README.md b/flaky-tests/get-started/README.md
@@ -26,6 +26,8 @@ You can follow along using the in-app onboarding wizard or read about it in our
 
 After you've set your test framework to output test results, you're ready to update your CI jobs to upload test results to Trunk.
 
+{% include "../../.gitbook/includes/you-must-upload-tests-from-....md" %}
+
 <figure><picture><source srcset="../../.gitbook/assets/add-test-framework-step-4-dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/add-test-framework-step-4-light.png" alt=""></picture><figcaption><p>Step 4 of the in-app onboarding wizard</p></figcaption></figure>
 
 You can follow along using the in-app onboarding wizard or read about it in our docs.
@@ -54,8 +56,6 @@ Flaky Tests can post comments on GitHub pull requests to provide a summary of al
 
 <figure><picture><source srcset="../../.gitbook/assets/github-comment-dark.png" media="(prefers-color-scheme: dark)"><img src="../../.gitbook/assets/github-comment-light.png" alt=""></picture><figcaption></figcaption></figure>
 
-
-
 To enable PR Comments, see our documentation:
 
 {% embed url="https://docs.trunk.io/flaky-tests/github-pull-request-comments" %}
@@ -67,3 +67,5 @@ Quarantining is an advanced feature that allows your CI test jobs to pass even i
 To enable Quarantining, see our documentation:
 
 {% embed url="https://docs.trunk.io/flaky-tests/quarantining" %}
+
+{% include "../../.gitbook/includes/have-questions-join-us-and-....md" %}
diff --git a/flaky-tests/get-started/ci-providers/azure-devops-pipelines.md b/flaky-tests/get-started/ci-providers/azure-devops-pipelines.md
@@ -26,6 +26,8 @@ Your Trunk Organization Slug can be pasted directly into your CI workflow; it's
 
 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 [stable branches](../../detection.md#stable-branches), for example, `main`, `master`, or `develop`.
 
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
+
 #### Add Uploader to Testing Pipelines
 
 The following is an example of a workflow step 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.
@@ -60,6 +62,5 @@ Ensure you report every test run in CI and **clean up stale files** produced by
 
 [Learn more about cleaning up artifacts in Azure DevOps Pipelines](https://learn.microsoft.com/en-us/azure/devops/pipelines/repos/pipeline-options-for-git?view=azure-devops\&tabs=yaml#clean-the-local-repo-on-the-agent)
 
-#### Need Help?
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
 
-Join the [Trunk Slack Community](https://slack.trunk.io) for live support.
diff --git a/flaky-tests/get-started/ci-providers/bitbucket-pipelines.md b/flaky-tests/get-started/ci-providers/bitbucket-pipelines.md
@@ -12,7 +12,7 @@ In [app.trunk.io](https://app.trunk.io/login?intent=flaky%20tests), navigate to:
 
 **Settings > Organization > Manage > Organization API Token > View Organization API Token > View**
 
-Store your API Token in your BitBucket  as a new variable named `TRUNK_TOKEN`. Make sure you are getting your _organization token_, not your project/repo token.
+Store your API Token in your BitBucket as a new variable named `TRUNK_TOKEN`. Make sure you are getting your _organization token_, not your project/repo token.
 
 ### 2. Grab your Organization Slug
 
@@ -26,6 +26,8 @@ Your Trunk Organization Slug can be pasted directly into your CI workflow; it's
 
 Add an `after-script` 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](../../detection.md#stable-branches), for example, `main`, `master`, or `develop`.
 
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
+
 #### Add Uploader to Testing Pipelines
 
 The following is an example of a workflow step 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.
@@ -61,6 +63,4 @@ Ensure you report every test run in CI and **clean up stale files** produced by
 
 You can do this by omitting the `artifacts` definitions in the test steps of your configuration. [Learn more about artifacts in BitBucket Pipelines](https://support.atlassian.com/bitbucket-cloud/docs/use-artifacts-in-steps/).
 
-#### Need Help?
-
-Join the [Trunk Slack Community](https://slack.trunk.io) for live support.
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
diff --git a/flaky-tests/get-started/ci-providers/buildkite.md b/flaky-tests/get-started/ci-providers/buildkite.md
@@ -30,6 +30,8 @@ Your Trunk Organization Slug can just be pasted directly into your CI workflow;
 
 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 [stable branches](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`.
 
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
+
 #### Example Buildkite Pipeline
 
 The following is an example of a Buildkite step 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.
@@ -57,6 +59,4 @@ See the [uploader.md](../../uploader.md "mention") for all available command lin
 
 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.
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
diff --git a/flaky-tests/get-started/ci-providers/circleci.md b/flaky-tests/get-started/ci-providers/circleci.md
@@ -30,6 +30,8 @@ Your Trunk Organization Slug can just be pasted directly into your CI workflow;
 
 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](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`.
 
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
+
 #### Example CircleCI workflow
 
 The following is an example of a workflow step 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.
@@ -59,6 +61,4 @@ See the [Uploader CLI Reference](https://docs.trunk.io/flaky-tests/uploader) for
 
 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.
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
diff --git a/flaky-tests/get-started/ci-providers/droneci.md b/flaky-tests/get-started/ci-providers/droneci.md
@@ -30,6 +30,8 @@ Your Trunk Organization Slug can just be pasted directly into your CI workflow;
 
 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 [stable branches](../../detection.md#stable-branches), for example, `main`, `master`, or `develop`.
 
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
+
 #### Add Uploader to Testing Pipelines
 
 The following is an example of a workflow step 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.
@@ -62,6 +64,4 @@ See the [uploader.md](../../uploader.md "mention") for all available command lin
 
 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.
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
diff --git a/flaky-tests/get-started/ci-providers/github-actions.md b/flaky-tests/get-started/ci-providers/github-actions.md
@@ -30,6 +30,8 @@ Your Trunk Organization Slug can just be pasted directly into your CI workflow;
 
 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](../../detection.md#stable-branches), for example: `main`, `master`, or `develop`.
 
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
+
 #### Example GitHub Actions Workflow
 
 The following is an example of a GitHub Actions workflow step to upload test results after your tests using Trunk's [**Analytics Uploader Action**](https://github.com/trunk-io/analytics-uploader).
@@ -63,6 +65,4 @@ See the [uploader.md](../../uploader.md "mention") for all available command lin
 
 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.
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
diff --git a/flaky-tests/get-started/ci-providers/gitlab.md b/flaky-tests/get-started/ci-providers/gitlab.md
@@ -28,7 +28,9 @@ Your Trunk Organization Slug can just be pasted directly into your CI workflow;
 
 ### 3. Modify GitLab pipelines to upload test results
 
-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](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`..
+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](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`.
+
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
 
 #### Example GitLab Pipeline
 
@@ -60,6 +62,4 @@ See the [uploader.md](../../uploader.md "mention") for all available command lin
 
 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.
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
diff --git a/flaky-tests/get-started/ci-providers/jenkins.md b/flaky-tests/get-started/ci-providers/jenkins.md
@@ -28,7 +28,9 @@ Your Trunk Organization Slug can just be pasted directly into your CI workflow;
 
 ### 3. Modify Jenkins pipeline to upload test results
 
-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](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`..
+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](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`.
+
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
 
 #### Example Jenkins Pipeline
 
@@ -59,6 +61,4 @@ See the [uploader.md](../../uploader.md "mention") for all available command lin
 
 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.
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
diff --git a/flaky-tests/get-started/ci-providers/otherci.md b/flaky-tests/get-started/ci-providers/otherci.md
@@ -28,7 +28,9 @@ Your Trunk Organization Slug can just be pasted directly into your CI workflow;
 
 ### 3. Modify workflows to upload test results
 
-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](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`..
+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](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`.
+
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
 
 #### Example Upload Script
 
@@ -47,6 +49,4 @@ See the [uploader.md](../../uploader.md "mention") for all available command lin
 
 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.
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
diff --git a/flaky-tests/get-started/ci-providers/semaphoreci.md b/flaky-tests/get-started/ci-providers/semaphoreci.md
@@ -28,7 +28,9 @@ Your Trunk Organization Slug can just be pasted directly into your CI workflow;
 
 ### 3. Modify Semaphore CI workflows to upload test results
 
-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](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`..
+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](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`.
+
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
 
 #### Example Semaphore CI Workflow
 
@@ -72,6 +74,4 @@ See the [uploader.md](../../uploader.md "mention") for all available command lin
 
 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.
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
diff --git a/flaky-tests/get-started/ci-providers/teamcity.md b/flaky-tests/get-started/ci-providers/teamcity.md
@@ -26,6 +26,8 @@ Your slug can just be pasted directly into your CI workflow; it's not a secret.
 
 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 [stable branches](../../detection.md#stable-branches), for example, `main`, `master`, or `develop`.
 
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
+
 #### Add Uploader to a Build Step
 
 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.
@@ -38,7 +40,7 @@ chmod +x ./trunk
     --token $TRUNK_TOKEN
 ```
 
-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.&#x20;
+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 JUnit XML files the uploader needs, see the instructions for your test framework in the [Test Frameworks](https://docs.trunk.io/flaky-tests/frameworks) docs.
 
@@ -50,6 +52,4 @@ Ensure you report every test run in CI and **clean up stale files** produced by
 
 You can do this in TeamCity by omitting your JUnit XML path in the saved artifacts. [Learn more about artifacts in TeamCity](https://www.jetbrains.com/help/teamcity/cloud/configure-and-run-your-first-build.html#Artifacts).
 
-#### Need Help?
-
-Join the [Trunk Slack Community](https://slack.trunk.io) for live support.
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
diff --git a/flaky-tests/get-started/ci-providers/travisci.md b/flaky-tests/get-started/ci-providers/travisci.md
@@ -28,7 +28,9 @@ Your Trunk Organization Slug can just be pasted directly into your CI workflow;
 
 ### 3. Modify Travis CI workflows to upload test results
 
-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](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`..
+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](../../detection.md#stable-branches), for example,`main`, `master`, or `develop`.
+
+{% include "../../../.gitbook/includes/you-must-upload-tests-from-....md" %}
 
 #### Example Travis CI Workflow
 
@@ -54,6 +56,4 @@ See the [uploader.md](../../uploader.md "mention") for all available command lin
 
 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.
+{% include "../../../.gitbook/includes/have-questions-join-us-and-....md" %}
