From 5e89044284229b0390a4403c7a34357cc8b2a1c3 Mon Sep 17 00:00:00 2001 From: Frank Lagendijk Date: Wed, 9 Sep 2026 15:44:55 +0200 Subject: [PATCH] fix(test-insights): link the four framework pages that only mentioned the dashboard MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit pytest, playwright, rspec and vitest each ended a reader's setup with an unlinked sentence — "Check the Test Insights dashboard afterward to view execution metrics, detect flaky tests, and review test trends" — buried in the middle of the CI workflow section. The other eleven framework pages close with a "Verify and Review in Test Insights" section carrying the actual dashboard link. These four are the section's second page shape: they use a reporter, plugin or gem that uploads directly with MERGIFY_TOKEN rather than generating a JUnit report for the Mergify CI action to upload. That is why the shared partial never reached them, and it is the same four pages missing a Troubleshooting section. Each now closes with the shared `_review-in-test-insights.mdx` partial under the same heading the other eleven use, preceded by a line naming what just happened so the partial's "You can then review..." has an antecedent. The shared troubleshooting partial is deliberately not added here. It is written for the JUnit path — it talks about `report_path`, the CLI upload step and workflow `if` conditions — and none of these four pages reference any of that. Closing that gap needs framework-specific content rather than a shared block. Also normalises `:::tip` bodies in pytest and rspec to the 2-space indent the rest of the docs use, and rewraps them to the surrounding column. Co-Authored-By: Claude Opus 5 Change-Id: I7df67cc209a1cded4473b4667caf1653c7a8f73e Claude-Session-Id: 18413631-aa75-4182-9e79-4c1ce31bb683 --- .../test-frameworks/playwright.mdx | 11 ++++++++--- .../test-insights/test-frameworks/pytest.mdx | 15 ++++++++++----- .../test-insights/test-frameworks/rspec.mdx | 17 +++++++++++------ .../test-insights/test-frameworks/vitest.mdx | 9 +++++++-- 4 files changed, 36 insertions(+), 16 deletions(-) diff --git a/src/content/docs/test-insights/test-frameworks/playwright.mdx b/src/content/docs/test-insights/test-frameworks/playwright.mdx index 5768583186..4876817223 100644 --- a/src/content/docs/test-insights/test-frameworks/playwright.mdx +++ b/src/content/docs/test-insights/test-frameworks/playwright.mdx @@ -7,6 +7,7 @@ import playwrightLogo from "../../../images/ci-insights/playwright/logo.svg" import IntegrationLogo from "../../../../components/IntegrationLogo.astro" import CIInsightsSetupNote from "../../../../components/CIInsightsSetupNote.astro" import BuildkiteTokenNote from "../../../../components/BuildkiteTokenNote.astro" +import ReviewInTestInsights from "./_review-in-test-insights.mdx" @@ -126,9 +127,6 @@ steps: The reporter automatically collects your test results and sends them to Test Insights. -Check the Test Insights dashboard afterward to view execution metrics, detect -flaky tests, and review test trends. - ## Multi-Project (Cross-Browser) Runs If your `playwright.config.ts` defines multiple @@ -154,6 +152,13 @@ env: This option is opt-in (off by default) to preserve the history of tests that already report without a project prefix. +## Verify and Review in Test Insights + +After pushing these changes, your next CI run reports its Playwright results +automatically. + + + ## Environment Variables | Variable | Purpose | Default | diff --git a/src/content/docs/test-insights/test-frameworks/pytest.mdx b/src/content/docs/test-insights/test-frameworks/pytest.mdx index dc6bbcdb76..6e6ba8cf87 100644 --- a/src/content/docs/test-insights/test-frameworks/pytest.mdx +++ b/src/content/docs/test-insights/test-frameworks/pytest.mdx @@ -7,6 +7,7 @@ import pytestLogo from "../../../images/ci-insights/pytest/logo.svg" import IntegrationLogo from "../../../../components/IntegrationLogo.astro" import CIInsightsSetupNote from "../../../../components/CIInsightsSetupNote.astro" import BuildkiteTokenNote from "../../../../components/BuildkiteTokenNote.astro" +import ReviewInTestInsights from "./_review-in-test-insights.mdx" @@ -104,9 +105,6 @@ steps: The plugin collects your test results and sends them to Test Insights. -Check the Test Insights dashboard afterward to view execution metrics, detect -flaky tests, and review test trends. - ## Using with Tox If you’re using [Tox](https://tox.wiki/) to manage test environments, you can @@ -176,6 +174,13 @@ steps: ``` :::tip -Use `MERGIFY_TEST_JOB_NAME` to make reports clearer in Test Insights, especially when -running multiple Tox environments or using a matrix. + Use `MERGIFY_TEST_JOB_NAME` to make reports clearer in Test Insights, + especially when running multiple Tox environments or using a matrix. ::: + +## Verify and Review in Test Insights + +After pushing these changes, your next CI run reports its pytest results +automatically. + + diff --git a/src/content/docs/test-insights/test-frameworks/rspec.mdx b/src/content/docs/test-insights/test-frameworks/rspec.mdx index 7d422caba7..00bf87be97 100644 --- a/src/content/docs/test-insights/test-frameworks/rspec.mdx +++ b/src/content/docs/test-insights/test-frameworks/rspec.mdx @@ -7,6 +7,7 @@ import rspecLogo from "../../../images/ci-insights/rspec/logo.svg" import IntegrationLogo from "../../../../components/IntegrationLogo.astro" import CIInsightsSetupNote from "../../../../components/CIInsightsSetupNote.astro" import BuildkiteTokenNote from "../../../../components/BuildkiteTokenNote.astro" +import ReviewInTestInsights from "./_review-in-test-insights.mdx" @@ -84,8 +85,12 @@ steps: The gem automatically collects your test results and sends them to Test Insights. -Check the Test Insights dashboard afterward to view execution metrics, detect -flaky tests, and review test trends. +## Verify and Review in Test Insights + +After pushing these changes, your next CI run reports its RSpec results +automatically. + + ## Environment Variables @@ -99,11 +104,11 @@ flaky tests, and review test trends. | `MERGIFY_TEST_JOB_NAME` | Test job name identifier | Optional | :::tip -The gem auto-activates in CI environments (detected via the `CI` environment -variable). To enable it outside CI, set `RSPEC_MERGIFY_ENABLE=true`. + The gem auto-activates in CI environments (detected via the `CI` environment + variable). To enable it outside CI, set `RSPEC_MERGIFY_ENABLE=true`. ::: :::tip -Use `MERGIFY_TEST_JOB_NAME` to make reports clearer in Test Insights, especially -when running multiple test suites or using a matrix strategy. + Use `MERGIFY_TEST_JOB_NAME` to make reports clearer in Test Insights, + especially when running multiple test suites or using a matrix strategy. ::: diff --git a/src/content/docs/test-insights/test-frameworks/vitest.mdx b/src/content/docs/test-insights/test-frameworks/vitest.mdx index 2af4eef169..2fec50a076 100644 --- a/src/content/docs/test-insights/test-frameworks/vitest.mdx +++ b/src/content/docs/test-insights/test-frameworks/vitest.mdx @@ -7,6 +7,7 @@ import vitestLogo from "../../../images/ci-insights/vitest/logo.svg" import IntegrationLogo from "../../../../components/IntegrationLogo.astro" import CIInsightsSetupNote from "../../../../components/CIInsightsSetupNote.astro" import BuildkiteTokenNote from "../../../../components/BuildkiteTokenNote.astro" +import ReviewInTestInsights from "./_review-in-test-insights.mdx" @@ -97,8 +98,12 @@ steps: The reporter automatically collects your test results and sends them to Test Insights. -Check the Test Insights dashboard afterward to view execution metrics, detect -flaky tests, and review test trends. +## Verify and Review in Test Insights + +After pushing these changes, your next CI run reports its Vitest results +automatically. + + ## Environment Variables