Skip to content

Commit 8ceba1e

Browse files
authored
docs(ci): update ci docs to emphasize gh action (#1964)
1 parent 28f98ac commit 8ceba1e

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

docs/ci.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,34 @@
1-
# Continuous integration
1+
# Continuous Integration
22

33
Playwright tests can be executed to run on your CI environments. To simplify this, we have created sample configurations for common CI providers that can be used to bootstrap your setup.
44

5-
#### Contents
6-
- [Docker](#docker)
5+
<!-- GEN:toc -->
76
- [GitHub Actions](#github-actions)
7+
- [Docker](#docker)
88
- [Azure Pipelines](#azure-pipelines)
99
- [Travis CI](#travis-ci)
1010
- [CircleCI](#circleci)
1111
- [AppVeyor](#appveyor)
12+
<!-- GEN:stop -->
1213

1314
Broadly, configuration on CI involves **ensuring system dependencies** are in place, **installing Playwright and browsers** (typically with `npm install`), and **running tests** (typically with `npm test`). Windows and macOS build agents do not require any additional system dependencies. Linux build agents can require additional dependencies, depending on the Linux distribution.
1415

15-
<br/>
16+
## GitHub Actions
1617

17-
## Docker
18+
The [Playwright GitHub Action](https://github.com/microsoft/playwright-github-action) can be used to run Playwright tests on GitHub Actions.
1819

19-
We have a [pre-built Docker image](docker/README.md) which can either be used directly, or as a reference to update your existing Docker definitions.
20+
```yml
21+
steps:
22+
- uses: microsoft/playwright-github-action@v1
23+
- name: Run your tests
24+
run: npm test
25+
```
2026
21-
## GitHub Actions
27+
We run [our tests](/.github/workflows/tests.yml) on GitHub Actions, across a matrix of 3 platforms (Windows, Linux, macOS) and 3 browsers (Chromium, Firefox, WebKit).
28+
29+
## Docker
2230
23-
We run [our tests](/.github/workflows/tests.yml) on GitHub Actions, across a matrix of 3 platforms (Windows, Linux, macOS) and 3 browsers (Chromium, Firefox, WebKit). Use the [microsoft/playwright-github-action](https://github.com/microsoft/playwright-github-action) to bootstrap your GitHub Actions configuration.
31+
We have a [pre-built Docker image](docker/README.md) which can either be used directly, or as a reference to update your existing Docker definitions.
2432
2533
## Azure Pipelines
2634
@@ -38,4 +46,4 @@ We run our tests on CircleCI, with our [pre-built Docker image](docker/README.md
3846
3947
## AppVeyor
4048
41-
We run our tests on Windows agents in AppVeyor. Use our [AppVeyor configuration](/.appveyor.yml) to create your own.
49+
We run our tests on Windows agents in AppVeyor. Use our [AppVeyor configuration](/.appveyor.yml) to create your own.

0 commit comments

Comments
 (0)