Requirements
- Access to a QA Wolf workspace with at least one environment configured
- Node.js 18 or later in your CI environment
- Admin access to your CI system’s secret or environment variable storage
How to connect QA Wolf to your CI system
1
Add the QAWOLF_API_KEY secret
Store your QA Wolf API key as a secret named
QAWOLF_API_KEY in your CI system.2
Add the notify script to your repository
Create Replace
.ci/notifyQaWolf.mjs in the repository that corresponds to the deployments QA Wolf will be testing.GIT_COMMIT_SHA and GIT_BRANCH with the variable names your CI system provides for the current commit SHA and branch, and deploymentType with the value your QA Wolf representative provides. Set hostingService to where your code is hosted, not where your pipeline runs.3
Run the notify script in your pipeline
Add a step that runs after your deployment is healthy.
4
Verify the integration
Trigger your CI pipeline with a new deployment. Confirm the notify step completes without errors, and that a new run appears in QA Wolf under the expected environment.