Skip to content

Commit

Permalink
Update CONFIGURATION.md
Browse files Browse the repository at this point in the history
  • Loading branch information
anurgalieva authored and tsvetta committed Mar 31, 2022
1 parent 0f6af97 commit 92bf9ef
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions docs/CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,30 +138,27 @@ Id браузера можно задать в файле `e2e-tools.json`:

Если указать `"slackChannel": "<channel-id>"`, то результат прогона будет отправляться в слак. ID канала можно найти в его настройках ([видеоинструкция](https://s.csssr.ru/U09LGPMEU/20210709142250.mp4)).

Способа запуска три:

1. Запуск по расписанию. Время запуска определяется строкой в формате CRON: `0 9 * * *`. Кастомизировать её удобно при помощи сайта [crontab.guru](https://crontab.guru/#0_9_*_*_*).
#### 1. Запуск по расписанию.
Время запуска определяется строкой в формате CRON: `0 9 * * *`. Кастомизировать её удобно при помощи сайта [crontab.guru](https://crontab.guru/#0_9_*_*_*).

```json
"event": {
"schedule": [{ "cron": "0 9 * * *" }]
}
```

2. Запуск при успешном деплое. Такой запуск работает только для тестовых стендов и только для деплоев при помощи [куберты](https://kuberta.csssr.cloud)

#### 2. Запуск при успешном деплое.
Такой запуск работает только для тестовых стендов и только для деплоев при помощи [куберты](https://kuberta.csssr.cloud)
```json
"customEvent": "successful-deploy",
```

Если указать в качестве URL в параметре `urls` значение `"{{url}}"`, то тесты будут запускаться на всех стендах, которые создаются в рамках Pull Request. В качестве URL будет использоваться URL стенда.

*Можно запускать тесты на всех созданных стендах, если указать параметр {{url}}. В качестве URL будет использоваться URL стенда.*
```json
"urls": ["{{url}}"],
```

3. Запуск при успешном деплое. Только для деплоев при помощи GitHub Actions

#### 3. Запуск при успешном деплое.
Только для деплоев при помощи GitHub Actions
```json
"event": {
"workflow_run": {
Expand All @@ -176,10 +173,11 @@ Id браузера можно задать в файле `e2e-tools.json`:

Для того, чтобы изменить ветку репозитория, тесты из которой будут использоваться, необходимо задать опцию `testsBranch`.

Если тип события соответствует `"customEvent": "successful-deploy"`, то в `testsBranch` можно использовать шаблон `{{branch}}`.

В таком случае будут использоваться тесты из ветки самого стенда.

Использование тестов из ветки самого стенда доступно для события `"customEvent": "successful-deploy"`, необходимо указать `{{branch}}`.
```json
"testsBranch": "{{branch}}",
```
#### Пример
```json
"periodicRuns": [
{
Expand All @@ -200,8 +198,6 @@ Id браузера можно задать в файле `e2e-tools.json`:

В таком случае при автоматическом запуске будут использоваться тесты из ветки,указанной в конфигурационном файле. При ручном запуске будут использоваться тесты из ветки, которая была указана в `Run workflow`.

Также все переодичные запуски можно запустить вручную с вкладки «Actions» в репозитории.

Каждый URL, указанный в `urls` и каждая команда, указанная в `commands`, создаёт отдельный файл, который можно запустить независимо.

Тесты не запускаются параллельно — если на момент запуска тестов другой запуск ещё идёт, то запуск попадёт в очередь и будет выполнен, когда первый запуск закончится
Expand Down

0 comments on commit 92bf9ef

Please sign in to comment.