<aside> ℹ️ See our Introduction to PR Testing to get familiar with the concepts required to understand the setup.

</aside>

1. Configure GitHub/GitLab Integration

Configure the GitHub/GitLab integration in the team’s settings page.

Untitled

2. Notify preview deployments

2.1 GitHub Action

Configure https://github.com/marketplace/actions/notify-qa-wolf-on-deploy to inform us when new preview environment deployments are released and are ready to be tested.

2.2 SDK

When GHAs are not an option, the @qawolf/ci-sdk npm package offers a flexible alternative. See the relevant documentation in this page: @qawolf/ci-sdk - VCS Branch Testing.

3. Migrating to Simple PR Testing

What is changing?

In the previous behavior, every time a new version of the PR preview app was created, a new E2E test was automatically triggered. This resulted in many undesired E2E tests, as the PR owner might have been merely pushing code to the PR branch and not yet ready to run the E2E tests.

With the new behavior, the PR owner has control over when to run the E2E tests by using a PR comment button, as shown in the image below:

image.png

<aside> ℹ️

You can still add GitHub checks to ensure that a PR can only be merged after the E2E tests pass.

</aside>

Reach out to a QAE representative and let them know you want to migrate to Simple PR Testing. Some trigger changes are required. Once those changes are made by the QAE, update our action as shown below.

Before

- name: Test preview environment
  uses: qawolf/pr-testing-request-new-run-after-deploy-action@main
  with:
      qawolf-api-key: ${{ secrets.QA_WOLF_API_KEY }}
      head-environment-variables: |
      {
          "URL": "<http://your-deployment-url.com>"

After