Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.qawolf.com/llms.txt

Use this file to discover all available pages before exploring further.

If your repositories are hosted on GitHub.com or GitHub Enterprise Cloud, this is the recommended setup. The integration connects directly to your QA Wolf environments using GitHub Actions to notify QA Wolf of new deployments.
If your team self-hosts GitHub Enterprise Server without internet access, or has disabled GitHub Actions by policy, use the QA Wolf CI SDK instead.
Make sure you have:
  • Access to your QA Wolf workspace
  • Admin access to your GitHub repository

​
Enable the GitHub integration in QA Wolf

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.

​
Find the QAWOLF_API_KEY

1
Open the Workspace name dropdown in QA Wolf and click Workspace Settings.
2
Choose Integrations.
3
Generate your QAWOLF_API_KEY by clicking the icon to the right of API Key under API Access.

​
Add the QAWOLF_API_KEY secret

1
Return to GitHub, go to your repository’s Settings tab, click Secrets and variables, and then Actions.
2
Type QAWOLF_API_KEY in Name and paste your API key into Secret.
3
Click Add secret to save.
This key allows your workflow to authenticate with QA Wolf when the Action runs.

​
Add the GitHub Actions workflow

QA Wolf’s official GitHub Action, Notify QA Wolf on Deploy, notifies 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, 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"

​
Verify the integration

1
Push a new commit to your main branch and wait for your deployment to complete.
2
Open QA Wolf and confirm a new run appears under the expected environment.
Last modified on May 18, 2026