-
Notifications
You must be signed in to change notification settings - Fork 5
docs(quickstart): some improvements #125
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.
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
swordqueen
wants to merge
10
commits into
master
Choose a base branch
from
users/kseniataranov/DOCORG-6752.quickstart-ideas
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
78be5b4
docs: first priority changes draft
1fa9300
docs: add medium priority improvements to quickstart
3a051d1
docs: fix --grep examples
e120d7f
docs: add improvements
48c619c
docs(quickstart): simplify CI setup guide, focus on official action
2118a61
docs(quickstart): add improvements to running tests section
d5d99a2
docs(quickstart): add improvements
033cb1b
docs(quickstart): add improvements to index ans wrighting tests section
006b99f
docs(quickstart): fix running-tests
eaa7dd5
docs(quickstart): remove ё
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,53 @@ | ||
| --- | ||
| sidebar_position: 4 | ||
| draft: true | ||
| --- | ||
|
|
||
| # Usage in CI | ||
|
|
||
| Testplane can be easily integrated into any CI system. For GitHub Actions, we recommend using the official action [gemini-testing/gh-actions-testplane](https://github.com/gemini-testing/gh-actions-testplane), which automatically caches browsers and generates reports. | ||
|
|
||
| ## GitHub Actions Setup | ||
|
|
||
| Create a `.github/workflows/testplane.yml` file in your repository root: | ||
|
|
||
| ```yaml title=".github/workflows/testplane.yml" | ||
| name: Testplane Tests | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main, master] | ||
| pull_request: | ||
| branches: [main, master] | ||
|
|
||
| jobs: | ||
| test: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: "20" | ||
| cache: "npm" | ||
|
|
||
| - run: npm ci | ||
|
|
||
| - uses: gemini-testing/gh-actions-testplane@v1 | ||
| with: | ||
| browser: "chrome,firefox" # Optional: list of browsers | ||
| ``` | ||
|
|
||
| ## Additional Features | ||
|
|
||
| The action supports additional configuration parameters: | ||
|
|
||
| - `config-path` — path to config file (default: `testplane.config.ts`) | ||
| - `set` — run specific test sets | ||
| - `grep` — filter tests by pattern | ||
| - `storybook` — integration with [@testplane/storybook](https://github.com/gemini-testing/testplane-storybook) | ||
|
|
||
| For more details on parameters and advanced usage scenarios, see the [GitHub Actions setup guide](../guides/how-to-run-on-github.mdx). | ||
|
|
||
| ## Other CI Systems | ||
|
|
||
| For more details on configuring Testplane for other CI systems, refer to the [configuration documentation](../reference/config/main.mdx). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.