Skip to main content

Setting up CI

Introduction​

Playwright tests can be run on any CI provider. In this section we will cover running tests on GitHub using GitHub actions. If you would like to see how to configure other CI providers check out our detailed doc on Continuous Integration.

You will learn​

Setting up GitHub Actions​

To add a GitHub Actions file first create .github/workflows folder and inside it add a playwright.yml file containing the example code below so that your tests will run on each push and pull request for the main/master branch.

.github/workflows/playwright.yml
name: Playwright Tests
on:
  push:
    branches: [ main, master ]
  pull_request:
    branches: [ main, master ]
jobs:
  test:
    timeout-minutes: 60
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v4
    - name: Setup dotnet
      uses: actions/setup-dotnet@v4
      with:
        dotnet-version: 8.0.x
    - name: Build & Install
      run: dotnet build
    - name: Ensure browsers are installed
      run: pwsh bin/Debug/net8.0/playwright.ps1 install --with-deps
    - name: Run your tests
      run: dotnet test

To learn more about this, see "Understanding GitHub Actions".

Looking at the list of steps in jobs.test.steps, you can see that the workflow performs these steps:

  1. Clone your repository
  2. Install language dependencies
  3. Install project dependencies and build
  4. Install Playwright Browsers
  5. Run tests

Create a Repo and Push to GitHub​

Once you have your GitHub actions workflow setup then all you need to do is Create a repo on GitHub or push your code to an existing repository. Follow the instructions on GitHub and don't forget to initialize a git repository using the git init command so you can add, commit and push your code.

dotnet repo on github

Opening the Workflows​

Click on the Actions tab to see the workflows. Here you will see if your tests have passed or failed.

​

opening the workflow

On Pull Requests you can also click on the Details link in the PR status check.

pr status checked

Viewing Test Logs​

Clicking on the workflow run will show you the all the actions that GitHub performed and clicking on Run Playwright tests will show the error messages, what was expected and what was received as well as the call log.

​

viewing the test logs

Viewing the Trace​

You can upload Traces which get created on your CI like GitHub Actions as artifacts. This requires starting and stopping the trace. We recommend only recording traces for failing tests. Once your traces have been uploaded to CI, they can then be downloaded and opened using trace.playwright.dev, which is a statically hosted variant of the Trace Viewer. You can upload trace files using drag and drop.

​

playwright trace viewer

What's Next​