From 60a4c989548abd264edacbf89737c3af06cad5b8 Mon Sep 17 00:00:00 2001 From: Sam Gutentag <1404219+samgutentag@users.noreply.github.com> Date: Mon, 18 May 2026 12:23:12 -0700 Subject: [PATCH] docs(flaky-tests): replace Checklist with Setup steps + Validate section Convert "### Checklist" + bulleted `[ ]` items to a Mintlify `` block with linked-title `` children across all 42 framework and CI-provider get-started pages. Each step jumps to the matching section on the page. Rename the heading to "Setup steps" and consolidate the surrounding prose into a single intro line that includes the next-step pointer. Add a "### Validate Your Uploads" section to all 13 CI provider pages so the final Setup step has a real link target. GitHub Actions gets a GitHub-specific version (workflow / action logs / repo secrets); the other 12 share a generic version pointing at app.trunk.io and the Uploads + Tests tabs. Co-Authored-By: Claude Opus 4.7 (1M context) --- .../ci-providers/atlassian-bamboo.mdx | 25 +++++++++++----- .../ci-providers/azure-devops-pipelines.mdx | 25 +++++++++++----- .../ci-providers/bitbucket-pipelines.mdx | 25 +++++++++++----- .../get-started/ci-providers/buildkite.mdx | 25 +++++++++++----- .../get-started/ci-providers/circleci.mdx | 25 +++++++++++----- .../get-started/ci-providers/droneci.mdx | 25 +++++++++++----- .../ci-providers/github-actions.mdx | 25 +++++++++++----- .../get-started/ci-providers/gitlab.mdx | 25 +++++++++++----- .../ci-providers/google-cloud-build.mdx | 29 ++++++++++++------- .../get-started/ci-providers/jenkins.mdx | 25 +++++++++++----- .../get-started/ci-providers/otherci.mdx | 25 +++++++++++----- .../get-started/ci-providers/semaphoreci.mdx | 25 +++++++++++----- .../get-started/ci-providers/travisci.mdx | 25 +++++++++++----- .../get-started/frameworks/android.mdx | 16 +++++----- flaky-tests/get-started/frameworks/bazel.mdx | 16 +++++----- flaky-tests/get-started/frameworks/behave.mdx | 16 +++++----- .../get-started/frameworks/cypress.mdx | 16 +++++----- .../get-started/frameworks/dart-test.mdx | 16 +++++----- .../get-started/frameworks/googletest.mdx | 16 +++++----- .../get-started/frameworks/gotestsum.mdx | 16 +++++----- flaky-tests/get-started/frameworks/gradle.mdx | 16 +++++----- .../get-started/frameworks/jasmine.mdx | 16 +++++----- flaky-tests/get-started/frameworks/jest.mdx | 16 +++++----- flaky-tests/get-started/frameworks/karma.mdx | 16 +++++----- flaky-tests/get-started/frameworks/kotest.mdx | 16 +++++----- flaky-tests/get-started/frameworks/maven.mdx | 16 +++++----- .../get-started/frameworks/minitest.mdx | 16 +++++----- flaky-tests/get-started/frameworks/mocha.mdx | 16 +++++----- .../get-started/frameworks/nightwatch.mdx | 16 +++++----- flaky-tests/get-started/frameworks/nunit.mdx | 16 +++++----- flaky-tests/get-started/frameworks/pest.mdx | 16 +++++----- .../get-started/frameworks/phpunit.mdx | 16 +++++----- .../get-started/frameworks/playwright.mdx | 16 +++++----- flaky-tests/get-started/frameworks/pytest.mdx | 16 +++++----- .../frameworks/robot-framework.mdx | 16 +++++----- .../get-started/frameworks/rspec/index.mdx | 12 ++++---- .../frameworks/rspec/manual-uploads.mdx | 16 +++++----- flaky-tests/get-started/frameworks/rust.mdx | 16 +++++----- .../get-started/frameworks/swift-testing.mdx | 16 +++++----- .../get-started/frameworks/testplan.mdx | 16 +++++----- flaky-tests/get-started/frameworks/vitest.mdx | 16 +++++----- flaky-tests/get-started/frameworks/xctest.mdx | 16 +++++----- 42 files changed, 454 insertions(+), 335 deletions(-) diff --git a/flaky-tests/get-started/ci-providers/atlassian-bamboo.mdx b/flaky-tests/get-started/ci-providers/atlassian-bamboo.mdx index 5d74c05..8553119 100644 --- a/flaky-tests/get-started/ci-providers/atlassian-bamboo.mdx +++ b/flaky-tests/get-started/ci-providers/atlassian-bamboo.mdx @@ -12,16 +12,16 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing a Trunk-compatible output for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as a variable in CI -* [ ] Configure your CI to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as a variable in CI} /> + Configure your CI to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -187,6 +187,15 @@ See the [uploader.md](../../reference/cli-reference.md "mention") for all availa 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. +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/ci-providers/azure-devops-pipelines.mdx b/flaky-tests/get-started/ci-providers/azure-devops-pipelines.mdx index 367c39f..45c57b4 100644 --- a/flaky-tests/get-started/ci-providers/azure-devops-pipelines.mdx +++ b/flaky-tests/get-started/ci-providers/azure-devops-pipelines.mdx @@ -11,16 +11,16 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing a Trunk-compatible output for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as a variable in CI -* [ ] Configure your CI to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as a variable in CI} /> + Configure your CI to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -145,6 +145,15 @@ 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) +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/ci-providers/bitbucket-pipelines.mdx b/flaky-tests/get-started/ci-providers/bitbucket-pipelines.mdx index e8b3a5c..f472307 100644 --- a/flaky-tests/get-started/ci-providers/bitbucket-pipelines.mdx +++ b/flaky-tests/get-started/ci-providers/bitbucket-pipelines.mdx @@ -11,16 +11,16 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing a Trunk-compatible output for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as a variable in CI -* [ ] Configure your CI to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as a variable in CI} /> + Configure your CI to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -147,6 +147,15 @@ 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/). +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/ci-providers/buildkite.mdx b/flaky-tests/get-started/ci-providers/buildkite.mdx index c38b722..9a6359c 100644 --- a/flaky-tests/get-started/ci-providers/buildkite.mdx +++ b/flaky-tests/get-started/ci-providers/buildkite.mdx @@ -12,16 +12,16 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing a Trunk-compatible output for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as a variable in CI -* [ ] Configure your CI to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as a variable in CI} /> + Configure your CI to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -119,6 +119,15 @@ See the [uploader.md](../../reference/cli-reference.md "mention") for all availa 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. +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/ci-providers/circleci.mdx b/flaky-tests/get-started/ci-providers/circleci.mdx index 9b53730..1442f41 100644 --- a/flaky-tests/get-started/ci-providers/circleci.mdx +++ b/flaky-tests/get-started/ci-providers/circleci.mdx @@ -12,16 +12,16 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing a Trunk-compatible output for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as a variable in CI -* [ ] Configure your CI to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as a variable in CI} /> + Configure your CI to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -132,6 +132,15 @@ See the [Uploader CLI Reference](../../reference/cli-reference) for all availabl 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. +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/ci-providers/droneci.mdx b/flaky-tests/get-started/ci-providers/droneci.mdx index 3cdfbee..79ce0d6 100644 --- a/flaky-tests/get-started/ci-providers/droneci.mdx +++ b/flaky-tests/get-started/ci-providers/droneci.mdx @@ -12,16 +12,16 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing a Trunk-compatible output for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as a variable in CI -* [ ] Configure your CI to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as a variable in CI} /> + Configure your CI to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -143,6 +143,15 @@ See the [uploader.md](../../reference/cli-reference.md "mention") for all availa 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. +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/ci-providers/github-actions.mdx b/flaky-tests/get-started/ci-providers/github-actions.mdx index 31abbe8..9eb64b3 100644 --- a/flaky-tests/get-started/ci-providers/github-actions.mdx +++ b/flaky-tests/get-started/ci-providers/github-actions.mdx @@ -6,16 +6,16 @@ Trunk Flaky Tests integrates with your CI by adding a step in your GitHub Action Before you start these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing Trunk-compatible reports for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as secrets in GitHub Actions -* [ ] Configure GitHub Actions to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as secrets in GitHub Actions} /> + Configure GitHub Actions to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -224,6 +224,15 @@ You can also wrap the test command with the Trunk Analytics CLI. When wrapping t 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. +### Validate Your Uploads + +Once your workflow has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check the action logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the repo running the workflow. + ### Getting Direct Links to Job Logs diff --git a/flaky-tests/get-started/ci-providers/gitlab.mdx b/flaky-tests/get-started/ci-providers/gitlab.mdx index 241d038..8da6f00 100644 --- a/flaky-tests/get-started/ci-providers/gitlab.mdx +++ b/flaky-tests/get-started/ci-providers/gitlab.mdx @@ -12,16 +12,16 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing a Trunk-compatible output for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as a variable in CI -* [ ] Configure your CI to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as a variable in CI} /> + Configure your CI to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -135,6 +135,15 @@ See the [uploader.md](../../reference/cli-reference.md "mention") for all availa 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. +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/ci-providers/google-cloud-build.mdx b/flaky-tests/get-started/ci-providers/google-cloud-build.mdx index e31475d..fe7ee38 100644 --- a/flaky-tests/get-started/ci-providers/google-cloud-build.mdx +++ b/flaky-tests/get-started/ci-providers/google-cloud-build.mdx @@ -12,18 +12,18 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing a Trunk-compatible output for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Store your token in GCP Secret Manager -* [ ] Connect your GitHub repos to Cloud Build -* [ ] Create Cloud Build triggers for PR and push events -* [ ] Configure your `cloudbuild.yaml` to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Store your token in GCP Secret Manager} /> + Connect your GitHub repos to Cloud Build} /> + Create Cloud Build triggers for PR and push events} /> + Configure your cloudbuild.yaml to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -203,6 +203,15 @@ See the [Trunk Analytics CLI](../../reference/cli-reference.md "mention") for al 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. +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/ci-providers/jenkins.mdx b/flaky-tests/get-started/ci-providers/jenkins.mdx index 1f94dfc..8414140 100644 --- a/flaky-tests/get-started/ci-providers/jenkins.mdx +++ b/flaky-tests/get-started/ci-providers/jenkins.mdx @@ -12,16 +12,16 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing a Trunk-compatible output for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as a variable in CI -* [ ] Configure your CI to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as a variable in CI} /> + Configure your CI to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -132,6 +132,15 @@ See the [uploader.md](../../reference/cli-reference.md "mention") for all availa 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. +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/ci-providers/otherci.mdx b/flaky-tests/get-started/ci-providers/otherci.mdx index 556c8c9..e132206 100644 --- a/flaky-tests/get-started/ci-providers/otherci.mdx +++ b/flaky-tests/get-started/ci-providers/otherci.mdx @@ -12,16 +12,16 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing JUnit XML output for your test runner, supported by virtually all test frameworks, which is what Trunk ingests. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as a variable in CI -* [ ] Configure your CI to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as a variable in CI} /> + Configure your CI to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -142,6 +142,15 @@ The `JOB_URL` variable controls where the "Logs" link in Trunk Flaky Tests point 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. +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/ci-providers/semaphoreci.mdx b/flaky-tests/get-started/ci-providers/semaphoreci.mdx index 6f34f90..830d0d7 100644 --- a/flaky-tests/get-started/ci-providers/semaphoreci.mdx +++ b/flaky-tests/get-started/ci-providers/semaphoreci.mdx @@ -12,16 +12,16 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing a Trunk-compatible output for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as a variable in CI -* [ ] Configure your CI to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as a variable in CI} /> + Configure your CI to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -183,6 +183,15 @@ See the [uploader.md](../../reference/cli-reference.md "mention") for all availa 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. +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/ci-providers/travisci.mdx b/flaky-tests/get-started/ci-providers/travisci.mdx index e189661..9cb6c34 100644 --- a/flaky-tests/get-started/ci-providers/travisci.mdx +++ b/flaky-tests/get-started/ci-providers/travisci.mdx @@ -12,16 +12,16 @@ Flaky Test support for source control providers like GitLab and BitBucket is sti Before you start on these steps, see the [Test Frameworks](../frameworks/) docs for instructions on producing a Trunk-compatible output for your test framework. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following. +Work through the steps below in order. Once you've finished the last one, you're set up — head to [app.trunk.io](https://app.trunk.io) to see your results. -* [ ] Get your Trunk organization slug and token -* [ ] Set your slug and token as a variable in CI -* [ ] Configure your CI to upload to Trunk -* [ ] Validate your uploads in Trunk - -After completing these checklist items, you'll be integrated with Trunk. + + Get your Trunk organization slug and token} /> + Set your slug and token as a variable in CI} /> + Configure your CI to upload to Trunk} /> + Validate your uploads in Trunk} /> + ### Trunk Organization Slug and Token @@ -110,6 +110,15 @@ See the [uploader.md](../../reference/cli-reference.md "mention") for all availa 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. +### Validate Your Uploads + +Once your pipeline has run on a stable branch, head to [app.trunk.io](https://app.trunk.io) and confirm Trunk received your results. + +- The **Uploads** tab lists every report Trunk has ingested, with status and any warnings (missing file paths, malformed XML, and so on). +- The **Tests** tab shows individual test cases once an upload has been processed. + +If a recent run isn't showing up, check your CI logs for upload errors and confirm your `TRUNK_TOKEN` and `TRUNK_ORG_SLUG` secrets are set on the project running the pipeline. + **Have questions?** diff --git a/flaky-tests/get-started/frameworks/android.mdx b/flaky-tests/get-started/frameworks/android.mdx index e079e49..028ce48 100644 --- a/flaky-tests/get-started/frameworks/android.mdx +++ b/flaky-tests/get-started/frameworks/android.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Android p --- You can automatically [detect and manage flaky tests](../../detection/) in your Android projects by integrating with Trunk. This document explains how to configure Android to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./android#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating reports diff --git a/flaky-tests/get-started/frameworks/bazel.mdx b/flaky-tests/get-started/frameworks/bazel.mdx index a4395e9..c05cad4 100644 --- a/flaky-tests/get-started/frameworks/bazel.mdx +++ b/flaky-tests/get-started/frameworks/bazel.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports with Bazel" --- You can automatically [detect and manage flaky tests](../../detection/) in your Bazel projects by integrating with Trunk. This document explains how to configure Bazel to output compatible reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./bazel#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/behave.mdx b/flaky-tests/get-started/frameworks/behave.mdx index aa33631..3da9ffc 100644 --- a/flaky-tests/get-started/frameworks/behave.mdx +++ b/flaky-tests/get-started/frameworks/behave.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Behave" --- You can automatically [detect and manage flaky tests](../../detection/) in your projects running Behave by integrating with Trunk. This document explains how to configure Behave to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./behave#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/cypress.mdx b/flaky-tests/get-started/frameworks/cypress.mdx index 57d4cd3..7337721 100644 --- a/flaky-tests/get-started/frameworks/cypress.mdx +++ b/flaky-tests/get-started/frameworks/cypress.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Cypress t --- You can automatically [detect and manage flaky tests](../../detection/) in your Cypress projects by integrating with Trunk. This document explains how to configure Cypress to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./cypress#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/dart-test.mdx b/flaky-tests/get-started/frameworks/dart-test.mdx index a2dd40c..79293c4 100644 --- a/flaky-tests/get-started/frameworks/dart-test.mdx +++ b/flaky-tests/get-started/frameworks/dart-test.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Dart test --- You can automatically [detect and manage flaky tests](../../detection/) in your Dart projects by integrating with Trunk. This document explains how to configure Dart to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./dart-test#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/googletest.mdx b/flaky-tests/get-started/frameworks/googletest.mdx index 111c478..0d53597 100644 --- a/flaky-tests/get-started/frameworks/googletest.mdx +++ b/flaky-tests/get-started/frameworks/googletest.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for GoogleTes --- You can automatically [detect and manage flaky tests](../../detection/) in your GoogleTest projects by integrating with Trunk. This document explains how to configure GoogleTest to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./googletest#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/gotestsum.mdx b/flaky-tests/get-started/frameworks/gotestsum.mdx index 047a0f5..5b00615 100644 --- a/flaky-tests/get-started/frameworks/gotestsum.mdx +++ b/flaky-tests/get-started/frameworks/gotestsum.mdx @@ -8,16 +8,16 @@ You can automatically [detect and manage flaky tests](../../detection/) in your The standard Go test runner, `go test`, is excellent for executing tests and providing immediate feedback to developers. However, it does not natively produce test reports in the JUnit XML format that Trunk Flaky Tests requires for ingestion and analysis. Therefore, an additional tool is needed to convert the output of `go test` into this compatible format. This intermediate step allows Trunk to accurately process your test results and identify flaky tests. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./gotestsum#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report (JUnit XML). -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report (JUnit XML)} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating JUnit XML Reports from Go Tests diff --git a/flaky-tests/get-started/frameworks/gradle.mdx b/flaky-tests/get-started/frameworks/gradle.mdx index 80e4ad4..f5367dd 100644 --- a/flaky-tests/get-started/frameworks/gradle.mdx +++ b/flaky-tests/get-started/frameworks/gradle.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Gradle" --- You can automatically [detect and manage flaky tests](../../detection/) in your Gradle projects by integrating with Trunk. This document explains how to configure Gradle to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./gradle#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/jasmine.mdx b/flaky-tests/get-started/frameworks/jasmine.mdx index ee5a658..b598dce 100644 --- a/flaky-tests/get-started/frameworks/jasmine.mdx +++ b/flaky-tests/get-started/frameworks/jasmine.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Jasmine t --- You can automatically [detect and manage flaky tests](../../detection/) in your Jasmine projects by integrating with Trunk. This document explains how to configure Jasmine to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./jasmine#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/jest.mdx b/flaky-tests/get-started/frameworks/jest.mdx index 82b1adc..986feed 100644 --- a/flaky-tests/get-started/frameworks/jest.mdx +++ b/flaky-tests/get-started/frameworks/jest.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Jest test --- You can automatically [detect and manage flaky tests](../../detection/) in your Jest projects by integrating with Trunk. This document explains how to configure Jest to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./jest#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/karma.mdx b/flaky-tests/get-started/frameworks/karma.mdx index f5d5e38..67a1e0c 100644 --- a/flaky-tests/get-started/frameworks/karma.mdx +++ b/flaky-tests/get-started/frameworks/karma.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Karma tes --- You can automatically [detect and manage flaky tests](../../detection/) in your Karma projects by integrating with Trunk. This document explains how to configure Karma to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./karma#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/kotest.mdx b/flaky-tests/get-started/frameworks/kotest.mdx index 3885b6e..1f27aaf 100644 --- a/flaky-tests/get-started/frameworks/kotest.mdx +++ b/flaky-tests/get-started/frameworks/kotest.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Kotest" --- You can automatically [detect and manage flaky tests](../../detection/) in your Kotest projects by integrating with Trunk. This document explains how to configure Kotest to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./kotest#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/maven.mdx b/flaky-tests/get-started/frameworks/maven.mdx index ae34467..b3994ed 100644 --- a/flaky-tests/get-started/frameworks/maven.mdx +++ b/flaky-tests/get-started/frameworks/maven.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Maven" --- You can automatically [detect and manage flaky tests](../../detection/) in your Maven projects by integrating with Trunk. This document explains how to configure Maven to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./maven#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/minitest.mdx b/flaky-tests/get-started/frameworks/minitest.mdx index 805222c..c1c5416 100644 --- a/flaky-tests/get-started/frameworks/minitest.mdx +++ b/flaky-tests/get-started/frameworks/minitest.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for minitest" --- You can automatically [detect and manage flaky tests](../../detection/) in your minitest projects by integrating with Trunk. This document explains how to configure minitest to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./minitest#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/mocha.mdx b/flaky-tests/get-started/frameworks/mocha.mdx index c9224b2..2b57348 100644 --- a/flaky-tests/get-started/frameworks/mocha.mdx +++ b/flaky-tests/get-started/frameworks/mocha.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Mocha" --- You can automatically [detect and manage flaky tests](../../detection/) in your Mocha projects by integrating with Trunk. This document explains how to configure Mocha to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./mocha#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/nightwatch.mdx b/flaky-tests/get-started/frameworks/nightwatch.mdx index 7991e1c..4ddbc8f 100644 --- a/flaky-tests/get-started/frameworks/nightwatch.mdx +++ b/flaky-tests/get-started/frameworks/nightwatch.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Nightwatc --- You can automatically [detect and manage flaky tests](../../detection/) in your Nightwatch projects by integrating with Trunk. This document explains how to configure Nightwatch to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./nightwatch#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/nunit.mdx b/flaky-tests/get-started/frameworks/nunit.mdx index ca16d44..0bdab84 100644 --- a/flaky-tests/get-started/frameworks/nunit.mdx +++ b/flaky-tests/get-started/frameworks/nunit.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for NUnit" --- You can automatically [detect and manage flaky tests](../../detection/) in your NUnit projects by integrating with Trunk. This document explains how to configure NUnit to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./nunit#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/pest.mdx b/flaky-tests/get-started/frameworks/pest.mdx index 3bbfc29..977ba3b 100644 --- a/flaky-tests/get-started/frameworks/pest.mdx +++ b/flaky-tests/get-started/frameworks/pest.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Pest" --- You can automatically [detect and manage flaky tests](../../detection/) in your PHP projects by integrating with Trunk. This document explains how to configure Pest to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./pest#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/phpunit.mdx b/flaky-tests/get-started/frameworks/phpunit.mdx index 692b5ff..4f984c2 100644 --- a/flaky-tests/get-started/frameworks/phpunit.mdx +++ b/flaky-tests/get-started/frameworks/phpunit.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for PHPUnit" --- You can automatically [detect and manage flaky tests](../../detection/) in your PHP projects by integrating with Trunk. This document explains how to configure PHPUnit to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./phpunit#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/playwright.mdx b/flaky-tests/get-started/frameworks/playwright.mdx index 132d195..032a362 100644 --- a/flaky-tests/get-started/frameworks/playwright.mdx +++ b/flaky-tests/get-started/frameworks/playwright.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Playwrigh --- You can automatically [detect and manage flaky tests](../../detection/) in your Playwright projects by integrating with Trunk. This document explains how to configure Playwright to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./playwright#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/pytest.mdx b/flaky-tests/get-started/frameworks/pytest.mdx index 0d132cf..7df0862 100644 --- a/flaky-tests/get-started/frameworks/pytest.mdx +++ b/flaky-tests/get-started/frameworks/pytest.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Pytest" --- You can automatically [detect and manage flaky tests](../../detection/) in your Pytest projects by integrating with Trunk. This document explains how to configure Pytest to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./pytest#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/robot-framework.mdx b/flaky-tests/get-started/frameworks/robot-framework.mdx index 287057e..45ec198 100644 --- a/flaky-tests/get-started/frameworks/robot-framework.mdx +++ b/flaky-tests/get-started/frameworks/robot-framework.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Robot Fra --- You can automatically [detect and manage flaky tests](../../detection/) in your projects running tests with Robot by integrating with Trunk. This document explains how to configure Robot to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./robot-framework#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/rspec/index.mdx b/flaky-tests/get-started/frameworks/rspec/index.mdx index 6631c3f..0a51557 100644 --- a/flaky-tests/get-started/frameworks/rspec/index.mdx +++ b/flaky-tests/get-started/frameworks/rspec/index.mdx @@ -4,13 +4,15 @@ description: "A guide for generating Trunk-compatible test reports for RSpec usi --- You can automatically [detect and manage flaky tests](../../../detection/) in your projects running RSpec by integrating with Trunk. This document explains how to use Trunk's RSpec plugin to upload test results to Trunk. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../../ci-providers/). -- [ ] Set up and installed Trunk's RSpec plugin -- [ ] Disable retries for better detection accuracy -- [ ] Test uploads locally + + Set up and install Trunk's RSpec plugin} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + Using the plugin is the best way to accurately detect flaky RSpec tests. diff --git a/flaky-tests/get-started/frameworks/rspec/manual-uploads.mdx b/flaky-tests/get-started/frameworks/rspec/manual-uploads.mdx index c66e658..53f8dfc 100644 --- a/flaky-tests/get-started/frameworks/rspec/manual-uploads.mdx +++ b/flaky-tests/get-started/frameworks/rspec/manual-uploads.mdx @@ -8,16 +8,16 @@ You can automatically [detect and manage flaky tests](../../../detection/) in yo We highly recommend using [Trunk's RSpec plugin](./) to upload test results for the best accuracy when detecting flaky tests. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./manual-uploads#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/rust.mdx b/flaky-tests/get-started/frameworks/rust.mdx index e971865..aecd41f 100644 --- a/flaky-tests/get-started/frameworks/rust.mdx +++ b/flaky-tests/get-started/frameworks/rust.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Rust" --- You can automatically [detect and manage flaky tests](../../detection/) in your Rust projects by integrating with Trunk. This document explains how to configure cargo-nextest to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./rust#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/swift-testing.mdx b/flaky-tests/get-started/frameworks/swift-testing.mdx index 117ad0a..33fa13d 100644 --- a/flaky-tests/get-started/frameworks/swift-testing.mdx +++ b/flaky-tests/get-started/frameworks/swift-testing.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports with Swift Te --- You can automatically [detect and manage flaky tests](../../detection/) in your Swift projects by integrating with Trunk. This document explains how to configure Swift Testing to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./swift-testing#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/testplan.mdx b/flaky-tests/get-started/frameworks/testplan.mdx index 9d0a72e..3275870 100644 --- a/flaky-tests/get-started/frameworks/testplan.mdx +++ b/flaky-tests/get-started/frameworks/testplan.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for Testplan" --- You can automatically [detect and manage flaky tests](../../detection/) in your projects running Testplan by integrating with Trunk. This document explains how to configure Testplan to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./testplan#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating reports diff --git a/flaky-tests/get-started/frameworks/vitest.mdx b/flaky-tests/get-started/frameworks/vitest.mdx index 0bfad7a..93d989d 100644 --- a/flaky-tests/get-started/frameworks/vitest.mdx +++ b/flaky-tests/get-started/frameworks/vitest.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports with Vitest" --- You can automatically [detect and manage flaky tests](../../detection/) in your Vitest projects by integrating with Trunk. This document explains how to configure Vitest to output JUnit XML reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./vitest#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports diff --git a/flaky-tests/get-started/frameworks/xctest.mdx b/flaky-tests/get-started/frameworks/xctest.mdx index da5ef27..42ea7c0 100644 --- a/flaky-tests/get-started/frameworks/xctest.mdx +++ b/flaky-tests/get-started/frameworks/xctest.mdx @@ -4,16 +4,16 @@ description: "A guide for generating Trunk-compatible test reports for XCode and --- You can automatically [detect and manage flaky tests](../../detection/) in your XCTest projects by integrating with Trunk. This document explains how to configure XCTest to output XCResult reports that can be uploaded to Trunk for analysis. -### Checklist +### Setup steps -By the end of this guide, you should achieve the following before proceeding to the [next steps](./xctest#next-step) to configure your CI provider. +Work through the steps below in order. Once you've finished the last one, you'll be ready to move on to [configure uploads in CI](../ci-providers/). -* [ ] Generate a compatible test report -* [ ] Configure the report file path or glob -* [ ] Disable retries for better detection accuracy -* [ ] Test uploads locally - -After correctly generating reports following the above steps, you'll be ready to move on to the next steps to [configure uploads in CI](../ci-providers/). + + Generate a compatible test report} /> + Configure the report file path or glob} /> + Disable retries for better detection accuracy} /> + Test uploads locally} /> + ### Generating Reports