Skip to content

Commit 3eec2d0

Browse files
authored
docs(ci): list sample configurations for ci (#1196)
Has some overlaps with the troubleshooting doc, which I plan to clean up in a subsequent PR. This first version of the doc has a feel of "build-your-own" with our sample configurations. Over time we can tweak the level of hand-holding for the best user experience to get started with CI. Fixes #1103
1 parent ce3398b commit 3eec2d0

File tree

3 files changed

+40
-1
lines changed

3 files changed

+40
-1
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -181,4 +181,5 @@ Playwright is being actively developed as we get to the feature parity across Ch
181181
## Resources
182182

183183
* [API documentation](docs/api.md)
184+
* [Getting started on CI](docs/ci.md)
184185
* [Community showcase](docs/showcase.md)

docs/ci.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Getting started on CI
2+
3+
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.
4+
5+
- [Docker](#docker)
6+
- [GitHub](#github-actions)
7+
- [Azure Pipelines](#azure-pipelines)
8+
- [Travis CI](#travis-ci)
9+
- [CircleCI](#circleci)
10+
- [AppVeyor](#appveyor)
11+
12+
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.
13+
14+
## Docker
15+
16+
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.
17+
18+
## GitHub Actions
19+
20+
We run our tests on GitHub Actions, across a matrix of 3 platforms (Windows, Linux, macOS) and 3 browsers (Chromium, Firefox, WebKit). Use our [Actions configuration](/.github/workflows/tests.yml) to bootstrap your own.
21+
22+
## Azure Pipelines
23+
24+
For Windows or macOS agents, no additional configuration required, just install Playwright and run your tests.
25+
26+
For Linux agents, refer to [our Docker setup](docker/README.md) to see additional dependencies that need to be installed.
27+
28+
## Travis CI
29+
30+
We run our tests on Travis CI over a Linux agent (Ubuntu 18.04). Use our [Travis configuration](/.travis.yml) to see list of additional dependencies to be installed.
31+
32+
## CircleCI
33+
34+
We run our tests on CircleCI, with our [pre-built Docker image](docker/README.md). Use our [CircleCI configuration](/.circleci/config.yml) to create your own.
35+
36+
## AppVeyor
37+
38+
We run our tests on Windows agents in AppVeyor. Use our [AppVeyor configuration](/.appveyor.yml) to create your own.

docs/docker/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Running Playwright in Docker
22

3-
`Dockerfile.bionic` is a playwright-ready image of playwright.
3+
[Dockerfile.bionic](Dockerfile.bionic) is a playwright-ready image of playwright.
44
This image includes all the dependencies needed to run browsers in a Docker
55
container.
66

0 commit comments

Comments
 (0)