From a1e54aec6c7aa3d5eeee65e57cc3236ea6a7cec0 Mon Sep 17 00:00:00 2001 From: Julien Danjou Date: Wed, 20 May 2026 14:56:54 +0200 Subject: [PATCH 1/2] docs: move test framework configuration and quarantine to Test Insights Test framework plugins emit test-level data that powers Test Insights (prevention, detection, mitigation), so the per-framework setup pages and the Quarantine reference now live under /test-insights/ alongside the features they enable. CI Insights keeps a pointer paragraph to the new location and the old URLs redirect via public/_redirects. Change-Id: I28c101d6adb746991c85c4a60125dcd0127cb2c7 --- public/_redirects | 3 + src/content/docs/ci-insights.mdx | 116 +---------------- .../docs/ci-insights/setup/buildkite.mdx | 4 +- src/content/docs/test-insights.mdx | 122 +++++++++++++++++- src/content/docs/test-insights/mitigation.mdx | 6 +- src/content/docs/test-insights/prevention.mdx | 2 +- .../quarantine.mdx | 2 +- ..._buildkite_mergify_ci_quarantine_setup.mdx | 0 .../_common-troubleshooting-tips.mdx | 0 .../_gha_mergify_ci_quarantine_setup.mdx | 0 .../test-frameworks/cypress.mdx | 4 +- .../test-frameworks/golang.mdx | 4 +- .../test-frameworks/jest.mdx | 4 +- .../test-frameworks/junit.mdx | 4 +- .../test-frameworks/minitest.mdx | 4 +- .../test-frameworks/mstest.mdx | 4 +- .../test-frameworks/nunit.mdx | 4 +- .../test-frameworks/pest.mdx | 4 +- .../test-frameworks/phpunit.mdx | 4 +- .../test-frameworks/playwright.mdx | 4 +- .../test-frameworks/pytest.mdx | 4 +- .../test-frameworks/rspec.mdx | 4 +- .../test-frameworks/rust.mdx | 4 +- .../test-frameworks/testng.mdx | 4 +- .../test-frameworks/vitest.mdx | 4 +- src/content/navItems.tsx | 60 +++++---- 26 files changed, 197 insertions(+), 178 deletions(-) rename src/content/docs/{ci-insights => test-insights}/quarantine.mdx (95%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/_buildkite_mergify_ci_quarantine_setup.mdx (100%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/_common-troubleshooting-tips.mdx (100%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/_gha_mergify_ci_quarantine_setup.mdx (100%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/cypress.mdx (96%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/golang.mdx (96%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/jest.mdx (96%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/junit.mdx (97%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/minitest.mdx (97%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/mstest.mdx (96%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/nunit.mdx (97%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/pest.mdx (97%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/phpunit.mdx (96%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/playwright.mdx (96%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/pytest.mdx (97%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/rspec.mdx (96%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/rust.mdx (97%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/testng.mdx (97%) rename src/content/docs/{ci-insights => test-insights}/test-frameworks/vitest.mdx (96%) diff --git a/public/_redirects b/public/_redirects index 93d9aa8a85..0353baa38c 100644 --- a/public/_redirects +++ b/public/_redirects @@ -71,4 +71,7 @@ /integrations/teamcity/ /integrations/ci-status-checks 301 /integrations/gitlab /integrations/ci-status-checks 301 /integrations/gitlab/ /integrations/ci-status-checks 301 +/ci-insights/test-frameworks/* /test-insights/test-frameworks/:splat 301 +/ci-insights/quarantine /test-insights/quarantine 301 +/ci-insights/quarantine/ /test-insights/quarantine 301 diff --git a/src/content/docs/ci-insights.mdx b/src/content/docs/ci-insights.mdx index ffc90663d2..d74639ac08 100644 --- a/src/content/docs/ci-insights.mdx +++ b/src/content/docs/ci-insights.mdx @@ -86,115 +86,7 @@ Select your CI system below to enable CI Insights and configure flaky test detec ## Test Framework Configuration -CI Insights supports many test frameworks and captures test-level data from them. -Each framework requires a quick setup to ensure test results are parsed and uploaded properly. - -Refer to the dedicated page for your specific framework to configure and verify your test output. - - - - Integrate Cypress with CI Insights. - - - Integrate Go with CI Insights. - - - Integrate Jest with CI Insights. - - - Integrate JUnit with CI Insights. - - - Integrate Minitest with CI Insights. - - - Integrate MSTest with CI Insights. - - - Integrate NUnit with CI Insights. - - - Integrate Pest with CI Insights. - - - Integrate PHPUnit with CI Insights. - - - Integrate Playwright with CI Insights. - - - Integrate Pytest with CI Insights. - - - Integrate RSpec with CI Insights. - - - Integrate Rust with CI Insights. - - - Integrate TestNG with CI Insights. - - - Integrate Vitest with CI Insights. - - +To capture test-level data from your CI pipeline, configure your test +framework to upload results to Mergify. See the +[Test Insights test framework guides](/test-insights#test-framework-configuration) +for framework-specific setup instructions. diff --git a/src/content/docs/ci-insights/setup/buildkite.mdx b/src/content/docs/ci-insights/setup/buildkite.mdx index cee715ef6c..005f0b4cb5 100644 --- a/src/content/docs/ci-insights/setup/buildkite.mdx +++ b/src/content/docs/ci-insights/setup/buildkite.mdx @@ -150,6 +150,6 @@ every 12 hours on weekdays. ## Test Framework Configuration -See the [test framework guides](/ci-insights#test-framework-configuration) for +See the [test framework guides](/test-insights#test-framework-configuration) for framework-specific instructions on generating JUnit XML reports and uploading -them to CI Insights with both GitHub Actions and Buildkite. +them with both GitHub Actions and Buildkite. diff --git a/src/content/docs/test-insights.mdx b/src/content/docs/test-insights.mdx index f42e394f29..31b3f771c2 100644 --- a/src/content/docs/test-insights.mdx +++ b/src/content/docs/test-insights.mdx @@ -4,6 +4,9 @@ description: Monitor, detect, and manage unreliable tests across your repositori hubAccent: true --- +import Docset from '../../components/DocsetGrid/Docset.astro'; +import DocsetGrid from '../../components/DocsetGrid/DocsetGrid.astro'; + Test Insights helps you manage test reliability across the full lifecycle. It catches flaky tests on pull requests before they merge, surfaces unhealthy tests across your repositories, and lets you quarantine problematic tests so @@ -53,4 +56,121 @@ framework: - [GitHub Actions setup](/ci-insights/setup/github-actions) - [Jenkins setup](/ci-insights/setup/jenkins) -- [Test framework configuration](/ci-insights#test-framework-configuration) +- [Test framework configuration](#test-framework-configuration) + +## Test Framework Configuration + +Test Insights supports many test frameworks and captures test-level data from +them. Each framework requires a quick setup to ensure test results are parsed +and uploaded properly. + +Refer to the dedicated page for your specific framework to configure and +verify your test output. + + + + Integrate Cypress with Test Insights. + + + Integrate Go with Test Insights. + + + Integrate Jest with Test Insights. + + + Integrate JUnit with Test Insights. + + + Integrate Minitest with Test Insights. + + + Integrate MSTest with Test Insights. + + + Integrate NUnit with Test Insights. + + + Integrate Pest with Test Insights. + + + Integrate PHPUnit with Test Insights. + + + Integrate Playwright with Test Insights. + + + Integrate Pytest with Test Insights. + + + Integrate RSpec with Test Insights. + + + Integrate Rust with Test Insights. + + + Integrate TestNG with Test Insights. + + + Integrate Vitest with Test Insights. + + diff --git a/src/content/docs/test-insights/mitigation.mdx b/src/content/docs/test-insights/mitigation.mdx index 6a5ed3da25..6c73b01644 100644 --- a/src/content/docs/test-insights/mitigation.mdx +++ b/src/content/docs/test-insights/mitigation.mdx @@ -28,7 +28,7 @@ Quarantine works on any branch, not just the default branch. :::note Quarantined tests must still be uploaded through one of the supported CI integrations. See the - [test framework configuration](/ci-insights#test-framework-configuration) + [test framework configuration](/test-insights#test-framework-configuration) for setup details. ::: @@ -40,7 +40,7 @@ through [Detection](/test-insights/detection) and want to stop it from blocking your team while you investigate. For technical details on how quarantine integrates with your CI pipeline, -see the [Quarantine documentation](/ci-insights/quarantine). +see the [Quarantine documentation](/test-insights/quarantine). ## Auto-quarantine @@ -77,5 +77,5 @@ overhead and keeps your CI pipeline moving. Mitigation uses the same CI integration as Detection. To ensure quarantine works correctly, your CI must be configured to check quarantine status. See -the [Quarantine documentation](/ci-insights/quarantine) for technical setup +the [Quarantine documentation](/test-insights/quarantine) for technical setup details. diff --git a/src/content/docs/test-insights/prevention.mdx b/src/content/docs/test-insights/prevention.mdx index 2fd5a32491..3aeec24c46 100644 --- a/src/content/docs/test-insights/prevention.mdx +++ b/src/content/docs/test-insights/prevention.mdx @@ -68,6 +68,6 @@ reliability. Prevention requires test framework plugins that instrument test runs to track flakiness on pull requests. -See the [test framework configuration](/ci-insights#test-framework-configuration) +See the [test framework configuration](/test-insights#test-framework-configuration) for setup instructions specific to your framework (pytest-mergify, rspec-mergify, etc.). diff --git a/src/content/docs/ci-insights/quarantine.mdx b/src/content/docs/test-insights/quarantine.mdx similarity index 95% rename from src/content/docs/ci-insights/quarantine.mdx rename to src/content/docs/test-insights/quarantine.mdx index 50bbe33dc4..25d6a941e6 100644 --- a/src/content/docs/ci-insights/quarantine.mdx +++ b/src/content/docs/test-insights/quarantine.mdx @@ -17,7 +17,7 @@ When you quarantine a test in the Mergify dashboard, its future executions will This avoids pipeline disruption while still surfacing issues in the UI and keeping historical data intact. Quarantined tests must still be uploaded appropriately using one of the supported CI integrations. -To ensure the correct setup, refer to [the documentation for your test framework](/ci-insights/#test-framework-configuration). +To ensure the correct setup, refer to [the documentation for your test framework](/test-insights#test-framework-configuration). ## Adding and removing tests from quarantine diff --git a/src/content/docs/ci-insights/test-frameworks/_buildkite_mergify_ci_quarantine_setup.mdx b/src/content/docs/test-insights/test-frameworks/_buildkite_mergify_ci_quarantine_setup.mdx similarity index 100% rename from src/content/docs/ci-insights/test-frameworks/_buildkite_mergify_ci_quarantine_setup.mdx rename to src/content/docs/test-insights/test-frameworks/_buildkite_mergify_ci_quarantine_setup.mdx diff --git a/src/content/docs/ci-insights/test-frameworks/_common-troubleshooting-tips.mdx b/src/content/docs/test-insights/test-frameworks/_common-troubleshooting-tips.mdx similarity index 100% rename from src/content/docs/ci-insights/test-frameworks/_common-troubleshooting-tips.mdx rename to src/content/docs/test-insights/test-frameworks/_common-troubleshooting-tips.mdx diff --git a/src/content/docs/ci-insights/test-frameworks/_gha_mergify_ci_quarantine_setup.mdx b/src/content/docs/test-insights/test-frameworks/_gha_mergify_ci_quarantine_setup.mdx similarity index 100% rename from src/content/docs/ci-insights/test-frameworks/_gha_mergify_ci_quarantine_setup.mdx rename to src/content/docs/test-insights/test-frameworks/_gha_mergify_ci_quarantine_setup.mdx diff --git a/src/content/docs/ci-insights/test-frameworks/cypress.mdx b/src/content/docs/test-insights/test-frameworks/cypress.mdx similarity index 96% rename from src/content/docs/ci-insights/test-frameworks/cypress.mdx rename to src/content/docs/test-insights/test-frameworks/cypress.mdx index 5c558db4c1..eeea479a5a 100644 --- a/src/content/docs/ci-insights/test-frameworks/cypress.mdx +++ b/src/content/docs/test-insights/test-frameworks/cypress.mdx @@ -1,6 +1,6 @@ --- -title: Cypress Integration with CI Insights -description: Report your test results from Cypress to CI Insights +title: Cypress Integration with Mergify +description: Report your test results from Cypress to Mergify --- import cypressLogo from "../../../images/ci-insights/cypress/logo.svg" diff --git a/src/content/docs/ci-insights/test-frameworks/golang.mdx b/src/content/docs/test-insights/test-frameworks/golang.mdx similarity index 96% rename from src/content/docs/ci-insights/test-frameworks/golang.mdx rename to src/content/docs/test-insights/test-frameworks/golang.mdx index 47c3e8ecf7..b1f6cea6eb 100644 --- a/src/content/docs/ci-insights/test-frameworks/golang.mdx +++ b/src/content/docs/test-insights/test-frameworks/golang.mdx @@ -1,6 +1,6 @@ --- -title: Go Integration with CI Insights -description: Report your test results from Go tests to CI Insights +title: Go Integration with Mergify +description: Report your test results from Go tests to Mergify --- import golangLogo from "../../../images/ci-insights/golang/logo.svg" diff --git a/src/content/docs/ci-insights/test-frameworks/jest.mdx b/src/content/docs/test-insights/test-frameworks/jest.mdx similarity index 96% rename from src/content/docs/ci-insights/test-frameworks/jest.mdx rename to src/content/docs/test-insights/test-frameworks/jest.mdx index 93ba239d42..35a2de1502 100644 --- a/src/content/docs/ci-insights/test-frameworks/jest.mdx +++ b/src/content/docs/test-insights/test-frameworks/jest.mdx @@ -1,6 +1,6 @@ --- -title: Jest Integration with CI Insights -description: Report your test results from Jest tests to CI Insights +title: Jest Integration with Mergify +description: Report your test results from Jest tests to Mergify --- import jestLogo from "../../../images/ci-insights/jest/logo.svg" diff --git a/src/content/docs/ci-insights/test-frameworks/junit.mdx b/src/content/docs/test-insights/test-frameworks/junit.mdx similarity index 97% rename from src/content/docs/ci-insights/test-frameworks/junit.mdx rename to src/content/docs/test-insights/test-frameworks/junit.mdx index 2be284b539..b2095491f9 100644 --- a/src/content/docs/ci-insights/test-frameworks/junit.mdx +++ b/src/content/docs/test-insights/test-frameworks/junit.mdx @@ -1,6 +1,6 @@ --- -title: JUnit Integration with CI Insights -description: Report your test results from JUnit tests to CI Insights +title: JUnit Integration with Mergify +description: Report your test results from JUnit tests to Mergify --- import CommonTroubleshootingTips from "./_common-troubleshooting-tips.mdx" diff --git a/src/content/docs/ci-insights/test-frameworks/minitest.mdx b/src/content/docs/test-insights/test-frameworks/minitest.mdx similarity index 97% rename from src/content/docs/ci-insights/test-frameworks/minitest.mdx rename to src/content/docs/test-insights/test-frameworks/minitest.mdx index bca89fee21..19d9592fce 100644 --- a/src/content/docs/ci-insights/test-frameworks/minitest.mdx +++ b/src/content/docs/test-insights/test-frameworks/minitest.mdx @@ -1,6 +1,6 @@ --- -title: Minitest Integration with CI Insights -description: Report your test results from Minitest tests to CI Insights +title: Minitest Integration with Mergify +description: Report your test results from Minitest tests to Mergify --- import CommonTroubleshootingTips from "./_common-troubleshooting-tips.mdx" diff --git a/src/content/docs/ci-insights/test-frameworks/mstest.mdx b/src/content/docs/test-insights/test-frameworks/mstest.mdx similarity index 96% rename from src/content/docs/ci-insights/test-frameworks/mstest.mdx rename to src/content/docs/test-insights/test-frameworks/mstest.mdx index 64ecf1cd8f..852bf235f1 100644 --- a/src/content/docs/ci-insights/test-frameworks/mstest.mdx +++ b/src/content/docs/test-insights/test-frameworks/mstest.mdx @@ -1,6 +1,6 @@ --- -title: MSTest Integration with CI Insights -description: Report your test results from MSTest tests to CI Insights +title: MSTest Integration with Mergify +description: Report your test results from MSTest tests to Mergify --- import CommonTroubleshootingTips from "./_common-troubleshooting-tips.mdx" diff --git a/src/content/docs/ci-insights/test-frameworks/nunit.mdx b/src/content/docs/test-insights/test-frameworks/nunit.mdx similarity index 97% rename from src/content/docs/ci-insights/test-frameworks/nunit.mdx rename to src/content/docs/test-insights/test-frameworks/nunit.mdx index faed94a11c..18c7840eae 100644 --- a/src/content/docs/ci-insights/test-frameworks/nunit.mdx +++ b/src/content/docs/test-insights/test-frameworks/nunit.mdx @@ -1,6 +1,6 @@ --- -title: NUnit Integration with CI Insights -description: Report your test results from NUnit tests to CI Insights +title: NUnit Integration with Mergify +description: Report your test results from NUnit tests to Mergify --- import CommonTroubleshootingTips from './_common-troubleshooting-tips.mdx' diff --git a/src/content/docs/ci-insights/test-frameworks/pest.mdx b/src/content/docs/test-insights/test-frameworks/pest.mdx similarity index 97% rename from src/content/docs/ci-insights/test-frameworks/pest.mdx rename to src/content/docs/test-insights/test-frameworks/pest.mdx index 08481ee83d..8c4088c0f6 100644 --- a/src/content/docs/ci-insights/test-frameworks/pest.mdx +++ b/src/content/docs/test-insights/test-frameworks/pest.mdx @@ -1,6 +1,6 @@ --- -title: Pest Integration with CI Insights -description: Report your test results from Pest tests to CI Insights +title: Pest Integration with Mergify +description: Report your test results from Pest tests to Mergify --- import CommonTroubleshootingTips from "./_common-troubleshooting-tips.mdx" diff --git a/src/content/docs/ci-insights/test-frameworks/phpunit.mdx b/src/content/docs/test-insights/test-frameworks/phpunit.mdx similarity index 96% rename from src/content/docs/ci-insights/test-frameworks/phpunit.mdx rename to src/content/docs/test-insights/test-frameworks/phpunit.mdx index 0ef5ed01e7..a819a3d282 100644 --- a/src/content/docs/ci-insights/test-frameworks/phpunit.mdx +++ b/src/content/docs/test-insights/test-frameworks/phpunit.mdx @@ -1,6 +1,6 @@ --- -title: PHPUnit Integration with CI Insights -description: Report your test results from PHPUnit tests to CI Insights +title: PHPUnit Integration with Mergify +description: Report your test results from PHPUnit tests to Mergify --- import CommonTroubleshootingTips from "./_common-troubleshooting-tips.mdx" diff --git a/src/content/docs/ci-insights/test-frameworks/playwright.mdx b/src/content/docs/test-insights/test-frameworks/playwright.mdx similarity index 96% rename from src/content/docs/ci-insights/test-frameworks/playwright.mdx rename to src/content/docs/test-insights/test-frameworks/playwright.mdx index 921bbee3c2..92df9702b9 100644 --- a/src/content/docs/ci-insights/test-frameworks/playwright.mdx +++ b/src/content/docs/test-insights/test-frameworks/playwright.mdx @@ -1,6 +1,6 @@ --- -title: Playwright Integration with CI Insights -description: Report your test results from Playwright tests to CI Insights +title: Playwright Integration with Mergify +description: Report your test results from Playwright tests to Mergify --- import playwrightLogo from "../../../images/ci-insights/playwright/logo.svg" diff --git a/src/content/docs/ci-insights/test-frameworks/pytest.mdx b/src/content/docs/test-insights/test-frameworks/pytest.mdx similarity index 97% rename from src/content/docs/ci-insights/test-frameworks/pytest.mdx rename to src/content/docs/test-insights/test-frameworks/pytest.mdx index a46b3e56d0..e3fc50828c 100644 --- a/src/content/docs/ci-insights/test-frameworks/pytest.mdx +++ b/src/content/docs/test-insights/test-frameworks/pytest.mdx @@ -1,6 +1,6 @@ --- -title: Pytest Integration with CI Insights -description: Report your test results from pytest to CI Insights +title: Pytest Integration with Mergify +description: Report your test results from pytest to Mergify --- import pytestLogo from "../../../images/ci-insights/pytest/logo.svg" diff --git a/src/content/docs/ci-insights/test-frameworks/rspec.mdx b/src/content/docs/test-insights/test-frameworks/rspec.mdx similarity index 96% rename from src/content/docs/ci-insights/test-frameworks/rspec.mdx rename to src/content/docs/test-insights/test-frameworks/rspec.mdx index 8d211b4baa..96e0bb5417 100644 --- a/src/content/docs/ci-insights/test-frameworks/rspec.mdx +++ b/src/content/docs/test-insights/test-frameworks/rspec.mdx @@ -1,6 +1,6 @@ --- -title: RSpec Integration with CI Insights -description: Report your test results from RSpec to CI Insights +title: RSpec Integration with Mergify +description: Report your test results from RSpec to Mergify --- import rspecLogo from "../../../images/ci-insights/rspec/logo.svg" diff --git a/src/content/docs/ci-insights/test-frameworks/rust.mdx b/src/content/docs/test-insights/test-frameworks/rust.mdx similarity index 97% rename from src/content/docs/ci-insights/test-frameworks/rust.mdx rename to src/content/docs/test-insights/test-frameworks/rust.mdx index 98dfcf875d..d32b926964 100644 --- a/src/content/docs/ci-insights/test-frameworks/rust.mdx +++ b/src/content/docs/test-insights/test-frameworks/rust.mdx @@ -1,6 +1,6 @@ --- -title: Rust Integration with CI Insights -description: Report your test results from Rust tests to CI Insights +title: Rust Integration with Mergify +description: Report your test results from Rust tests to Mergify --- import rustLogo from "../../../images/ci-insights/rust/logo.svg" diff --git a/src/content/docs/ci-insights/test-frameworks/testng.mdx b/src/content/docs/test-insights/test-frameworks/testng.mdx similarity index 97% rename from src/content/docs/ci-insights/test-frameworks/testng.mdx rename to src/content/docs/test-insights/test-frameworks/testng.mdx index b327941d87..423d0119e4 100644 --- a/src/content/docs/ci-insights/test-frameworks/testng.mdx +++ b/src/content/docs/test-insights/test-frameworks/testng.mdx @@ -1,6 +1,6 @@ --- -title: TestNG Integration with CI Insights -description: Report your test results from TestNG tests to CI Insights +title: TestNG Integration with Mergify +description: Report your test results from TestNG tests to Mergify --- import CommonTroubleshootingTips from "./_common-troubleshooting-tips.mdx" diff --git a/src/content/docs/ci-insights/test-frameworks/vitest.mdx b/src/content/docs/test-insights/test-frameworks/vitest.mdx similarity index 96% rename from src/content/docs/ci-insights/test-frameworks/vitest.mdx rename to src/content/docs/test-insights/test-frameworks/vitest.mdx index 00dea33821..6cb1d96d23 100644 --- a/src/content/docs/ci-insights/test-frameworks/vitest.mdx +++ b/src/content/docs/test-insights/test-frameworks/vitest.mdx @@ -1,6 +1,6 @@ --- -title: Vitest Integration with CI Insights -description: Report your test results from Vitest to CI Insights +title: Vitest Integration with Mergify +description: Report your test results from Vitest to Mergify --- import vitestLogo from "../../../images/ci-insights/vitest/logo.svg" diff --git a/src/content/navItems.tsx b/src/content/navItems.tsx index cccc5c2875..8e8f47cf87 100644 --- a/src/content/navItems.tsx +++ b/src/content/navItems.tsx @@ -94,7 +94,6 @@ const navItems: NavItem[] = [ path: '/ci-insights/flaky-test-detection', icon: 'lucide:bug', }, - { title: 'Quarantine', path: '/ci-insights/quarantine', icon: 'lucide:radiation' }, { title: 'CI Setup', icon: 'lucide:settings', @@ -112,81 +111,86 @@ const navItems: NavItem[] = [ { title: 'Jenkins', path: '/ci-insights/setup/jenkins', icon: 'simple-icons:jenkins' }, ], }, + ], + }, + { + title: 'Test Insights', + path: '/test-insights', + icon: 'mergify:test-insights', + children: [ + { title: 'Overview', path: '/test-insights', icon: 'lucide:lightbulb' }, + { title: 'Prevention', path: '/test-insights/prevention', icon: 'lucide:shield-half' }, + { title: 'Detection', path: '/test-insights/detection', icon: 'lucide:search' }, + { title: 'Mitigation', path: '/test-insights/mitigation', icon: 'lucide:radiation' }, + { title: 'Quarantine', path: '/test-insights/quarantine', icon: 'lucide:radiation' }, { title: 'Test Frameworks Setup', - path: '/ci-insights#test-framework-configuration', + path: '/test-insights#test-framework-configuration', icon: 'lucide:flask-conical', children: [ { title: 'Cypress', - path: '/ci-insights/test-frameworks/cypress', + path: '/test-insights/test-frameworks/cypress', icon: 'simple-icons:cypress', }, - { title: 'Go', path: '/ci-insights/test-frameworks/golang', icon: 'simple-icons:go' }, - { title: 'Jest', path: '/ci-insights/test-frameworks/jest', icon: 'simple-icons:jest' }, + { title: 'Go', path: '/test-insights/test-frameworks/golang', icon: 'simple-icons:go' }, + { title: 'Jest', path: '/test-insights/test-frameworks/jest', icon: 'simple-icons:jest' }, { title: 'JUnit', - path: '/ci-insights/test-frameworks/junit', + path: '/test-insights/test-frameworks/junit', icon: 'simple-icons:junit5', }, { title: 'minitest', - path: '/ci-insights/test-frameworks/minitest', + path: '/test-insights/test-frameworks/minitest', icon: 'simple-icons:ruby', }, { title: 'MSTest', - path: '/ci-insights/test-frameworks/mstest', + path: '/test-insights/test-frameworks/mstest', icon: 'simple-icons:dotnet', }, { title: 'NUnit', - path: '/ci-insights/test-frameworks/nunit', + path: '/test-insights/test-frameworks/nunit', icon: 'simple-icons:dotnet', }, - { title: 'Pest', path: '/ci-insights/test-frameworks/pest', icon: 'simple-icons:php' }, + { title: 'Pest', path: '/test-insights/test-frameworks/pest', icon: 'simple-icons:php' }, { title: 'PHPUnit', - path: '/ci-insights/test-frameworks/phpunit', + path: '/test-insights/test-frameworks/phpunit', icon: 'simple-icons:php', }, { title: 'Playwright', - path: '/ci-insights/test-frameworks/playwright', + path: '/test-insights/test-frameworks/playwright', icon: 'simple-icons:playwright', }, { title: 'pytest', - path: '/ci-insights/test-frameworks/pytest', + path: '/test-insights/test-frameworks/pytest', icon: 'simple-icons:pytest', }, - { title: 'RSpec', path: '/ci-insights/test-frameworks/rspec', icon: 'simple-icons:ruby' }, - { title: 'Rust', path: '/ci-insights/test-frameworks/rust', icon: 'simple-icons:rust' }, + { + title: 'RSpec', + path: '/test-insights/test-frameworks/rspec', + icon: 'simple-icons:ruby', + }, + { title: 'Rust', path: '/test-insights/test-frameworks/rust', icon: 'simple-icons:rust' }, { title: 'TestNG', - path: '/ci-insights/test-frameworks/testng', + path: '/test-insights/test-frameworks/testng', icon: 'simple-icons:testinglibrary', }, { title: 'Vitest', - path: '/ci-insights/test-frameworks/vitest', + path: '/test-insights/test-frameworks/vitest', icon: 'simple-icons:vitest', }, ], }, ], }, - { - title: 'Test Insights', - path: '/test-insights', - icon: 'mergify:test-insights', - children: [ - { title: 'Overview', path: '/test-insights', icon: 'lucide:lightbulb' }, - { title: 'Prevention', path: '/test-insights/prevention', icon: 'lucide:shield-half' }, - { title: 'Detection', path: '/test-insights/detection', icon: 'lucide:search' }, - { title: 'Mitigation', path: '/test-insights/mitigation', icon: 'lucide:radiation' }, - ], - }, { title: 'Merge Protections', path: '/merge-protections', From 812a5b064440450dbfd2a4a4af4a2041337306a6 Mon Sep 17 00:00:00 2001 From: Julien Danjou Date: Wed, 20 May 2026 15:09:35 +0200 Subject: [PATCH 2/2] docs: update framework page prose to reference Test Insights MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Since these pages now live under /test-insights/, the body content references "Test Insights" instead of "CI Insights" — matching where the per-framework guides feed into. Change-Id: I06c4a7f93f35e1a852d6a760dfb10e2ba61a21c2 --- .../_buildkite_mergify_ci_quarantine_setup.mdx | 2 +- .../_gha_mergify_ci_quarantine_setup.mdx | 2 +- .../docs/test-insights/test-frameworks/cypress.mdx | 10 +++++----- .../docs/test-insights/test-frameworks/golang.mdx | 12 ++++++------ .../docs/test-insights/test-frameworks/jest.mdx | 10 +++++----- .../docs/test-insights/test-frameworks/junit.mdx | 12 ++++++------ .../test-insights/test-frameworks/minitest.mdx | 10 +++++----- .../docs/test-insights/test-frameworks/mstest.mdx | 10 +++++----- .../docs/test-insights/test-frameworks/nunit.mdx | 10 +++++----- .../docs/test-insights/test-frameworks/pest.mdx | 10 +++++----- .../docs/test-insights/test-frameworks/phpunit.mdx | 10 +++++----- .../test-insights/test-frameworks/playwright.mdx | 10 +++++----- .../docs/test-insights/test-frameworks/pytest.mdx | 14 +++++++------- .../docs/test-insights/test-frameworks/rspec.mdx | 12 ++++++------ .../docs/test-insights/test-frameworks/rust.mdx | 10 +++++----- .../docs/test-insights/test-frameworks/testng.mdx | 10 +++++----- .../docs/test-insights/test-frameworks/vitest.mdx | 12 ++++++------ 17 files changed, 83 insertions(+), 83 deletions(-) diff --git a/src/content/docs/test-insights/test-frameworks/_buildkite_mergify_ci_quarantine_setup.mdx b/src/content/docs/test-insights/test-frameworks/_buildkite_mergify_ci_quarantine_setup.mdx index 2dfda2bb72..3c433ea4e1 100644 --- a/src/content/docs/test-insights/test-frameworks/_buildkite_mergify_ci_quarantine_setup.mdx +++ b/src/content/docs/test-insights/test-frameworks/_buildkite_mergify_ci_quarantine_setup.mdx @@ -1,4 +1,4 @@ -When using the Buildkite plugin for CI Insights Quarantine, the plugin automatically +When using the Buildkite plugin for Test Insights Quarantine, the plugin automatically detects test failures using the step's exit code. No extra configuration is needed. The `mergifyio/mergify-ci` plugin runs in the `post-command` hook and reads diff --git a/src/content/docs/test-insights/test-frameworks/_gha_mergify_ci_quarantine_setup.mdx b/src/content/docs/test-insights/test-frameworks/_gha_mergify_ci_quarantine_setup.mdx index 3962220913..b766f204a9 100644 --- a/src/content/docs/test-insights/test-frameworks/_gha_mergify_ci_quarantine_setup.mdx +++ b/src/content/docs/test-insights/test-frameworks/_gha_mergify_ci_quarantine_setup.mdx @@ -1,4 +1,4 @@ -In order to benefit from CI Insights Quarantine, you need to add `continue-on-error: true` +In order to benefit from Test Insights Quarantine, you need to add `continue-on-error: true` in your GitHub Actions step that executes your tests and generates the JUnit file. The step running the `gha-mergify-ci` action will determine the success or failure conclusion, considering quarantined tests. diff --git a/src/content/docs/test-insights/test-frameworks/cypress.mdx b/src/content/docs/test-insights/test-frameworks/cypress.mdx index eeea479a5a..521659329b 100644 --- a/src/content/docs/test-insights/test-frameworks/cypress.mdx +++ b/src/content/docs/test-insights/test-frameworks/cypress.mdx @@ -18,7 +18,7 @@ import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.as This guide shows how to configure [Cypress](https://www.cypress.io/) to produce -JUnit reports and upload them to CI Insights using your CI workflow. +JUnit reports and upload them to Test Insights using your CI workflow. ## Generate a JUnit Report with Cypress @@ -52,7 +52,7 @@ both have JUnit generated while keeping the standard output. Once you have the JUnit file produced by Cypress, add a step to upload these -results to **CI Insights** via the `mergifyio/gha-mergify-ci` action. +results to **Test Insights** via the `mergifyio/gha-mergify-ci` action. In the workflow file where Cypress is launched, after running `npm run test:cypress` (or similar), include a step like: @@ -73,16 +73,16 @@ test:cypress` (or similar), include a step like: -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will run tests with Cypress. 2. Cypress generates JUnit files. -3. The Mergify CI action uploads that file to CI Insights. +3. The Mergify CI action uploads that file to Test Insights. You can then see your test results, including failures and flaky tests, -directly in the CI Insights dashboard. +directly in the Test Insights dashboard. ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/golang.mdx b/src/content/docs/test-insights/test-frameworks/golang.mdx index b1f6cea6eb..788052b380 100644 --- a/src/content/docs/test-insights/test-frameworks/golang.mdx +++ b/src/content/docs/test-insights/test-frameworks/golang.mdx @@ -18,7 +18,7 @@ import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.as This guide shows how to generate JUnit reports from your Go tests and upload -them to **CI Insights** using your CI workflow. +them to **Test Insights** using your CI workflow. ## Generate a JUnit Report with Go Tests @@ -45,7 +45,7 @@ gotestsum --junitfile junit.xml -After generating the JUnit report, add a step to upload the results to CI +After generating the JUnit report, add a step to upload the results to Test Insights using the mergifyio/gha-mergify-ci action. For example, in your workflow file: @@ -72,17 +72,17 @@ For example, in your workflow file: -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will execute your Go tests. 2. A JUnit report (junit.xml) is generated. -3. The Mergify CI action uploads the report to CI Insights. +3. The Mergify CI action uploads the report to Test Insights. You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +directly in the [Test Insights +dashboard](https://dashboard.mergify.com/test-insights/jobs). ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/jest.mdx b/src/content/docs/test-insights/test-frameworks/jest.mdx index 35a2de1502..61a76b27d9 100644 --- a/src/content/docs/test-insights/test-frameworks/jest.mdx +++ b/src/content/docs/test-insights/test-frameworks/jest.mdx @@ -18,7 +18,7 @@ import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.as This guide shows how to generate JUnit reports from your Jest tests and upload -them to **CI Insights** using your CI workflow. +them to **Test Insights** using your CI workflow. ## Generate a JUnit Report with Jest @@ -97,17 +97,17 @@ For example, in your workflow file: -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will execute your Jest tests. 2. A JUnit report (`junit.xml`) is generated. -3. The Mergify CI action uploads the report to CI Insights. +3. The Mergify CI action uploads the report to Test Insights. You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +directly in the [Test Insights +dashboard](https://dashboard.mergify.com/test-insights/jobs). ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/junit.mdx b/src/content/docs/test-insights/test-frameworks/junit.mdx index b2095491f9..6466e784af 100644 --- a/src/content/docs/test-insights/test-frameworks/junit.mdx +++ b/src/content/docs/test-insights/test-frameworks/junit.mdx @@ -14,12 +14,12 @@ import BuildkiteCIQuarantineSetup from "./_buildkite_mergify_ci_quarantine_setup import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.astro" This guide shows how to generate JUnit reports from your JUnit tests and upload -them to **CI Insights** using your CI workflow. +them to **Test Insights** using your CI workflow. ## Generate a JUnit Report with JUnit JUnit naturally generates XML reports that are compatible with the JUnit format -expected by CI Insights. You can configure your build tool to output these +expected by Test Insights. You can configure your build tool to output these reports. ### Using Maven @@ -124,17 +124,17 @@ For Gradle projects: -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will execute your JUnit tests. 2. JUnit XML reports are generated by Maven/Gradle. -3. The Mergify CI action uploads the reports to CI Insights. +3. The Mergify CI action uploads the reports to Test Insights. You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +directly in the [Test Insights +dashboard](https://dashboard.mergify.com/test-insights/jobs). ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/minitest.mdx b/src/content/docs/test-insights/test-frameworks/minitest.mdx index 19d9592fce..d96c03eb7b 100644 --- a/src/content/docs/test-insights/test-frameworks/minitest.mdx +++ b/src/content/docs/test-insights/test-frameworks/minitest.mdx @@ -14,7 +14,7 @@ import BuildkiteCIQuarantineSetup from "./_buildkite_mergify_ci_quarantine_setup import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.astro" This guide shows how to generate JUnit reports from your Minitest tests and upload -them to **CI Insights** using your CI workflow. +them to **Test Insights** using your CI workflow. ## Generate a JUnit Report with Minitest @@ -159,17 +159,17 @@ Using `minitest-reporters` approach: -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will execute your Minitest tests. 2. A JUnit report (junit.xml) is generated. -3. The Mergify CI action uploads the report to CI Insights. +3. The Mergify CI action uploads the report to Test Insights. You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +directly in the [Test Insights +dashboard](https://dashboard.mergify.com/test-insights/jobs). ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/mstest.mdx b/src/content/docs/test-insights/test-frameworks/mstest.mdx index 852bf235f1..1ceaf2a309 100644 --- a/src/content/docs/test-insights/test-frameworks/mstest.mdx +++ b/src/content/docs/test-insights/test-frameworks/mstest.mdx @@ -14,7 +14,7 @@ import BuildkiteCIQuarantineSetup from "./_buildkite_mergify_ci_quarantine_setup import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.astro" This guide shows how to generate JUnit reports from your MSTest tests and upload -them to **CI Insights** using your CI workflow. +them to **Test Insights** using your CI workflow. ## Generate a JUnit Report with MSTest @@ -106,17 +106,17 @@ For example, in your workflow file: -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will execute your MSTest tests. 2. A JUnit report (junit.xml) is generated. -3. The Mergify CI action uploads the report to CI Insights. +3. The Mergify CI action uploads the report to Test Insights. You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +directly in the [Test Insights +dashboard](https://dashboard.mergify.com/test-insights/jobs). ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/nunit.mdx b/src/content/docs/test-insights/test-frameworks/nunit.mdx index 18c7840eae..f1d85640bf 100644 --- a/src/content/docs/test-insights/test-frameworks/nunit.mdx +++ b/src/content/docs/test-insights/test-frameworks/nunit.mdx @@ -14,7 +14,7 @@ import BuildkiteCIQuarantineSetup from "./_buildkite_mergify_ci_quarantine_setup import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.astro" This guide shows how to generate JUnit reports from your NUnit tests and upload -them to **CI Insights** using your CI workflow. +them to **Test Insights** using your CI workflow. ## Generate a JUnit Report with NUnit @@ -125,17 +125,17 @@ For example, in your workflow file: -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will execute your NUnit tests. 2. A JUnit report (junit.xml) is generated. -3. The Mergify CI action uploads the report to CI Insights. +3. The Mergify CI action uploads the report to Test Insights. You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +directly in the [Test Insights +dashboard](https://dashboard.mergify.com/test-insights/jobs). ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/pest.mdx b/src/content/docs/test-insights/test-frameworks/pest.mdx index 8c4088c0f6..7f4803110b 100644 --- a/src/content/docs/test-insights/test-frameworks/pest.mdx +++ b/src/content/docs/test-insights/test-frameworks/pest.mdx @@ -14,7 +14,7 @@ import BuildkiteCIQuarantineSetup from "./_buildkite_mergify_ci_quarantine_setup import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.astro" This guide shows how to generate JUnit reports from your Pest tests and upload -them to **CI Insights** using your CI workflow. +them to **Test Insights** using your CI workflow. ## Generate a JUnit Report with Pest @@ -117,17 +117,17 @@ For example, in your workflow file: -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will execute your Pest tests. 2. A JUnit report (junit.xml) is generated. -3. The Mergify CI action uploads the report to CI Insights. +3. The Mergify CI action uploads the report to Test Insights. You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +directly in the [Test Insights +dashboard](https://dashboard.mergify.com/test-insights/jobs). ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/phpunit.mdx b/src/content/docs/test-insights/test-frameworks/phpunit.mdx index a819a3d282..d809b9b9f9 100644 --- a/src/content/docs/test-insights/test-frameworks/phpunit.mdx +++ b/src/content/docs/test-insights/test-frameworks/phpunit.mdx @@ -14,7 +14,7 @@ import BuildkiteCIQuarantineSetup from "./_buildkite_mergify_ci_quarantine_setup import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.astro" This guide shows how to generate JUnit reports from your PHPUnit tests and upload -them to **CI Insights** using your CI workflow. +them to **Test Insights** using your CI workflow. ## Generate a JUnit Report with PHPUnit @@ -104,17 +104,17 @@ For example, in your workflow file: -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will execute your PHPUnit tests. 2. A JUnit report (junit.xml) is generated. -3. The Mergify CI action uploads the report to CI Insights. +3. The Mergify CI action uploads the report to Test Insights. You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +directly in the [Test Insights +dashboard](https://dashboard.mergify.com/test-insights/jobs). ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/playwright.mdx b/src/content/docs/test-insights/test-frameworks/playwright.mdx index 92df9702b9..81e212199e 100644 --- a/src/content/docs/test-insights/test-frameworks/playwright.mdx +++ b/src/content/docs/test-insights/test-frameworks/playwright.mdx @@ -18,7 +18,7 @@ import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.as This guide shows how to generate JUnit reports from your Playwright tests and upload -them to **CI Insights** using your CI workflow. +them to **Test Insights** using your CI workflow. ## Generate a JUnit Report with Playwright @@ -93,17 +93,17 @@ For example, in your workflow file: testCommand="npx playwright test --reporter=list --reporter=junit:junit.xml" /> -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will execute your Playwright tests. 2. A JUnit report (junit.xml) is generated. -3. The Mergify CI action uploads the report to CI Insights. +3. The Mergify CI action uploads the report to Test Insights. You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +directly in the [Test Insights +dashboard](https://dashboard.mergify.com/test-insights/jobs). ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/pytest.mdx b/src/content/docs/test-insights/test-frameworks/pytest.mdx index e3fc50828c..c60aba7796 100644 --- a/src/content/docs/test-insights/test-frameworks/pytest.mdx +++ b/src/content/docs/test-insights/test-frameworks/pytest.mdx @@ -9,15 +9,15 @@ import CIInsightsSetupNote from "../../../../components/CIInsightsSetupNote.astr -This guide explains how to integrate Pytest with CI Insights using the +This guide explains how to integrate Pytest with Test Insights using the `pytest-mergify` plugin. Once installed, test results are automatically -uploaded to CI Insights without any extra workflow changes. +uploaded to Test Insights without any extra workflow changes. ## Installation You need to install the [`pytest-mergify`](https://pypi.python.org/pypi/pytest-mergify) plugin to -automatically upload your test results to **CI Insights**. This can be done in +automatically upload your test results to **Test Insights**. This can be done in different ways depending on your Python dependency setup. Below are a few examples: @@ -100,9 +100,9 @@ steps: MERGIFY_TOKEN: "${MERGIFY_TOKEN}" ``` -The plugin collects your test results and sends them to CI Insights. +The plugin collects your test results and sends them to Test Insights. -Check the CI Insights dashboard afterward to view execution metrics, detect +Check the Test Insights dashboard afterward to view execution metrics, detect flaky tests, and review test trends. ## Using with Tox @@ -147,7 +147,7 @@ will work for all of them as long as the token is set correctly. If you’re running multiple Tox environments (e.g., py38, py39, etc.), we recommend setting the `MERGIFY_TEST_JOB_NAME` environment variable to identify each -environment’s report in CI Insights: +environment’s report in Test Insights: In your CI workflow: @@ -175,6 +175,6 @@ steps: ``` :::tip -Use `MERGIFY_TEST_JOB_NAME` to make reports clearer in CI Insights, especially when +Use `MERGIFY_TEST_JOB_NAME` to make reports clearer in Test Insights, especially when running multiple Tox environments or using a matrix. ::: diff --git a/src/content/docs/test-insights/test-frameworks/rspec.mdx b/src/content/docs/test-insights/test-frameworks/rspec.mdx index 96e0bb5417..2578b71e75 100644 --- a/src/content/docs/test-insights/test-frameworks/rspec.mdx +++ b/src/content/docs/test-insights/test-frameworks/rspec.mdx @@ -9,15 +9,15 @@ import CIInsightsSetupNote from "../../../../components/CIInsightsSetupNote.astr -This guide explains how to integrate RSpec with CI Insights using the +This guide explains how to integrate RSpec with Test Insights using the `rspec-mergify` gem. Once installed, test results are automatically uploaded to -CI Insights without any extra workflow changes. +Test Insights without any extra workflow changes. ## Installation You need to install the [`rspec-mergify`](https://rubygems.org/gems/rspec-mergify) gem to automatically -upload your test results to **CI Insights**. +upload your test results to **Test Insights**. ### Gemfile @@ -80,9 +80,9 @@ steps: MERGIFY_TOKEN: "${MERGIFY_TOKEN}" ``` -The gem automatically collects your test results and sends them to CI Insights. +The gem automatically collects your test results and sends them to Test Insights. -Check the CI Insights dashboard afterward to view execution metrics, detect +Check the Test Insights dashboard afterward to view execution metrics, detect flaky tests, and review test trends. ## Environment Variables @@ -102,6 +102,6 @@ variable). To enable it outside CI, set `RSPEC_MERGIFY_ENABLE=true`. ::: :::tip -Use `MERGIFY_TEST_JOB_NAME` to make reports clearer in CI Insights, especially +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/rust.mdx b/src/content/docs/test-insights/test-frameworks/rust.mdx index d32b926964..05b2ace8c9 100644 --- a/src/content/docs/test-insights/test-frameworks/rust.mdx +++ b/src/content/docs/test-insights/test-frameworks/rust.mdx @@ -18,7 +18,7 @@ import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.as This guide shows how to generate JUnit reports from your Rust tests and upload -them to **CI Insights** using your CI workflow. +them to **Test Insights** using your CI workflow. ## Generate a JUnit Report with Rust Tests @@ -122,17 +122,17 @@ Alternative approach using cargo2junit: -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will execute your Rust tests. 2. A JUnit report (junit.xml) is generated. -3. The Mergify CI action uploads the report to CI Insights. +3. The Mergify CI action uploads the report to Test Insights. You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +directly in the [Test Insights +dashboard](https://dashboard.mergify.com/test-insights/jobs). ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/testng.mdx b/src/content/docs/test-insights/test-frameworks/testng.mdx index 423d0119e4..e0a7201fc9 100644 --- a/src/content/docs/test-insights/test-frameworks/testng.mdx +++ b/src/content/docs/test-insights/test-frameworks/testng.mdx @@ -14,7 +14,7 @@ import BuildkiteCIQuarantineSetup from "./_buildkite_mergify_ci_quarantine_setup import MergifyCliUploadStep from "../../../../components/MergifyCliUploadStep.astro" This guide shows how to generate JUnit reports from your TestNG tests and upload -them to **CI Insights** using your CI workflow. +them to **Test Insights** using your CI workflow. ## Generate a JUnit Report with TestNG @@ -137,17 +137,17 @@ For Gradle projects: -## Verify and Review in CI Insights +## Verify and Review in Test Insights After pushing these changes: 1. Your GitHub Actions workflow will execute your TestNG tests. 2. JUnit-compatible XML reports are generated. -3. The Mergify CI action uploads the reports to CI Insights. +3. The Mergify CI action uploads the reports to Test Insights. You can then review your test results, including any failures or flaky tests, -directly in the [CI Insights -dashboard](https://dashboard.mergify.com/ci-insights/jobs). +directly in the [Test Insights +dashboard](https://dashboard.mergify.com/test-insights/jobs). ## Troubleshooting Tips diff --git a/src/content/docs/test-insights/test-frameworks/vitest.mdx b/src/content/docs/test-insights/test-frameworks/vitest.mdx index 6cb1d96d23..332afe404c 100644 --- a/src/content/docs/test-insights/test-frameworks/vitest.mdx +++ b/src/content/docs/test-insights/test-frameworks/vitest.mdx @@ -9,15 +9,15 @@ import CIInsightsSetupNote from "../../../../components/CIInsightsSetupNote.astr -This guide explains how to integrate [Vitest](https://vitest.dev/) with CI +This guide explains how to integrate [Vitest](https://vitest.dev/) with Test Insights using the `@mergifyio/vitest` reporter. Once installed, test results -are automatically uploaded to CI Insights without any extra workflow changes. +are automatically uploaded to Test Insights without any extra workflow changes. ## Installation You need to install the [`@mergifyio/vitest`](https://www.npmjs.com/package/@mergifyio/vitest) package -to automatically upload your test results to **CI Insights**. +to automatically upload your test results to **Test Insights**. ### npm @@ -92,10 +92,10 @@ steps: MERGIFY_TOKEN: "${MERGIFY_TOKEN}" ``` -The reporter automatically collects your test results and sends them to CI +The reporter automatically collects your test results and sends them to Test Insights. -Check the CI Insights dashboard afterward to view execution metrics, detect +Check the Test Insights dashboard afterward to view execution metrics, detect flaky tests, and review test trends. ## Environment Variables @@ -116,6 +116,6 @@ flaky tests, and review test trends. ::: :::tip - Use `MERGIFY_TEST_JOB_NAME` to make reports clearer in CI Insights, + Use `MERGIFY_TEST_JOB_NAME` to make reports clearer in Test Insights, especially when running multiple test suites or using a matrix strategy. :::