diff --git a/docs/ci.md b/docs/ci.md index 6c2ec77828..9e8634a3a9 100644 --- a/docs/ci.md +++ b/docs/ci.md @@ -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. -#### Contents -- [Docker](#docker) + - [GitHub Actions](#github-actions) +- [Docker](#docker) - [Azure Pipelines](#azure-pipelines) - [Travis CI](#travis-ci) - [CircleCI](#circleci) - [AppVeyor](#appveyor) + 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. -
+## 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 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 For Windows or macOS agents, no additional configuration required, just install Playwright and run your tests. @@ -38,4 +46,4 @@ We run our tests on CircleCI, with our [pre-built Docker image](docker/README.md ## AppVeyor -We run our tests on Windows agents in AppVeyor. Use our [AppVeyor configuration](/.appveyor.yml) to create your own. +We run our tests on Windows agents in AppVeyor. Use our [AppVeyor configuration](/.appveyor.yml) to create your own. \ No newline at end of file