Skip to content

Commit 87bbf1b

Browse files
docs: provide gh-action example using all input parameters
1 parent 0e5a562 commit 87bbf1b

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

docs/guides/how-to-run-on-github.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,26 @@ The "gemini-testing/gh-actions-testplane" action supports the following paramete
141141
</tbody>
142142
</table>
143143
144+
<details>
145+
<summary>Example action with Testplane run using all parameters</summary>
146+
147+
```yml
148+
- name: Run Comprehensive Testplane Suite
149+
id: testplane
150+
uses: gemini-testing/gh-actions-testplane@v1
151+
with:
152+
cwd: "projects/my-project-name" # Specify project path (for monorepos)
153+
package-manager: "yarn" # Use yarn instead of npm
154+
html-report-prefix: "reports/testplane" # Save reports to existing reports directory (for preserving reports on gh-pages)
155+
config-path: "configs/testplane.conf.js" # Use custom config path
156+
storybook: "true" # Run tests from `@testplane/storybook` plugin
157+
set: "smoke,regression" # Run only selected test sets
158+
browser: "linux-chrome,linux-firefox" # Run tests in two browsers only
159+
grep: "Login" # Run only tests containing 'Login' in their name
160+
```
161+
162+
</details>
163+
144164
To modify default parameters, pass values in the `with` section. For example, to run Testplane in a monorepo subdirectory:
145165

146166
```yml

i18n/ru/docusaurus-plugin-content-docs/current/guides/how-to-run-on-github.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,26 @@ Action "gemini-testing/gh-actions-testplane" поддерживает следу
107107
</tbody>
108108
</table>
109109

110+
<details>
111+
<summary>Пример action с запуском Testplane со всеми параметрами</summary>
112+
113+
```yml
114+
- name: Run Comprehensive Testplane Suite
115+
id: testplane
116+
uses: gemini-testing/gh-actions-testplane@v1
117+
with:
118+
cwd: "projects/my-project-name" # Указываем путь до проекта (для монорепозиториев)
119+
package-manager: "yarn" # Используем yarn вместо npm
120+
html-report-prefix: "reports/testplane" # Сохраняем отчеты в имеющуюся директорию reports (для сохранения отчетов на gh-pages)
121+
config-path: "configs/testplane.conf.js" # Используем кастомный путь до конфига
122+
storybook: "true" # Запускаем тесты плагина `@testplane/storybook`
123+
set: "smoke,regression" # Запускаем только тесты выбранных сетов
124+
browser: "linux-chrome,linux-firefox" # Запускаем тесты только в двух браузерах
125+
grep: "Login" # Запускаем только тесты, в названии которых есть слово Login
126+
```
127+
128+
</details>
129+
110130
Изменить параметры по умолчанию можно, передав соответствующие значения в секции `with`.
111131
Например, для запуска Testplane в конкретной директории монорепозитория, можно передать значение `cwd` следующим образом:
112132

0 commit comments

Comments
 (0)