Skip to content

Commit db49528

Browse files
committed
style fixes
1 parent db7396c commit db49528

File tree

1 file changed

+25
-18
lines changed

1 file changed

+25
-18
lines changed

docs/guides/modules/test/pages/adaptive-testing.adoc

Lines changed: 25 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Use adaptive testing to optimize test runs as follows:
1616
1717
Adaptive testing reduces test execution time while maintaining test confidence.
1818

19-
== Use cases for adaptive testing
19+
== Is my project a good fit for adaptive testing?
20+
21+
The following list shows some examples of where adaptive testing can be most beneficial:
2022

2123
* Unit and integration tests that exercise code within the same repository.
2224
* Projects with comprehensive test coverage. The more thorough your tests, the more precisely adaptive testing can identify which tests are impacted by changes.
@@ -38,7 +40,12 @@ TIP: In codebases with sparse test coverage, adaptive testing cannot accurately
3840
* Scale efficiently as test suites grow.
3941

4042
== How it works
41-
The adaptive testing feature operates through two main components that work together to optimize your test execution:
43+
Adaptive testing operates through two main components that work together to optimize your test execution:
44+
45+
* Dynamic test splitting
46+
* Test impact analysis
47+
48+
Each component is described in more detail below.
4249

4350
=== Dynamic test splitting
4451
Dynamic test splitting distributes your tests across parallel execution nodes. The system maintains a shared queue that each node pulls from to create a balanced workload.
@@ -737,11 +744,11 @@ The frequency depends on your test execution speed and development pace:
737744

738745
*Consider re-running analysis:*
739746

740-
. After major refactoring or code restructuring
741-
. When test selection seems inaccurate or outdated
742-
. After adding significant new code or tests
747+
* After major refactoring or code restructuring
748+
* When test selection seems inaccurate or outdated
749+
* After adding significant new code or tests
743750

744-
*Remember:* You can customize which branches run analysis through your CircleCI configuration - it doesn't have to be limited to the main branch.
751+
*Remember:* You can customize which branches run analysis through your CircleCI configuration - it does not have to be limited to the main branch.
745752

746753
=== Can I customize the test-suites.yml commands?
747754

@@ -754,10 +761,10 @@ Yes, you can fully customize commands by defining `discover`, `run`, and `analys
754761

755762
*Requirements when customizing:*
756763

757-
. Ensure your commands properly handle test execution
758-
. Generate valid coverage data for the analysis phase
759-
. Use the correct template variables (`<< test.atoms >>`, `<< outputs.junit >>`, `<< outputs.lcov >>`)
760-
. Output test results in a format CircleCI can parse (typically JUnit XML)
764+
* Ensure your commands properly handle test execution.
765+
* Generate valid coverage data for the analysis phase.
766+
* Use the correct template variables (`<< test.atoms >>`, `<< outputs.junit >>`, `<< outputs.lcov >>`).
767+
* Output test results in a format CircleCI can parse (typically JUnit XML).
761768

762769
=== What happens if no tests are impacted by a change?
763770

@@ -792,22 +799,22 @@ You can also compare:
792799

793800
=== Can I run analysis on branches other than main?
794801

795-
Yes! The branch behavior is fully customizable through your CircleCI configuration. While analysis typically runs on `main` by default, you can configure it to run on:
802+
Yes! The branch behavior is fully customizable through your CircleCI configuration. While analysis typically runs on `main` by default, you can configure it to run on any of the following:
796803

797-
. Any specific branch (for example, `develop` or `staging`).
798-
. Multiple branches simultaneously.
799-
. Feature branches if needed for testing.
800-
. Scheduled pipelines independent of branch.
804+
* Any specific branch (for example, `develop` or `staging`).
805+
* Multiple branches simultaneously.
806+
* Feature branches if needed for testing.
807+
* Scheduled pipelines independent of branch.
801808

802809
See the <<run-higher-parallelism-on-the-analysis-branch,Run higher parallelism on the analysis branch>> example for an example of customizing branch behavior.
803810

804811
=== Can I run test analysis and selection on any branch?
805812

806813
Yes! The branch behavior is fully customizable through your CircleCI configuration. While analysis runs on main by default, you can configure it to run on:
807814

808-
. Any specific branch (for example, `develop` or `staging`).
809-
. Feature branches if needed for testing.
810-
. Scheduled pipelines.
815+
* Any specific branch (for example, `develop` or `staging`).
816+
* Feature branches if needed for testing.
817+
* Scheduled pipelines.
811818

812819
See the <<run-higher-parallelism-on-the-analysis-branch,Run higher parallelism on the analysis branch>> example for an example of customizing branch behavior.
813820

0 commit comments

Comments
 (0)