qawolf · mintlify · Jun 22, 2026
diff --git a/qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx b/qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx
@@ -1,20 +1,21 @@
 ---
 title: "Integrate a mobile build with Fastlane"
+description: "Upload Android and iOS build artifacts and trigger QA Wolf test runs from your existing Fastlane lanes using the QA Wolf plugin."
 sidebarTitle: "Fastlane"
 ---
 
 ## When to use Fastlane

 This guide is for teams that already use Fastlane to build Android or iOS apps. If your mobile builds are defined as Fastlane lanes, the QA Wolf Fastlane plugin lets you upload build artifacts and trigger test runs within your existing mobile automation. This is the recommended option for mobile teams that use Fastlane today.

 If you do not use Fastlane, use the QA Wolf CI SDK instead. QA Wolf does not set up Fastlane or create build lanes—this guide assumes Fastlane is already installed and that it is producing a mobile build artifact.

 ## Before you begin

 Before configuring the Fastlane integration, make sure you have the following in place:

 - A working Fastlane setup for your Android or iOS app.
 - A Fastlane lane that produces a mobile build artifact (APK, AAB, or IPA).
 - A QA Wolf API key stored as a secret in your CI environment.
 - Artifact naming conventions are defined for your environments. See [Artifact naming conventions](#artifact-naming-conventions) below.

@@ -27,9 +28,9 @@

 Until this step is complete, CI jobs can upload artifacts and send deployment notifications, but mobile test runs will not start automatically.

 ## How Fastlane works with QA Wolf

 The Fastlane integration uses a QA Wolf Fastlane plugin to perform two actions:

 <Steps>
  <Step>
@@ -44,14 +45,14 @@

 The artifact name you provide is used to associate the build with the correct environment. QA Wolf automatically applies the file extension.

 ## Install & configure Fastlane for QA Wolf

 <Steps>
  <Step>
    Add the [QA Wolf Fastlane plugin](https://github.com/qawolf/fastlane-plugin-qawolf) to your project if it is not already installed. This is typically done in your **Fastfile** or plugin configuration, depending on how your project manages Fastlane plugins. Follow the instructions on the `README` to install.
  </Step>
  <Step>
    Make sure your CI environment exports the **QAWOLF\_API\_KEY** environment variable so Fastlane can authenticate with QA Wolf.
  </Step>
 </Steps>

@@ -79,7 +80,7 @@

 ### Add the QAWOLF\_API\_KEY secret

 Store `QAWOLF_API_KEY` as a secret in your CI system and ensure it is exported as an environment variable in the job that runs Fastlane. The exact steps depend on your CI provider — refer to your CI system's documentation for storing secrets.

 ## Artifact naming conventions

@@ -107,7 +108,7 @@
 app-staging
 ```

 Use the same basename every time a build is generated for the same environment.

 ### PR (ephemeral) environments

@@ -128,16 +129,16 @@
 Including the organization, repository, and pull request number ensures each build can be traced back to the correct change and environment.

 <Tip>
  QA Wolf applies the file extension (.apk, .aab, or .ipa) automatically based on the uploaded artifact. You only need to provide the basename.
 </Tip>

 ## Upload a mobile build artifact

 Once your Fastlane lane produces a build artifact, you can upload it to QA Wolf.

 <Steps>
  <Step>
    Add the `upload_to_qawolf` action to your lane and provide the artifact basename that matches your naming conventions. If this step completes successfully, the artifact has been uploaded and is available for use in test runs.
  </Step>
 </Steps>

@@ -182,7 +183,7 @@

 <Steps>
  <Step>
    Run the Fastlane lane in CI.
  </Step>
  <Step>
    Confirm the artifact upload step completes successfully.
@@ -200,5 +201,5 @@
 ## Troubleshooting and common issues

 - **Artifact uploads succeed, but no runs start:** Mobile triggers may not be enabled yet. Contact QA Wolf to complete platform configuration.
 - **Artifact not found during test execution:** Verify the artifact basename matches the expected naming conventions.
 - **Authentication errors:** Confirm QAWOLF\_API\_KEY is set correctly in your CI environment.

diff --git a/...tegrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx b/...tegrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx
@@ -1,11 +1,12 @@
 ---
 title: "Integrate a mobile build with GitHub Actions"
+description: "Use QA Wolf's prebuilt GitHub Actions to upload mobile build artifacts and trigger test runs from your existing workflow."
 sidebarTitle: "GitHub Actions"
 ---
 
 ## When to use GitHub Actions

 This guide is for teams that use **GitHub Actions** as their CI system and want a simple, declarative way to upload mobile builds and trigger test runs without writing custom scripts. Use GitHub Actions if your repository already builds mobile artifacts in a GitHub Actions workflow and you prefer using prebuilt actions over maintaining Node.js scripts or Fastlane lanes. This guide assumes your mobile builds already run in GitHub Actions and produce a build artifact.

 ## Before you begin

@@ -102,7 +103,7 @@
 app-staging
 ```

 Use the same basename every time a build is generated for the same environment.

 ### PR (ephemeral) environments

@@ -123,7 +124,7 @@
 Including the organization, repository, and pull request number ensures each build can be traced back to the correct change and environment.

 <Tip>
  QA Wolf applies the file extension (.apk, .aab, or .ipa) automatically based on the uploaded artifact. You only need to provide the basename.
 </Tip>

 ## Upload a mobile build artifact
@@ -144,7 +145,7 @@

 ```yaml expandable highlight={1-25}
 name: Deploy and Notify QA Wolf
 on: pull_request
 jobs:
  ...
  notify:
@@ -210,5 +211,5 @@
 ## Troubleshooting and common issues

 - **If uploads succeed but no runs start:** Mobile triggers may not yet be enabled. Contact QA Wolf to complete platform configuration.
 - **If the artifact is not found during execution:** Verify that the artifact basename matches your naming conventions and that the destination file path from the upload step is used to trigger the run.
 - **If you see authentication errors:** Verify that **QAWOLF\_API\_KEY** is configured correctly as a GitHub Actions secret.

diff --git a/qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx b/qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx
@@ -1,9 +1,10 @@
 ---
 title: "Integrate a mobile build with the QA Wolf SDK"
+description: "Upload mobile build artifacts and trigger test runs from any Node.js-based CI system using the QA Wolf CI SDK."
 sidebarTitle: "Other (Node.js)"
 ---
 
 Use this guide if your CI system supports Node.js but is not GitHub Actions or Fastlane.

 <Check>
  Make sure you have:
@@ -77,7 +78,7 @@
 app-staging
 ```

 Use the same basename every time a build is generated for the same environment.

 ### PR (ephemeral) environments

@@ -98,7 +99,7 @@
 Including the organization, repository, and pull request number ensures each build can be traced back to the correct change and environment.

 <Tip>
  QA Wolf applies the file extension (.apk, .aab, or .ipa) automatically based on the uploaded artifact. You only need to provide the basename.
 </Tip>

 ## Upload a mobile build artifact
@@ -254,7 +255,7 @@
 ## Troubleshooting and common issues

 - **If uploads succeed but no runs start:** Mobile triggers may not yet be enabled. Contact QA Wolf to complete platform configuration.
 - **If the artifact is not found during execution:** Verify that the artifact basename matches your naming conventions, and the returned path is used when triggering the run.
 - **If you see authentication errors:** Verify that **QAWOLF\_API\_KEY** is configured correctly in your CI environment.
 - **If you encounter Node.js errors:** Ensure Node.js 18 or later is available in the CI job.


diff --git a/qawolf/deploy-success.mdx b/qawolf/deploy-success.mdx
@@ -1,6 +1,6 @@
 ---
 title: "webhooks/deploy_success"
-description: "Triggers a test run against a deployment."
+description: "Notify QA Wolf of a successful deployment to trigger a test run, including request format, headers, body fields, and example responses."
 sidebarTitle: "webhooks/deploy_success"
 ---
 

diff --git a/qawolf/libraries/ci-sdk/api-reference.mdx b/qawolf/libraries/ci-sdk/api-reference.mdx
@@ -1,6 +1,6 @@
 ---
 title: "API Reference"
-description: "Reference documentation for @qawolf/ci-sdk."
+description: "Reference for the @qawolf/ci-sdk TypeScript package, including installation, initialization, and functions for triggering and polling test runs from CI."
 ---
 
 `@qawolf/ci-sdk` provides a TypeScript SDK (CJS and ESM compatible) for interacting with the QA Wolf API from your CI pipeline.
@@ -88,7 +88,7 @@
 | `mergeRequestNumber` | number | VCS MR number, for MR testing. |
 | `repository.name` | string | Repository name. |
 | `repository.owner` | string | Repository owner or organization (VCS). |
 | `repository.namespace` | string | Repository namespace or group (VCS). |
 | `ephemeralEnvironment` | boolean | Pass with `deploymentUrl` for ephemeral environments without a code-hosting integration. |
 | `deduplicationKey` | string | Custom key controlling run cancellation behavior. |
 | `variables` | object | Key/value pairs that override environment variables for triggered runs. |

diff --git a/qawolf/libraries/cli/api-reference/environment-variables.mdx b/qawolf/libraries/cli/api-reference/environment-variables.mdx
@@ -1,10 +1,10 @@
 ---
 title: "Environment Variables"
-description: "Environment variables read by the qawolf CLI."
+description: "Environment variables the qawolf CLI reads for API access, Android and iOS SDK paths, and other runtime configuration."
 sidebarTitle: "Environment Variables"
 ---
 
 The qawolf CLI reads the following environment variables.

 ## `QAWOLF_API_KEY`


diff --git a/qawolf/libraries/cli/api-reference/index.mdx b/qawolf/libraries/cli/api-reference/index.mdx
@@ -1,6 +1,6 @@
 ---
 title: "API Reference"
-description: "API landing page for the qawolf CLI."
+description: "Overview of qawolf CLI commands, flags, configuration, environment variables, and exit codes for running flows locally."
 sidebarTitle: "API Reference"
 ---
 
@@ -38,13 +38,13 @@

 ## Exit Codes

 Every qawolf CLI command exits with one of the codes below.

 | Code | Name | Meaning |
 | --- | --- | --- |
 | `0` | `success` | The command completed successfully. |
 | `1` | `testFailure` | One or more flows failed. |
 | `2` | `invalidArgs` | A Commander parse error, an unknown subcommand, or a bad flag value. |
 | `3` | `auth` | `QAWOLF_API_KEY` is missing or invalid. |
 | `4` | `network` | The QA Wolf API was unreachable, a download from storage failed, or a registry was unreachable. |
 | `5` | `config` | `qawolf.config.ts` is invalid, or a file collision occurred during `qawolf init`. |
diff --git a/qawolf/libraries/cli/troubleshooting.mdx b/qawolf/libraries/cli/troubleshooting.mdx
@@ -1,6 +1,6 @@
 ---
 title: "CLI Troubleshooting"
-description: "Common issues when running the qawolf CLI."
+description: "Solutions for common qawolf CLI issues including authentication errors, missing API keys, SDK path problems, and failed flow execution."
 sidebarTitle: "CLI Troubleshooting"
 ---