Skip to content

docs: add selectivity config docs #104

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add selectivity config docs #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
58 changes: 58 additions & 0 deletions docs/config/browsers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1017,6 +1017,64 @@ export = {
};
```

## Selectivity {#selectivity}

This section allows you to configure Testplane's selective test execution, avoiding the launch of tests for which nothing has changed.

The section has the following parameters:

<table>
<thead>
<tr>
<td>**Parameter**</td>
<td>**Type**</td>
<td>**Default**</td>
<td>**Description**</td>
</tr>
</thead>
<tbody>
<tr>
<td>`enabled`</td>
<td>`boolean`</td>
<td>`false`</td>
<td>Enables selective test execution.</td>
</tr>
<tr>
<td>`sourceRoot`</td>
<td>`string`</td>
<td>`""`</td>
<td>Configures the path to the root of the source code files.</td>
</tr>
<tr>
<td>`testDependenciesPath`</td>
<td>`string`</td>
<td>`".testplane/selectivity"`</td>
<td>The path to the directory where test dependency data will be saved.</td>
</tr>
<tr>
<td>`compression`</td>
<td>`"none" | "gz" | "br" | "zstd"`</td>
<td>`"gz"`</td>
<td>The compression type applied to the test dependency data.</td>
</tr>
<tr>
<td>`disableSelectivityPatterns`</td>
<td>`string[]`</td>
<td>`[]`</td>
<td>
A list of patterns. If a file matching one of these patterns is changed, selectivity
will be disabled.
</td>
</tr>
</tbody>
</table>

<Admonition type="info">
You should not specify `node_modules` in `disableSelectivityPatterns`, as this will cause a
significant slowdown. Instead, it is recommended to specify Testplane configuration files and
the application's backend source code.
</Admonition>

[desired-caps]: https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities
[html-reporter]: ../../html-reporter/html-reporter-setup
[got]: https://github.com/sindresorhus/got/
Expand Down
57 changes: 57 additions & 0 deletions i18n/ru/docusaurus-plugin-content-docs/current/config/browsers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1025,6 +1025,63 @@ export = {
};
```

## Selectivity {#selectivity}

Эта секция позволяет конфигурировать селективность запуска Testplane, избегая запуска тех тестов, для которых ничего не поменялось.

Секция имеет следующие параметры:

<table>
<thead>
<tr>
<td>**Параметр**</td>
<td>**Тип**</td>
<td>**По&nbsp;умолчанию**</td>
<td>**Описание**</td>
</tr>
</thead>
<tbody>
<tr>
<td>`enabled`</td>
<td>`boolean`</td>
<td>`false`</td>
<td>Включает селективность запуска тестов.</td>
</tr>
<tr>
<td>`sourceRoot`</td>
<td>`string`</td>
<td>`""`</td>
<td>Конфигурирует путь к корню файлов исходного кода.</td>
</tr>
<tr>
<td>`testDependenciesPath`</td>
<td>`string`</td>
<td>`".testplane/selectivity"`</td>
<td>Путь к директории, куда будут сохраняться данные о зависимостях тестов.</td>
</tr>
<tr>
<td>`compression`</td>
<td>`"none" | "gz" | "br" | "zstd"`</td>
<td>`"gz"`</td>
<td>Тип сжатия, применяемый к данным о зависимостях тестов.</td>
</tr>
<tr>
<td>`disableSelectivityPatterns`</td>
<td>`string[]`</td>
<td>`[]`</td>
<td>
Список паттернов, при изменении файлов по которым селективность должна отключаться.
</td>
</tr>
</tbody>
</table>

<Admonition type="info">
В `disableSelectivityPatterns` не стоит указывать `node_modules` - это приведет к ощутимому
замедлению. Вместо этого, рекомендуется указать конфигурационные файлы Testplane и исходный код
серверной части приложения.
</Admonition>

[desired-caps]: https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities
[html-reporter]: ../../html-reporter/html-reporter-setup
[got]: https://github.com/sindresorhus/got/
Expand Down