Skip to content

TEST-52 Add impact-key to the adaptive testing docs #9757

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 21, 2025
Merged

TEST-52 Add impact-key to the adaptive testing docs #9757

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
026fb19
TEST-52 Add impact-key to the adaptive testing docs
liamclarkedev Nov 14, 2025
eec9f9c
Merge branch 'main' into test-52/impact-key
mseong6251 Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/guides/modules/test/pages/adaptive-testing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,27 @@ The coverage location does not need to be set in the outputs map. A temporary fi

. Update your `.circleci/test-suites.yml` file with the analysis command.

[NOTE]
====
*Multi-project/monorepo with the same filenames across sub-packages?*

To prevent the files and tests conflicting with others in the same project (`service-1/index.test.ts`, `service-2/index.test.ts`), the `impact-key` option can be passed to group relevant impact data together when running analysis.

[source,yaml]
----
# .circleci/test-suites.yml
name: service-1 tests
options:
adaptive-testing: true
impact-key: service-1
---
name: service-2 tests
options:
adaptive-testing: true
impact-key: service-2
----
====

[source,yaml]
----
# .circleci/test-suites.yml
Expand Down Expand Up @@ -521,6 +542,10 @@ Any remaining tests will be analysed the next time test analysis is run.
|true
|Whether the tests should be distributed across a shared queue and fetched across multiple dynamic batches. +
If a test runner has slow start up time per batch, disabling this can speed up tests.

|`impact-key`
|`default`
|Group relevant impact data together using a matching key within the same project.
|===
--

Expand Down