This is a GitHub Action for PR testing with QA Wolf. It is intended to be used in a workflow that runs after a deployment action. It will execute your QA Wolf end-to-end test run on the deployed environment.
ℹ️ Read our introduction to PR Testing to get familiar with core concepts.
Required. The QA Wolf API key. You can find your API key on the QA Wolf settings page.
Required. A JSON-formatted array that defines the relationships between QA Wolf environments and Version Control System (VCS) branches. QA Wolf environment identifiers are called "environment aliases" and can be retrieved from the "General" tab on the environment settings page in QA Wolf. The recommended format for an environment alias is <organization-name>/<repo-name>/<branch-name>.
In this example, the mapping indicates that the "develop" QA Wolf environment corresponds to the "main" VCS branch:
[{ "environmentAlias": "develop", "vcsBranch": "main" }]Required. JSON-formatted environment variables including deployment locations. Get help from a QA Wolf representative to determine which variables will be required here, as each customer has its own deployment layout.
In this example, the JSON object indicates that QA Wolf can reach your deployed environment at https://pr-9888.preview.myapp.io:
{
"URL": "https://pr-9888.preview.myapp.io"
}A positive number representing the maximum number of concurrent workflows that can be executed at once. It will default to the concurrency limit defined in the base environment. If you are unsure about this value, you can leave it empty.
The Github Token, automatically created by Github. Required if trigger actions is deployment_status.
GitHub Docs: pull_request events
name: Deploy and Test Preview Environment
# It is a requirement that the qawolf/pr-testing-notify-build-deployed-action
# is triggered with pull_request, pull_request_target or deployment_status events exclusively.
# Note that by default, pull_request will subscribe only to the following
# actions: 'opened', 'synchronize' and 'reopened'.
on: pull_request
jobs:
deploy-preview-environmnent:
# This job MUST output JSON-formatted environment-variables. The dependency
# is expressed in the trigger-pr-testing job below
# (steps[0].with.environment-variables)
name: Your custom job to deploy a preview environment
uses: ./your-custom-action
wait-for-deployment:
name: Your custom job to wait for the deployed environment to be ready
uses: ./your-custom-action
trigger-pr-testing:
needs: deploy-preview-environmnent
name: Trigger QA Wolf PR testing
runs-on: ubuntu-latest
steps:
- name: Test preview environment
if: ${{
(github.event_name == 'pull_request' || github.event_name == 'pull_request_target')
&& github.action != 'closed'
}}
uses: qawolf/pr-testing-request-new-run-after-deploy-action@v1
with:
qawolf-api-key: "${{ secrets.QAWOLF_API_KEY }}"
# Requires the previous step to output JSON-formatted environment variables
head-environment-variables: ${{ needs.deploy-preview-environmnent.outputs.environment-variables }}
# A typical Gitflow mapping. This is very dependent on your branching
# and release models.
base-environments-mapping: |
[
{ "environmentAlias": "develop", "vcsBranch": "develop" },
{ "environmentAlias": "production", "vcsBranch": "main" }
]name: Deploy and Test Preview Environment
on:
pull_request:
# Don’t run when opening a PR. If a PR is opened with a label already attached,
# GitHub triggers two runs: one for “opened” and another for “labeled”
types: [labeled, reopened, synchronize]
jobs:
deploy-preview-environmnent:
name: Your custom job to deploy a preview environment
uses: ./your-custom-action
wait-for-deployment:
name: Your custom job to wait for the deployed environment to be ready
uses: ./your-custom-action
trigger-pr-testing:
needs: deploy-preview-environmnent
name: Trigger QA Wolf PR testing
runs-on: ubuntu-latest
steps:
- name: Test preview environment
# Restrict the if condition to only be satisfied when the pr-testing label is applied.
if: ${{
contains(github.event.pull_request.labels.*.name, 'pr-testing')
}}
uses: qawolf/pr-testing-request-new-run-after-deploy-action@v1
with:
qawolf-api-key: "${{ secrets.QAWOLF_API_KEY }}"
head-environment-variables: ${{ needs.deploy-preview-environmnent.outputs.environment-variables }}
base-environments-mapping: |
[
{ "environmentAlias": "develop", "vcsBranch": "develop" },
{ "environmentAlias": "production", "vcsBranch": "main" }
]name: Deploy and Test Preview Environment
on:
pull_request:
types: [ready_for_review, reopened, synchronize]
jobs:
deploy-preview-environmnent:
name: Your custom job to deploy a preview environment
uses: ./your-custom-action
wait-for-deployment:
name: Your custom job to wait for the deployed environment to be ready
uses: ./your-custom-action
trigger-pr-testing:
needs: deploy-preview-environmnent
name: Trigger QA Wolf PR testing
runs-on: ubuntu-latest
steps:
- name: Test preview environment
if: ${{
((github.event_name == 'pull_request' || github.event_name == 'pull_request_target')
&& github.action != 'closed') && (
!github.event.pull_request.draft
)
}}
uses: qawolf/pr-testing-request-new-run-after-deploy-action@v1
with:
qawolf-api-key: "${{ secrets.QAWOLF_API_KEY }}"
head-environment-variables: ${{ needs.deploy-preview-environmnent.outputs.environment-variables }}
base-environments-mapping: |
[
{ "environmentAlias": "develop", "vcsBranch": "develop" },
{ "environmentAlias": "production", "vcsBranch": "main" }
]GitHub Docs: deployment_status events
name: Test Preview Environment
on: deployment_status
jobs:
trigger-pr-testing:
name: Trigger QA Wolf PR testing
runs-on: ubuntu-latest
steps:
- name: Test preview environment
# Only run the test preview if the deployment was successful
if: ${{ github.event.deployment_status.state == 'success' }}
uses: qawolf/pr-testing-request-new-run-after-deploy-action@v1
with:
qawolf-api-key: "${{ secrets.QAWOLF_API_KEY }}"
# Note that target_url is "The optional link added to the status.".
# If your vendor is not setting the target_url the action will not work.
# You can either contact your vendor or try to compose the URL by following your vendor documentation.
head-environment-variables: |
{
"URL": "${{ github.event.deployment_status.target_url }}"
}
# See above on how to create the base-environments-mapping
base-environments-mapping: |
[
{ "environmentAlias": "develop", "vcsBranch": "develop" },
{ "environmentAlias": "production", "vcsBranch": "main" }
]
secrets:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}