Skip to content

Commit 16697a0

Browse files
docs: add selectivity config docs
1 parent 83ad99d commit 16697a0

File tree

2 files changed

+115
-0
lines changed

2 files changed

+115
-0
lines changed

docs/config/browsers.mdx

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1017,6 +1017,64 @@ export = {
10171017
};
10181018
```
10191019

1020+
## Selectivity {#selectivity}
1021+
1022+
This section allows you to configure Testplane's selective test execution, avoiding the launch of tests for which nothing has changed.
1023+
1024+
The section has the following parameters:
1025+
1026+
<table>
1027+
<thead>
1028+
<tr>
1029+
<td>**Parameter**</td>
1030+
<td>**Type**</td>
1031+
<td>**Default**</td>
1032+
<td>**Description**</td>
1033+
</tr>
1034+
</thead>
1035+
<tbody>
1036+
<tr>
1037+
<td>`enabled`</td>
1038+
<td>`boolean`</td>
1039+
<td>`false`</td>
1040+
<td>Enables selective test execution.</td>
1041+
</tr>
1042+
<tr>
1043+
<td>`sourceRoot`</td>
1044+
<td>`string`</td>
1045+
<td>`""`</td>
1046+
<td>Configures the path to the root of the source code files.</td>
1047+
</tr>
1048+
<tr>
1049+
<td>`testDependenciesPath`</td>
1050+
<td>`string`</td>
1051+
<td>`".testplane/selectivity"`</td>
1052+
<td>The path to the directory where test dependency data will be saved.</td>
1053+
</tr>
1054+
<tr>
1055+
<td>`compression`</td>
1056+
<td>`"none" | "gz" | "br" | "zstd"`</td>
1057+
<td>`"gz"`</td>
1058+
<td>The compression type applied to the test dependency data.</td>
1059+
</tr>
1060+
<tr>
1061+
<td>`disableSelectivityPatterns`</td>
1062+
<td>`string[]`</td>
1063+
<td>`[]`</td>
1064+
<td>
1065+
A list of patterns. If a file matching one of these patterns is changed, selectivity
1066+
will be disabled.
1067+
</td>
1068+
</tr>
1069+
</tbody>
1070+
</table>
1071+
1072+
<Admonition type="info">
1073+
You should not specify `node_modules` in `disableSelectivityPatterns`, as this will cause a
1074+
significant slowdown. Instead, it is recommended to specify Testplane configuration files and
1075+
the application's backend source code.
1076+
</Admonition>
1077+
10201078
[desired-caps]: https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities
10211079
[html-reporter]: ../../html-reporter/html-reporter-setup
10221080
[got]: https://github.com/sindresorhus/got/

i18n/ru/docusaurus-plugin-content-docs/current/config/browsers.mdx

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1025,6 +1025,63 @@ export = {
10251025
};
10261026
```
10271027

1028+
## Selectivity {#selectivity}
1029+
1030+
Эта секция позволяет конфигурировать селективность запуска Testplane, избегая запуска тех тестов, для которых ничего не поменялось.
1031+
1032+
Секция имеет следующие параметры:
1033+
1034+
<table>
1035+
<thead>
1036+
<tr>
1037+
<td>**Параметр**</td>
1038+
<td>**Тип**</td>
1039+
<td>**По&nbsp;умолчанию**</td>
1040+
<td>**Описание**</td>
1041+
</tr>
1042+
</thead>
1043+
<tbody>
1044+
<tr>
1045+
<td>`enabled`</td>
1046+
<td>`boolean`</td>
1047+
<td>`false`</td>
1048+
<td>Включает селективность запуска тестов.</td>
1049+
</tr>
1050+
<tr>
1051+
<td>`sourceRoot`</td>
1052+
<td>`string`</td>
1053+
<td>`""`</td>
1054+
<td>Конфигурирует путь к корню файлов исходного кода.</td>
1055+
</tr>
1056+
<tr>
1057+
<td>`testDependenciesPath`</td>
1058+
<td>`string`</td>
1059+
<td>`".testplane/selectivity"`</td>
1060+
<td>Путь к директории, куда будут сохраняться данные о зависимостях тестов.</td>
1061+
</tr>
1062+
<tr>
1063+
<td>`compression`</td>
1064+
<td>`"none" | "gz" | "br" | "zstd"`</td>
1065+
<td>`"gz"`</td>
1066+
<td>Тип сжатия, применяемый к данным о зависимостях тестов.</td>
1067+
</tr>
1068+
<tr>
1069+
<td>`disableSelectivityPatterns`</td>
1070+
<td>`string[]`</td>
1071+
<td>`[]`</td>
1072+
<td>
1073+
Список паттернов, при изменении файлов по которым селективность должна отключаться.
1074+
</td>
1075+
</tr>
1076+
</tbody>
1077+
</table>
1078+
1079+
<Admonition type="info">
1080+
В `disableSelectivityPatterns` не стоит указывать `node_modules` - это приведет к ощутимому
1081+
замедлению. Вместо этого, рекомендуется указать конфигурационные файлы Testplane и исходный код
1082+
серверной части приложения.
1083+
</Admonition>
1084+
10281085
[desired-caps]: https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities
10291086
[html-reporter]: ../../html-reporter/html-reporter-setup
10301087
[got]: https://github.com/sindresorhus/got/

0 commit comments

Comments
 (0)