Skip to content

Commit 0652aec

Browse files
committed
fix lint errors
1 parent f6e929d commit 0652aec

File tree

2 files changed

+18
-64
lines changed

2 files changed

+18
-64
lines changed

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

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= Smarter Testing
22
:page-badge: Preview
33
:page-platform: Cloud
4-
:page-description: This document describes the Smarter Testing feature in CircleCI, which enables only running tests that are impacted by code changes and evenly distributes tests across parallel execution nodes.
4+
:page-description: This page describes CircleCI's Smarter Testing. Only run tests that are impacted by code changes and evenly distribute tests across parallel execution nodes.
55
:experimental:
66
:page-noindex: true
77
:page-aliases: adaptive-testing.adoc
@@ -43,8 +43,8 @@ TIP: In codebases with sparse test coverage, Smarter Testing cannot accurately d
4343
== How it works
4444
Smarter Testing operates through two main components that work together to optimize your test execution:
4545

46-
* Dynamic test splitting
47-
* Test impact analysis
46+
* Dynamic test splitting.
47+
* Test impact analysis.
4848

4949
Each component is described in more detail below.
5050

@@ -551,7 +551,10 @@ a| * `all` selects and runs all discovered tests, used to run the full test suit
551551

552552
== 3. Start using Smarter Testing
553553

554-
Now the test suite is set up, test selection is working and the test analysis is up to date with the latest changes from the feature branch that ran the first test analysis.
554+
Now the test suite is set up:
555+
556+
* Test selection is working.
557+
* The test analysis is up to date with the latest changes from the feature branch that ran the first test analysis.
555558

556559
*Action Items*
557560

@@ -679,9 +682,9 @@ The Smarter Testing feature has some limitations to consider:
679682

680683
*Debugging steps:*
681684

682-
. Check that all test files are discovered with the discover command
683-
. Verify parallelism is set correctly in your config.yml
684-
. Look for timing data in previous test runs
685+
. Check that all test files are discovered with the discover command.
686+
. Verify parallelism is set correctly in your config.yml.
687+
. Look for timing data in previous test runs.
685688
. Ensure test results are being stored with `store_test_results`.
686689

687690
=== Test impact analysis not selecting expected tests
@@ -692,10 +695,10 @@ The Smarter Testing feature has some limitations to consider:
692695

693696
*Debugging steps:*
694697

695-
. Verify analysis has run successfully on your configured branch(es)
696-
. Check that coverage data is being generated correctly
697-
. Review the full-test-run-paths configuration - changes to these paths trigger full test runs
698-
. Confirm the analysis command is producing valid LCOV output
698+
. Verify analysis has run successfully on your configured branch(es).
699+
. Check that coverage data is being generated correctly.
700+
. Review the full-test-run-paths configuration - changes to these paths trigger full test runs.
701+
. Confirm the analysis command is producing valid LCOV output.
699702

700703
*When all tests run:* If no impact data exists or all tests are determined to be affected, the system runs all tests as a safety measure.
701704

@@ -745,9 +748,9 @@ The frequency depends on your test execution speed and development pace:
745748

746749
*Consider re-running analysis:*
747750

748-
* After major refactoring or code restructuring
749-
* When test selection seems inaccurate or outdated
750-
* After adding significant new code or tests
751+
* After major refactoring or code restructuring.
752+
* When test selection seems inaccurate or outdated.
753+
* After adding significant new code or tests.
751754

752755
*Remember:* You can customize which branches run analysis through your CircleCI configuration - it does not have to be limited to the main branch.
753756

@@ -822,7 +825,7 @@ See the <<run-higher-parallelism-on-the-analysis-branch,Run higher parallelism o
822825
[#baseline-coverage]
823826
=== Why are there so many files impacting a test?
824827

825-
If you see many files impacting each test during analysis (for example, "...found 150 files impacting test..."), this may be caused by shared setup code like global imports or framework initialization being included in coverage.
828+
If you see many files impacting each test during analysis, for example, `...found 150 files impacting test...`, this may be caused by shared setup code like global imports or framework initialization being included in coverage.
826829

827830
This extraneous coverage can be excluded by providing an `analysis-baseline` command to compute the code covered during startup that isn't directly exercised by test code. We call this "baseline coverage data".
828831

styles/AsciiDoc/UnsetAttributes.yml

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)