Skip to main content
To proceed in this guide, you need:
  • Access to your QA Wolf team.
  • Admin access to your GitHub repository.
QA Wolf integrates directly with GitHub to automatically run tests when you deploy code. This integration uses GitHub Actions (GHA) to notify QA Wolf of new deployments. Almost every GitHub organization can use it, including private repos and GitHub Enterprise Cloud.
You cannot use GitHub Actions if your team:
  • Self-hosts GitHub Enterprise Server without internet access.
  • Explicitly disables GitHub Actions by policy.
If either applies, see the SDK Integration Guide for an alternative.

​
How to integrate QA Wolf and GitHub Actions

1
Open the Workspace name dropdown in QA Wolf and click Workspace Settings.
2
Choose Integrations and then click Enable next to GitHub. This opens GitHub, where you’ll be prompted to sign in if you have not already done so.
Your user cannot be a member of multiple GitHub orgs.
3
Choose the repositories QA Wolf should access.
4
Click Install. Once installed, QA Wolf can create PR comments.
5
Return to QA Wolf Integrations, and generate your QAWOLF_API_KEY by clicking the icon to the right of API Key under API Access.
6
Return to GitHub, go to your repository’s Settings tab, click Secrets and variables, and then Actions.
7
Type QAWOLF_API_KEY in Name and paste the value you copied above into Secret.
8
Click Add secret to save.
This key allows your workflow to authenticate with QA Wolf when the Action runs.

​
How to install the action

QA Wolf’s official GitHub Action, Notify QA Wolf on Deploy, will notify QA Wolf whenever a new deployment is ready for testing.
This must be done for every repository you want connected to CI/CD.
1
Open your repository on GitHub. Click the Actions tab.
2
If you already have actions, you can click New workflow.
3
Choose Set up a workflow yourself.
4
Copy the example below into your workflow file (usually .github/workflows/deploy.yml). Replace the values in deployment-type and deployment-url with your actual values.To get the value for deployment-type, reach out to QA Wolf, and we will provide this value for you.
- name: Notify QA Wolf
  uses: qawolf/notify-qawolf-on-deploy-action@v1
  with:
    qawolf-api-key: ${{ secrets.QAWOLF_API_KEY }}
    deployment-type: "staging"
    deployment-url: "https://staging.example.com"

​
Validating the action

1
Push a new commit to your main branch. Wait for your deployment to complete.
2
Check your Runs tab in the QA Wolf app. If everything is working correctly, you should see a new run created for that environment.
Last modified on April 3, 2026