Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
---
title: "Integrate a mobile build with Fastlane"

Check warning on line 2 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L2

Did you really mean 'Fastlane'?
sidebarTitle: "Fastlane"
description: "Use the QA Wolf Fastlane plugin to upload Android or iOS build artifacts and trigger mobile test runs from your existing Fastlane lanes."

Check warning on line 4 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L4

Did you really mean 'Fastlane'?
---

## When to use Fastlane

Check warning on line 7 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L7

Did you really mean '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.

Check warning on line 9 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L9

Did you really mean 'Fastlane'?

Check warning on line 9 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L9

Did you really mean 'Fastlane'?

Check warning on line 9 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L9

Did you really mean 'Fastlane'?

Check warning on line 9 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L9

Did you really mean 'Fastlane'?

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.

Check warning on line 11 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L11

Did you really mean 'Fastlane'?

Check warning on line 11 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L11

Did you really mean 'Fastlane'?

Check warning on line 11 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L11

Did you really mean 'Fastlane'?

## Before you begin

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

Check warning on line 15 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L15

Did you really mean 'Fastlane'?

- A working Fastlane setup for your Android or iOS app.

Check warning on line 17 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L17

Did you really mean 'Fastlane'?
- A Fastlane lane that produces a mobile build artifact (APK, AAB, or IPA).

Check warning on line 18 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L18

Did you really mean 'Fastlane'?
- 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.

Expand All @@ -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

Check warning on line 31 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L31

Did you really mean 'Fastlane'?

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

Check warning on line 33 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L33

Did you really mean 'Fastlane'?

Check warning on line 33 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L33

Did you really mean 'Fastlane'?

<Steps>
<Step>
Expand All @@ -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

Check warning on line 48 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L48

Did you really mean 'Fastlane'?

<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.

Check warning on line 52 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L52

Did you really mean 'Fastlane'?

Check warning on line 52 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L52

Did you really mean 'Fastlane'?
</Step>
<Step>
Make sure your CI environment exports the **QAWOLF\_API\_KEY** environment variable so Fastlane can authenticate with QA Wolf.

Check warning on line 55 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L55

Did you really mean 'Fastlane'?
</Step>
</Steps>

Expand Down Expand Up @@ -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.

Check warning on line 83 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L83

Did you really mean 'Fastlane'?

## Artifact naming conventions

Expand Down Expand Up @@ -107,7 +108,7 @@
app-staging
```

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

Check warning on line 111 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L111

Did you really mean 'basename'?

### PR (ephemeral) environments

Expand All @@ -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.

Check warning on line 132 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L132

Did you really mean 'basename'?
</Tip>

## Upload a mobile build artifact

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

Check warning on line 137 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L137

Did you really mean 'Fastlane'?

<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.

Check warning on line 141 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L141

Did you really mean 'basename'?
</Step>
</Steps>

Expand Down Expand Up @@ -182,7 +183,7 @@

<Steps>
<Step>
Run the Fastlane lane in CI.

Check warning on line 186 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L186

Did you really mean 'Fastlane'?
</Step>
<Step>
Confirm the artifact upload step completes successfully.
Expand All @@ -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.

Check warning on line 204 in qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Fastlane-2db5b2a994fb802186a3d88573899c78.mdx#L204

Did you really mean 'basename'?
- **Authentication errors:** Confirm QAWOLF\_API\_KEY is set correctly in your CI environment.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: "Integrate a mobile build with GitHub Actions"
sidebarTitle: "GitHub Actions"
description: "Use the QA Wolf GitHub Actions to upload mobile build artifacts and trigger test runs directly from your existing workflows."
---

## 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.

Check warning on line 9 in qawolf/Integrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Integrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx#L9

Did you really mean 'Fastlane'?

## Before you begin

Expand Down Expand Up @@ -102,7 +103,7 @@
app-staging
```

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

Check warning on line 106 in qawolf/Integrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Integrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx#L106

Did you really mean 'basename'?

### PR (ephemeral) environments

Expand All @@ -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.

Check warning on line 127 in qawolf/Integrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Integrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx#L127

Did you really mean 'basename'?
</Tip>

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

```yaml expandable highlight={1-25}
name: Deploy and Notify QA Wolf
on: pull_request

Check warning on line 148 in qawolf/Integrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Integrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx#L148

Did you really mean 'pull_request'?
jobs:
...
notify:
Expand Down Expand Up @@ -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.

Check warning on line 214 in qawolf/Integrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Integrate-a-mobile-build-with-GitHub-Actions-2db5b2a994fb8027a901d4238b02fb8f.mdx#L214

Did you really mean 'basename'?
- **If you see authentication errors:** Verify that **QAWOLF\_API\_KEY** is configured correctly as a GitHub Actions secret.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: "Integrate a mobile build with the QA Wolf SDK"
sidebarTitle: "Other (Node.js)"
description: "Use the QA Wolf CI SDK to upload mobile build artifacts and trigger test runs from any Node.js-based CI system."
---

Use this guide if your CI system supports Node.js but is not GitHub Actions or Fastlane.

Check warning on line 7 in qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx#L7

Did you really mean 'Fastlane'?

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

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

Check warning on line 81 in qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx#L81

Did you really mean 'basename'?

### PR (ephemeral) environments

Expand All @@ -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.

Check warning on line 102 in qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx#L102

Did you really mean 'basename'?
</Tip>

## Upload a mobile build artifact
Expand Down Expand Up @@ -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.

Check warning on line 258 in qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/Mobile-build-with-the-QA-Wolf-SDK-2db5b2a994fb80cdbd1ec31513f2cc15.mdx#L258

Did you really mean 'basename'?
- **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.

Expand Down
2 changes: 1 addition & 1 deletion qawolf/deploy-success.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "webhooks/deploy_success"
description: "Triggers a test run against a deployment."
description: "Reference for the deploy_success webhook that notifies QA Wolf of a deployment and triggers a test run against the new build."

Check warning on line 3 in qawolf/deploy-success.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/deploy-success.mdx#L3

Did you really mean 'deploy_success'?
sidebarTitle: "webhooks/deploy_success"
---

Expand Down
2 changes: 1 addition & 1 deletion qawolf/libraries/ci-sdk/api-reference.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "API Reference"
description: "Reference documentation for @qawolf/ci-sdk."
description: "API reference for the @qawolf/ci-sdk TypeScript package, used to notify deployments and poll CI greenlight status from your pipeline."

Check warning on line 3 in qawolf/libraries/ci-sdk/api-reference.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/libraries/ci-sdk/api-reference.mdx#L3

Did you really mean 'greenlight'?
---

`@qawolf/ci-sdk` provides a TypeScript SDK (CJS and ESM compatible) for interacting with the QA Wolf API from your CI pipeline.
Expand Down Expand Up @@ -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). |

Check warning on line 91 in qawolf/libraries/ci-sdk/api-reference.mdx

View check run for this annotation

Mintlify / Mintlify Validation (qawolf) - vale-spellcheck

qawolf/libraries/ci-sdk/api-reference.mdx#L91

Did you really mean 'namespace'?
| `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. |
Expand Down