Upload builds

​

What you can upload

• File types — .apk and .aab for Android, .ipa for iOS. Any other file is refused, including a .zip.
• Size — at most 500 MB.
• File name — letters, digits, ., _ and -, at most 255 characters. The Builds page and the CLI replace other characters with -, and the Fastlane plugin replaces spaces with -. Every other way refuses the file.
• Zipped apps — not accepted. Upload the .apk, .aab or .ipa inside the zip. A zip that holds Payload/<App>.app/ is already an .ipa, so rename it to .ipa. Any other zipped app stays on legacy build uploads for now.
• Retention — 180 days after upload, except the latest build of each app and platform in a static environment, which stays until a later upload replaces it.

​

How a run picks its build

• Through its environment — upload the build with an environment, and it becomes that environment’s latest build of its app and platform. Every later run in the environment installs it, until a later upload of the same app and platform replaces it. This covers scheduled runs, runs started by hand, and runs a deployment starts.
• Through a run or a deployment — name the build when you create a run or report a deployment. Only those runs install it. A build uploaded without an environment reaches runs only this way.
• Through Tester chat — a build sent in chat reaches the runs in that chat session.

1. The builds named when the run was created. See Test a build in one run.
2. The builds the deployment that started the run reported.
3. The environment’s latest build.
4. The base environment’s latest build, for an environment that has one.

​

Upload a build

​

Builds page

​

GitHub Actions

- name: Upload the build to QA Wolf
  id: upload-build
  uses: qawolf/upload-build-action@v1
  with:
    qawolf-api-key: ${{ secrets.QAWOLF_API_KEY }}
    workspace-id: ${{ vars.QAWOLF_WORKSPACE_ID }}
    input-file-path: app/build/outputs/apk/release/app-release.apk
    environment: Staging

- name: Report the deployment to QA Wolf
  uses: qawolf/notify-qawolf-on-deploy-action@v3
  with:
    qawolf-api-key: ${{ secrets.QAWOLF_API_KEY }}
    workspace-id: ${{ vars.QAWOLF_WORKSPACE_ID }}
    environment: Staging
    service: android
    builds: ${{ steps.upload-build.outputs.build-id }}

​

Fastlane

gem "fastlane-plugin-qawolf", git: "https://github.com/qawolf/fastlane-plugin-qawolf", tag: "1.2.0"

lane :qawolf do
  # Your existing build step, gradle for Android or build_app for iOS

  upload_build_to_qawolf(
    # Also read from QAWOLF_API_KEY and QAWOLF_WORKSPACE_ID
    qawolf_api_key: ENV.fetch("QAWOLF_API_KEY", nil),
    workspace_id: ENV.fetch("QAWOLF_WORKSPACE_ID", nil),
    environment: "Staging"
  )

  notify_deploy_qawolf(
    qawolf_api_key: ENV.fetch("QAWOLF_API_KEY", nil),
    workspace_id: ENV.fetch("QAWOLF_WORKSPACE_ID", nil),
    environment: "Staging",
    service: "android"
  )
end

​

Node.js

import { makeQaWolfSdk } from "@qawolf/ci-sdk";

const { deployment, uploadBuild } = makeQaWolfSdk({
  apiKey: process.env.QAWOLF_API_KEY,
});

const uploaded = await uploadBuild({
  filePath: "app/build/outputs/apk/release/app-release.apk",
  environment: { name: "Staging" },
  workspaceId: process.env.QAWOLF_WORKSPACE_ID,
});
if (uploaded.outcome !== "uploaded") {
  throw new Error(`Upload failed: ${JSON.stringify(uploaded)}`);
}

const report = await deployment.reportStatus({
  workspaceId: process.env.QAWOLF_WORKSPACE_ID,
  providerDeploymentId: `${process.env.CI_BUILD_ID}-android`,
  status: "success",
  environment: { name: "Staging" },
  service: "android",
  builds: [uploaded.build.id],
});
if (report.outcome !== "reported") {
  throw new Error(`Report failed: ${JSON.stringify(report)}`);
}

​

CLI

npx @qawolf/cli build upload app-release.apk \
  --environment-name Staging \
  --branch main \
  --commit-sha "$GIT_COMMIT"

​

HTTP API

UPLOAD=$(curl -sf -X POST "https://app.qawolf.com/api/trpc/public.build.requestUpload" \
  -H "Authorization: Bearer $QAWOLF_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{ \"json\": {
    \"workspaceId\": \"$QAWOLF_WORKSPACE_ID\",
    \"fileName\": \"app-release.apk\",
    \"fileSizeBytes\": $(wc -c < app-release.apk)
  } }")
QAWOLF_BUILD_ID=$(echo "$UPLOAD" | jq -r .result.data.json.buildId)
UPLOAD_URL=$(echo "$UPLOAD" | jq -r .result.data.json.uploadUrl)

HEADERS=()
while IFS= read -r header; do HEADERS+=(-H "$header"); done < <(
  echo "$UPLOAD" | jq -r '.result.data.json.uploadHeaders | to_entries[] | "\(.key): \(.value)"'
)
curl -sf -X PUT --upload-file app-release.apk "${HEADERS[@]}" "$UPLOAD_URL"

curl -X POST "https://app.qawolf.com/api/trpc/public.build.create" \
  -H "Authorization: Bearer $QAWOLF_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{ \"json\": {
    \"workspaceId\": \"$QAWOLF_WORKSPACE_ID\",
    \"buildId\": \"$QAWOLF_BUILD_ID\",
    \"environment\": { \"name\": \"Staging\" }
  } }"

​

Tester chat and the QA Wolf MCP

• Tester chat — attach an .apk, .aab or .ipa to a message. The build has no environment. The runs in that chat install it, and the environment’s other runs do not.
• QA Wolf MCP — your coding agent calls build_requestUpload, uploads the file, then calls build_create. To test the build without making it the environment’s latest, the agent omits environment and passes the build id to run_create as builds.

​

Use the build in a flow

import { launch } from "@qawolf/flows/android";

await launch({ app: { id: "com.example.app" } });

​

Test a build in one run

• CLI — qawolf run create --environment-id <env> --builds <build_id>.
• QA Wolf MCP — run_create with builds.
• HTTP — POST https://app.qawolf.com/api/trpc/public.run.create with { "json": { "workspaceId": "…", "environmentId": "…", "flowIds": ["…"], "builds": ["<build_id>"] } }.

​

Move from legacy uploads

​

Related

• Mobile build testing — start runs on every new build.
• @qawolf/ci-sdk
• Webhook — every field of a deployment report.
• Legacy build uploads