Source: https://playwright.dev/python/docs/ci-intro

Skip to main content

On this page

Introduction​

---

Playwright tests can be run on any CI provider. In this section we 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​

• How to set up GitHub Actions

• How to view test logs

• How to view the trace

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 run on each push and pull request for the main/master branch.

.github/workflows/playwright.yml

name: Playwright Testson:  push:    branches: [ main, master ]  pull_request:    branches: [ main, master ]jobs:  test:    timeout-minutes: 60    runs-on: ubuntu-latest    steps:    - uses: actions/checkout@v5    - name: Set up Python      uses: actions/setup-python@v6      with:        python-version: '3.13'    - name: Install dependencies      run: |        python -m pip install --upgrade pip        pip install -r requirements.txt    - name: Ensure browsers are installed      run: python -m playwright install --with-deps    - name: Run your tests      run: pytest --tracing=retain-on-failure    - uses: actions/upload-artifact@v4      if: ${{ !cancelled() }}      with:        name: playwright-traces        path: test-results/

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.

Opening the Workflows​

---

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

​

Viewing Test Logs​

---

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

​

Viewing the Trace​

---

trace.playwright.dev is a statically hosted variant of the Trace Viewer. You can upload trace files using drag and drop.

Properly handling Secrets​

---

Artifacts like trace files or console logs contain information about your test execution. They can contain sensitive data like user credentials for a test user, access tokens to a staging backend, testing source code, or sometimes even your application source code. Treat these files just as carefully as you treat that sensitive data. If you upload reports and traces as part of your CI workflow, make sure that you only upload them to trusted artifact stores, or that you encrypt the files before upload. The same is true for sharing artifacts with team members: Use a trusted file share or encrypt the files before sharing.

What's Next​

---

• Learn how to use Locators

• Learn how to perform Actions

• Learn how to write Assertions

• Learn more about the Trace Viewer

• Learn more ways of running tests on GitHub Actions

• Learn more about running tests on other CI providers

• Introduction

• Setting up GitHub Actions

• Create a Repo and Push to GitHub

• Opening the Workflows

• Viewing Test Logs

• Viewing the Trace

• Properly handling Secrets

• What's Next