CircleCI

A CircleCI pipeline tells QA Wolf about a deploy in one of two ways. Both are supported, and which one fits depends on where your repository lives.

Report the deploy from CircleCI

The direct route: a job that runs after your deploy succeeds and reports it to QA Wolf. This works whatever your code host is. Add QAWOLF_API_KEY and QAWOLF_WORKSPACE_ID under Project Settings → Environment Variables, then add the job to .circleci/config.yml. Example:

jobs:
  notify-qa-wolf:
    docker:
      - image: cimg/base:current
    steps:
      - run:
          name: Report the deploy to QA Wolf
          command: |
            curl -X POST "https://app.qawolf.com/api/trpc/public.deployment.reportStatus" \
              -H "Authorization: Bearer $QAWOLF_API_KEY" \
              -H "Content-Type: application/json" \
              -d "{
                \"json\": {
                  \"workspaceId\": \"$QAWOLF_WORKSPACE_ID\",
                  \"providerDeploymentId\": \"$CIRCLE_WORKFLOW_ID\",
                  \"status\": \"success\",
                  \"environment\": { \"name\": \"staging\" },
                  \"deployTarget\": \"https://staging.example.com\",
                  \"metadata\": {
                    \"commitSha\": \"$CIRCLE_SHA1\",
                    \"ref\": \"$CIRCLE_BRANCH\",
                    \"repository\": \"$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME\"
                  }
                }
              }"

workflows:
  build-deploy-test:
    jobs:
      - notify-qa-wolf:
          requires:
            - deploy

CIRCLE_WORKFLOW_ID is stable for one workflow run, so a retried job reports the same deployment rather than a second one. Webhook documents every field the report carries.

Let your code host record the deploy instead

If your repository is on GitHub or GitLab, a CircleCI job can create the code host’s own deployment, and QA Wolf picks it up through the connected integration. Nothing in the job talks to QA Wolf at all.

GitHub — the job calls POST /repos/{owner}/{repo}/deployments with the ref it deployed, then marks the result with a deployment status.
GitLab — CircleCI is not running the pipeline GitLab records deployments from, so the deploy has to move into a GitLab deployment job for this route to apply. Otherwise report it from CircleCI as above.

The code-host route is worth the extra step when you want the deploy visible in your code host as well, and when you want QA Wolf to resolve the pull request from the commit rather than from what the job declares. See GitHub deployments and GitLab deployments.

Create a trigger

Either route produces a deployment. A trigger is what turns it into a run — see Set up a trigger.

CI/CD

VPN

Test Management Systems

Issue Trackers

Communication

Legacy triggers

Report the deploy from CircleCI

Let your code host record the deploy instead

Create a trigger

​Report the deploy from CircleCI

​Let your code host record the deploy instead

​Create a trigger

Report the deploy from CircleCI

Let your code host record the deploy instead

Create a trigger