Filip/playwright
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs(ci): update ci docs to emphasize gh action (#1964)

Browse source
This commit is contained in:
Arjun Attam 2020-04-24 12:19:54 -07:00 committed by GitHub
parent 28f98ac278
commit 8ceba1eea0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/ci.md
View file

@ -1,27 +1,35 @@
# Continuous integration # Continuous Integration
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. 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.
#### Contents <!-- GEN:toc -->
- [Docker](#docker)
- [GitHub Actions](#github-actions) - [GitHub Actions](#github-actions)
- [Docker](#docker)
- [Azure Pipelines](#azure-pipelines) - [Azure Pipelines](#azure-pipelines)
- [Travis CI](#travis-ci) - [Travis CI](#travis-ci)
- [CircleCI](#circleci) - [CircleCI](#circleci)
- [AppVeyor](#appveyor) - [AppVeyor](#appveyor)
<!-- GEN:stop -->
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. 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.
<br/> ## GitHub Actions
The [Playwright GitHub Action](https://github.com/microsoft/playwright-github-action) can be used to run Playwright tests on GitHub Actions.
```yml
steps:
- uses: microsoft/playwright-github-action@v1
- name: Run your tests
run: npm test
```
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).
## Docker ## Docker
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. 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.
## GitHub Actions
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.
## Azure Pipelines ## Azure Pipelines
For Windows or macOS agents, no additional configuration required, just install Playwright and run your tests. For Windows or macOS agents, no additional configuration required, just install Playwright and run your tests.