
Step 1: Choose Your Platform
Select your platform to see the relevant setup instructions:iOS / Android
Mobile app builds (Expo, Fastlane, native)
Web
Web apps (Vercel, Netlify, custom deployments, etc.)
Chrome Extension
Manifest V3 extension zip builds
Mobile Setup
Choose Your Build Tool
Expo EAS
React Native with Expo’s build service
Fastlane
Native iOS/Android builds with Fastlane
Other
Gradle, Flutter, or custom builds
Step 2: Set Secrets
Go to your repository Settings → Secrets → Actions and add these secrets. See the GitHub Secrets docs for help.Required for All
string
required
Your Autosana API key for uploading builds. Create one with
autosana keys create or in Settings → API Keys.Required for Expo EAS
string
Your Expo access token for EAS builds. Get it from Expo account settings.
Step 3: Set up your Github Workflow with the Autosana Github Action
Create a.github/workflows/autosana-ios.yml and/or .github/workflows/autosana-android.yml file in your repository. Examples are provided below to get started.
For more specific build instructions by framework, check out our App Build Guide for detailed instructions on creating builds for iOS and Android.
Required Parameters:
api-key: Your Autosana API key (from secrets)bundle-id: Your app’s bundle ID (e.g.,com.company.app)platform: Eitheriosorandroidbuild-path: Path to your build artifact. Optional when the step selects tests: leave it empty to run tests without uploading.
name: Display name for your app (e.g., “My iOS App”). Updates existing app name if different.app-id: Custom identifier that keeps several apps with the same bundle ID in one environment (e.g.,v7.12.0). See Separate apps that share a bundle ID below.labels: Comma-separated label names to run after upload (e.g.,smoke,critical). Runs every suite and flow carrying any of the labels — resolved at run time, so CI config never changes as coverage grows. See Labels API.suite-ids: Comma-separated suite UUIDs to run after upload (e.g.,uuid1,uuid2).flow-ids: Comma-separated flow UUIDs to run after upload (e.g.,uuid1,uuid2).suite-keys: Comma-separated code-managed suite keys to run from the checked-out commit.flow-keys: Comma-separated code-managed flow keys to run from the checked-out commit.folder-ids: Comma-separated folder UUIDs to run after upload. Copy one from the folder’s ⋯ menu on the Flows page (Copy folder ID). Runs every suite and flow in the folder and its subfolders.folder-paths: Comma-separated code-managed folder paths below.autosana/, such asAuth/Onboarding, to run from the checked-out commit.environment: Name of the environment to associate this app with (e.g.,staging,production). See Assigning apps to environments.location: Android emulator runs only. Two-letter country code, such asMX, that every run this upload starts sends its traffic from. iOS uploads and physical devices are refused. See Run from another country.variables: Key-value variables to attach to the uploaded build. Available in flow instructions via${env:KEY}. UseKEY1=VALUE1,KEY2=VALUE2. See Build Variables.physical-device: Mobile runs only. Set totrueto use real hardware; defaults tofalse.device-model: Mobile runs only. Model from the Autosana device catalog, such asPixel 10 Pro, orlatest. Two-device flows use it for both devices.os-version: Mobile runs only. OS version supported by the selected model, such as17, orlatest. Two-device flows use it for both devices.devices: Mobile runs only. JSON array of exactly two ordered device selections, used instead ofphysical-device,device-model, andos-versionto choose each device of a two-device flow. One-device flows in the same run use the first entry.dependencies: For direct web runs only, a JSON array overriding the web app’s default Chrome extension loadout. Omit it to inherit defaults, use'[]'for no extensions, or provide extension app UUIDs and optional build pins. Requiressuite-ids,flow-ids,folder-ids,flow-keys, orlabels. It cannot be combined withsuite-keysorfolder-paths.wait: Whether to wait for selected tests and fail the job when they fail. Defaults totrue; set it tofalsefor fire-and-forget runs.enable-ios-keychain-access-group-remapping: iOS.ipaonly. Set totrueif cloud re-signing breaks Team-ID-prefixed Keychain access groups. The preference is saved on the app, so future IPA uploads can omit it; set it tofalseto disable.
Run code-managed tests by key
Use stable YAML keys instead of Autosana UUIDs when your flows and suites are managed in code. The Action resolves each key from the exact checked-out commit:flow-keys, suite-keys, and folder-paths. A folder path runs
every suite and flow in that directory of .autosana/ and the directories inside
it. Suites and flows made in the dashboard and filed in that folder also run, as
saved. Do not combine these with flow-ids, suite-ids, folder-ids, or labels.
Select a mobile device
Device inputs apply when any flow, suite, folder, or label selector triggers tests. Uselatest to make rolling model and OS selection explicit:
latest, or pin both to a
supported catalog combination:
device-model and os-version keeps the same rolling-Latest behavior.
For the latest available real device, set physical-device: true and use
latest (or omission) for the model and OS.
Run tests on more devices with one upload
When several jobs test the same build on different devices, let one job upload the build and leavebuild-path empty in the others. A job without
build-path skips the upload and runs its tests on the build already uploaded
for the same commit, in the same app (bundle ID, platform, environment, and
app-id).
needs:,
as above. The other jobs then wait only for the upload, not the build: up to 10 minutes from when the action starts, then they
fail with No build for commit <sha>. If the commit already has a build,
for example from an earlier run of the workflow, the job uses that build at
once. name and enable-ios-keychain-access-group-remapping apply only to
uploads, so a step without build-path ignores them. It must
select tests with labels, suite-ids, flow-ids, folder-ids,
suite-keys, flow-keys, or folder-paths.
Separate apps that share a bundle ID
By default, every build with the same bundle ID and platform in an environment goes to one app. Setapp-id to keep them apart, for example one app per
release version:
app-id creates the app, named after the
app-id unless you also set name. Later uploads with the same app-id add
builds to it, and any tests the step triggers run against that app. All of
these apps share the environment’s variables.
app-id can be up to 64 characters: lowercase letters, numbers, dots, hyphens,
and underscores. It must start and end with a letter or number, with no two
separators in a row. Automations are set up per app, so a new app starts with none.
Trigger its tests from this step with suite-ids, flow-ids, or labels.
Github Action Workflow Examples
- Expo EAS (iOS)
- Expo EAS (Android)
- Fastlane (iOS)
- Fastlane (Android)
- Native iOS
- Native Android
Chrome Extension Setup
Build or package the unpacked Manifest V3 extension directory as a.zip, then
upload it like a mobile build:
bundle-id create new versions and make the newest build active. Extension
apps are organization-wide and do not use environment.
The zip must contain manifest.json at its root or inside one top-level folder.
Only Manifest V3 is supported. Limits are 500MB compressed, 2GB expanded, and
25,000 entries.
After upload, attach the extension to a web app in the Autosana Apps page.
CI-triggered tests inherit that app’s default extensions.
Web Setup
For web applications, you can register a URL (such as a preview deployment) for testing. This is useful for testing Vercel, Netlify, or other preview deployments on every PR. To reuse cached navigation across preview deployments, also pass the deployment origin as a build variable namedBASE_URL. The url input selects the launch URL; it does not create this variable automatically. The variable must contain only an HTTP(S) origin (an optional trailing / is allowed), without a path, query string, fragment, or credentials. See Run Caching for eligibility and live-execution limits. Keep production and preview targets in separate Autosana environments.
Parameters
Required Parameters for Web:
api-key: Your Autosana API key (from secrets)platform: Must bewebapp-id: A unique identifier for your web app (lowercase, alphanumeric with hyphens, e.g.,my-web-app)url: The URL to test (e.g., your preview deployment URL)
name: Display name for your web app (e.g., “My Web App”). Updates existing app name if different.labels: Comma-separated label names to run after upload (e.g.,smoke,critical). Runs every suite and flow carrying any of the labels — resolved at run time, so CI config never changes as coverage grows. See Labels API.suite-ids: Comma-separated suite UUIDs to run after upload (e.g.,uuid1,uuid2).flow-ids: Comma-separated flow UUIDs to run after upload (e.g.,uuid1,uuid2).suite-keys: Comma-separated code-managed suite keys to run from the checked-out commit.flow-keys: Comma-separated code-managed flow keys to run from the checked-out commit.folder-ids: Comma-separated folder UUIDs to run after upload. Copy one from the folder’s ⋯ menu on the Flows page (Copy folder ID). Runs every suite and flow in the folder and its subfolders.folder-paths: Comma-separated code-managed folder paths below.autosana/, such asAuth/Onboarding, to run from the checked-out commit.environment: Name of the environment to associate this app with (e.g.,staging,production). See Assigning apps to environments.location: Two-letter country code, such asMX, that every run this upload starts sends its traffic from. See Run from another country.variables: Key-value variables to attach to the registered build. Available in flow instructions via${env:KEY}. UseKEY1=VALUE1,KEY2=VALUE2. See Build Variables.
Basic Usage
Run from another country
Setlocation to a two-letter country code. Every run the upload starts sends its traffic from that country: the tests this step selects, your CI/CD automations (in place of the automation’s own location), and later PR test runs against the build.
Override Chrome Extensions for a Web Run
Thedependencies input controls the extension loadout for tests triggered
directly by this Action. It supports ID selectors, labels, and flow-keys, but
cannot currently be combined with suite-keys:
app_id and may add
app_build_id to pin an exact build. The input must be a valid JSON array and
is rejected for iOS, Android, and Chrome extension uploads.
Web Workflow Examples
- Vercel
- Custom / Static URL
For Vercel deployments using the GitHub integration (OAuth), use the
wait-for-vercel-preview action to get the preview URL:.github/workflows/autosana-web-vercel.yml
The
wait-for-vercel-preview action requires the permissions block shown above to access deployment information. Without these permissions, you may see “Resource not accessible by integration” errors.The
app-id must be lowercase alphanumeric with hyphens only (e.g., my-web-app, staging, preview-app-123). This identifier is used to track your web app across deployments.Step 4: What Happens Next?
Once you’ve set up our CI/CD integration:1
Run flows directly (optional)
Add a flow, suite, folder, or label selector to your action config to trigger tests immediately after upload. For code-managed tests, use
flow-keys, suite-keys, or folder-paths so the workflow keeps stable YAML identifiers instead of Autosana UUIDs. The Action waits for all tests to complete and reports results inline, failing the job if any test fails.2
Configure automations
Alternatively (or additionally), set when flows run in your Automations page to run flows on a schedule or trigger.
3
View test results
Check your test runs in the Runs page.
Need Help Setting Up?
If you’re using Claude Code or another AI agent, you can add our MCP server to help automate the setup process. The MCP server can:- Set up your CI/CD pipeline automatically
- Build your app for iOS or Android
- Find your app’s bundle ID
- And more!
Instructions for AI Agents Using the Autosana MCP (humans, you can ignore this!)
If you are an AI agent (such as Claude Code, Cline, or Cursor) using the Autosana MCP server to help set up CI/CD workflows, use the following prompt to guide your workflow generation.
Helpful Resources
App Build Guide
Learn how to build your app for our cloud
GitHub Action
View the source code and documentation for our GitHub Action
Get Your API Key
Copy your API key from Settings → Integrations
Commit detection and PR results
Fordeployment and deployment_status events, the action automatically uses the deployed commit, even when the workflow checks out trusted code. PR events continue to use the PR head SHA; other events retain checkout-based detection. For manual or scheduled workflows targeting a different commit from the checkout, pass commit-sha explicitly. Optional branch-name and repo-full-name inputs override the corresponding GitHub metadata. Web tests use the build returned by registration, keeping concurrent preview runs separate.
The action reports its result through the workflow job. To show that result on a different PR, the calling workflow must create and complete a check on the PR’s head SHA with checks: write permission.