Pre-packaged jobs in EAS Workflows - Expo

import { Collapsible } from '~~/ui/components/Collapsible'; import { FAQ } from '~~/ui/components/FAQ';

Pre-packaged jobs are ready-to-use workflow jobs that help you automate common tasks like building, submitting, and testing your app. They provide a standardized way to handle these operations without having to write custom job configurations from scratch. This guide covers the available pre-packaged jobs and how to use them in your workflows.

Build

Build your project into an Android or iOS app.

Build jobs can be customized so that you can execute custom commands during the build process. See Custom builds for more information.

Prerequisites

To successfully use the build job, you'll need to complete a build with EAS CLI using the same platform and profile as the pre-packaged job. Learn how to create your first build to get started.

Syntax

yaml

jobs:
  build_app:
    type: build
    runs_on: string # optional - see https://docs.expo.dev/build-reference/infrastructure/ for available options
    params:
      platform: android | ios # required
      profile: string # optional - default: production
      message: string # optional

Parameters

You can pass the following parameters into the params list:

Parameter	Type	Description
platform	string	Required. The platform to build for. Can be either `android` or `ios`.
profile	string	Optional. The build profile to use. Defaults to `production`.
message	string	Optional. Custom message attached to the build. Corresponds to the `--message` flag when running `eas build`.

Environment variables

If you need certain environment variables during the build process, you can include them in your eas.json, for your specified build profile. They will be pulled from EAS environment variables.

Outputs

You can reference the following outputs in subsequent jobs:

Output	Type	Description
build_id	string	The ID of the created build.
app_build_version	string	The version code/build number of the app.
app_identifier	string	The bundle identifier/package name of the app.
app_version	string	The version of the app.
channel	string	The update channel used for the build.
distribution	string	The distribution method used. Can be `internal` or `store`.
fingerprint_hash	string	The fingerprint hash of the build.
git_commit_hash	string	The git commit hash used for the build.
platform	string	The platform the build was created for. Either `android` or `ios`.
profile	string	The build profile used.
runtime_version	string	The runtime version used.
sdk_version	string	The SDK version used.
simulator	string	Whether the build is for simulator.

Examples

Here are some practical examples of using the build job:

This workflow builds your iOS app whenever you push to the main branch.

yaml

name: Build iOS app

on:
  push:
    branches: ['main']

jobs:
  build_ios:
    name: Build iOS
    type: build
    params:
      platform: ios
      profile: production

</Collapsible> <Collapsible summary="Build for both platforms in parallel">

This workflow builds both Android and iOS apps in parallel when you push to the main branch.

yaml

name: Build for all platforms

on:
  push:
    branches: ['main']

jobs:
  build_android:
    name: Build Android
    type: build
    params:
      platform: android
      profile: production

  build_ios:
    name: Build iOS
    type: build
    params:
      platform: ios
      profile: production

</Collapsible> <Collapsible summary="Build with environment variables">

This workflow builds your Android app with custom environment variables that can be used during the build process.

yaml

name: Build with environment variables

on:
  push:
    branches: ['main']

jobs:
  build_android:
    name: Build Android
    type: build
    env:
      APP_ENV: production
      API_URL: https://api.example.com
    params:
      platform: android
      profile: production

</Collapsible> <Collapsible summary="Build with different profiles">

This workflow creates two different Android builds using different profiles - one for internal distribution and one for store submission using the development and production profiles.

yaml

name: Build with different profiles

on:
  push:
    branches: ['main']

jobs:
  build_android_development:
    name: Build Android Development
    type: build
    params:
      platform: android
      profile: development

  build_android_production:
    name: Build Android Production
    type: build
    params:
      platform: android
      profile: production

</Collapsible>

Deploy

Deploy your application using EAS Hosting.

Prerequisites

To deploy your application using EAS Hosting, you'll need to set up your project. See Get Started with EAS Hosting for more information.

Syntax

yaml

jobs:
  deploy_web:
    type: deploy
    params:
      alias: string # optional
      prod: boolean # optional

Parameters

You can pass the following parameters into the params list:

Parameter	Type	Description
alias	string	Optional. The alias to deploy to.
prod	boolean	Optional. Whether to deploy to production.

Outputs

You can reference the following outputs in subsequent jobs:

Output	Type	Description
deploy_json	string	JSON object containing the deployment details (output of `npx eas-cli deploy --json`).
deploy_url	string	URL to the deployment. It uses production URL if this was a production deployment. Otherwise, it uses the first alias URL or the deployment URL.
deploy_alias_url	string	Alias URL to the deployment (for example, `https://account-project--alias.expo.app`).
deploy_deployment_url	string	Unique URL to the deployment (for example, `https://account-project--uniqueid.expo.app`).
deploy_identifier	string	Identifier of the deployment.
deploy_dashboard_url	string	URL to the deployment dashboard (for example, `https://expo.dev/projects/[project]/hosting/deployments`).

Examples

Here are some practical examples of using the deploy job:

This workflow deploys your application to production using EAS Hosting.

yaml

name: Basic Deployment

jobs:
  deploy:
    name: Deploy to Production
    type: deploy
    params:
      prod: true

</Collapsible> <Collapsible summary="Deploy to production only on merges to the `main` branch">

This workflow deploys your application to production when you merge to the main branch, and makes a non-production deployment on all other branches.

yaml

name: Deploy

on:
  push:
    branches: ['*']

jobs:
  deploy:
    name: Deploy
    type: deploy
    params:
      prod: ${{ github.ref_name == 'main' }}

</Collapsible> <Collapsible summary="Deployment with custom alias">

This workflow deploys your application to a custom alias in production.

yaml

name: Deployment with Alias

jobs:
  deploy:
    name: Deploy with Alias
    type: deploy
    params:
      alias: my-custom-alias
      prod: true

</Collapsible>

Fingerprint

Calculates a fingerprint of your project.

Note: This job type only supports CNG (managed) workflows. If you commit your android or ios directories, the fingerprint job won't work.

Note: To ensure fingerprints match your builds, use the same environment setting as your build profile. For environment variables, we recommend using EAS environment variables rather than the env field for better consistency.

Syntax

yaml

jobs:
  fingerprint:
    type: fingerprint
    environment: production | preview | development # optional, defaults to production
    env: # optional list of environment variables
      ENV_VAR_NAME: value

Environment variables

You can pass a list of environment variables into the env parameter. These environment variables will be pulled from EAS environment variables. The passed environment parameter will be used for the environment variable's environment, which is useful when the same environment variable is defined across different environments.

Outputs

You can reference the following outputs in subsequent jobs:

Output	Type	Description
android_fingerprint_hash	string	The fingerprint hash for Android.
ios_fingerprint_hash	string	The fingerprint hash for iOS.

Examples

Here are some practical examples of using the fingerprint job:

This workflow calculates fingerprints for both Android and iOS builds. The environment should match your build profile for accurate fingerprint matching.

yaml

name: Basic Fingerprint

jobs:
  fingerprint:
    name: Calculate Fingerprint
    type: fingerprint
    # @info Match your build profile's environment #
    environment: production
    # @end #

</Collapsible> <Collapsible summary="Fingerprint with inline environment variables">

Note: If you depend on inline environment variables, you will need to always make sure to set the right set of environment variables to the right values in every place (build profile, fingerprint job, update job, and so on) for fingerprints to match. We recommend using EAS Environment Variables instead, where you can group sets of variables into environments and reference them in the build profile and workflow jobs.

yaml

name: Fingerprint with Environment Variables

jobs:
  fingerprint:
    name: Calculate Fingerprint
    type: fingerprint
    environment: production
    # Resulting environment will be a union of the "production" environment and the inline environment variables.
    # `env` variables override environment variables of the same name from the "production" environment.
    env:
      APP_VARIANT: staging
      API_URL: https://api.staging.example.com

</Collapsible>

Get Build

Retrieve an existing build from EAS that matches the provided parameters.

Syntax

yaml

jobs:
  get_build:
    type: get-build
    params:
      platform: ios | android # optional
      profile: string # optional
      distribution: store | internal | simulator # optional
      channel: string # optional
      app_identifier: string # optional
      app_build_version: string # optional
      app_version: string # optional
      git_commit_hash: string # optional
      fingerprint_hash: string # optional
      sdk_version: string # optional
      runtime_version: string # optional
      simulator: boolean # optional
      wait_for_in_progress: boolean # optional

Parameters

You can pass the following parameters into the params list:

Parameter	Type	Description
platform	string	Optional. The platform to get the build for. Can be `ios` or `android`.
profile	string	Optional. The build profile to use.
distribution	string	Optional. The distribution method. Can be `store`, `internal`, or `simulator`.
channel	string	Optional. The update channel.
app_identifier	string	Optional. The bundle identifier/package name.
app_build_version	string	Optional. The build version.
app_version	string	Optional. The app version.
git_commit_hash	string	Optional. The git commit hash.
fingerprint_hash	string	Optional. The fingerprint hash.
sdk_version	string	Optional. The SDK version.
runtime_version	string	Optional. The runtime version.
simulator	boolean	Optional. Whether to get a simulator build.
wait_for_in_progress	boolean	Optional. Whether to wait for a matching in-progress build. Default: `false`.

If wait_for_in_progress is set to true, the job will still prioritize continuing immediately with a successful build, but it will also look for in-progress builds. If no successful build is found, the job will wait for an in-progress build to complete before continuing. If the matched build succeeds, the job will be marked as successful and will return the successful build. If the matched build fails, the job will be marked as successful and its outputs will be empty — as if the build has not been matched.

Outputs

You can reference the following outputs in subsequent jobs:

Output	Type	Description
build_id	string	The ID of the retrieved build.
app_build_version	string	The build version of the app.
app_identifier	string	The bundle identifier/package name of the app.
app_version	string	The version of the app.
channel	string	The update channel used for the build.
distribution	string	The distribution method used.
fingerprint_hash	string	The fingerprint hash of the build.
git_commit_hash	string	The git commit hash used for the build.
platform	string	The platform the build was created for.
profile	string	The build profile used.
runtime_version	string	The runtime version used.
sdk_version	string	The SDK version used.
simulator	string	Whether the build is for simulator.

Examples

Here are some practical examples of using the get-build job:

This workflow retrieves the latest production build for iOS from the store distribution channel.

yaml

name: Get Production Build

jobs:
  get_build:
    name: Get Latest Production Build
    type: get-build
    params:
      platform: ios
      profile: production
      distribution: store
      channel: production

</Collapsible> <Collapsible summary="Get build by version">

This workflow retrieves a specific version of an Android build by its app version and build version.

yaml

name: Get Build by Version

jobs:
  get_build:
    name: Get Specific Version Build
    type: get-build
    params:
      platform: android
      app_identifier: com.example.app
      app_version: 1.0.0
      app_build_version: 42

</Collapsible> <Collapsible summary="Get simulator build">

This workflow retrieves a simulator build for iOS development. wait_for_in_progress is set to true so that if a build matching the filter already exists, the job will wait for it to complete before continuing.

yaml

name: Get Simulator Build

jobs:
  get_build:
    name: Get Simulator Build
    type: get-build
    params:
      platform: ios
      simulator: true
      profile: development
      wait_for_in_progress: true

</Collapsible>

Submit

Submit an Android or iOS build to the app store using EAS Submit.

Prerequisites

Submission jobs require additional configuration to run within a CI/CD process. See our Apple App Store CI/CD submission guide and Google Play Store CI/CD submission guide for more information.

Syntax

yaml

jobs:
  submit_to_store:
    type: submit
    runs_on: string # optional - see https://docs.expo.dev/build-reference/infrastructure/ for available options
    params:
      build_id: string # required
      profile: string # optional - default: production

Parameters

You can pass the following parameters into the params list:

Parameter	Type	Description
build_id	string	Required. The ID of the build to submit.
profile	string	Optional. The submit profile to use. Defaults to `production`.

Outputs

You can reference the following outputs in subsequent jobs:

Output	Type	Description
apple_app_id	string	The Apple App ID of the submitted build.
ios_bundle_identifier	string	The iOS bundle identifier of the submitted build.
android_package_id	string	The Android package ID of the submitted build.

Examples

Here are some practical examples of using the submit job:

This workflow submits an iOS build to the App Store using the production submit profile.

yaml

name: Submit iOS Build

jobs:
  build_ios:
    name: Build iOS
    type: build
    params:
      platform: ios
      profile: production

  submit:
    name: Submit to App Store
    type: submit
    needs: [build_ios]
    params:
      build_id: ${{ needs.build_ios.outputs.build_id }}
      profile: production

</Collapsible> <Collapsible summary="Submit Android build">

This workflow submits an Android build to the Play Store using the production submit profile.

yaml

name: Submit Android Build

jobs:
  build_android:
    name: Build Android
    type: build
    params:
      platform: android
      profile: production

  submit:
    name: Submit to Play Store
    type: submit
    needs: [build_android]
    params:
      build_id: ${{ needs.build_android.outputs.build_id }}
      profile: production

</Collapsible>

TestFlight

Distribute iOS builds to TestFlight internal and external testing groups. This is an alternative to the iOS submit job for when you need more advanced TestFlight features. If you need to control test groups, changelog, or Beta App Review submission, use the testflight job instead of submit.

Prerequisites

TestFlight jobs require an iOS build created with distribution: store. You'll need to have your Apple Developer account configured. See the TestFlight submission guide for more information.

Syntax

yaml

jobs:
  testflight_distribution:
    type: testflight
    runs_on: string # optional - see https://docs.expo.dev/build-reference/infrastructure/ for available options
    params:
      build_id: string # required
      profile: string # optional - default: production
      internal_groups: string[] # optional
      external_groups: string[] # optional
      changelog: string # optional
      submit_beta_review: boolean # optional
      wait_processing_timeout_seconds: number # optional - default: 1800 (30 minutes)

Parameters

You can pass the following parameters into the params list:

Parameter	Type	Description
build_id	string	Required. The ID of the iOS build to distribute.
profile	string	Optional. The submit profile to use. Defaults to `production`.
internal_groups	string[]	Optional. An array of TestFlight internal group names to add the build to. Only include groups without automatic distribution enabled.
external_groups	string[]	Optional. An array of TestFlight external group names to add the build to.
changelog	string	Optional. Test notes ("What to Test") for TestFlight testers.
submit_beta_review	boolean	Optional. Whether to submit for Beta App Review. If not specified, defaults to `true` when external_groups are provided, `false` otherwise.
wait_processing_timeout_seconds	number	Optional. Timeout in seconds to wait for App Store Connect build processing. Defaults to `1800` (30 minutes).

Outputs

You can reference the following outputs in subsequent jobs:

Output	Type	Description
apple_app_id	string	The Apple App ID of the submitted build.
ios_bundle_identifier	string	The iOS bundle identifier of the submitted build.

Examples

Here are some practical examples of using the TestFlight job:

This workflow distributes to both internal and external TestFlight groups with a changelog.

yaml

name: TestFlight Distribution

jobs:
  build_ios:
    name: Build iOS
    type: build
    params:
      platform: ios
      profile: production

  testflight:
    name: Distribute to TestFlight
    type: testflight
    needs: [build_ios]
    params:
      build_id: ${{ needs.build_ios.outputs.build_id }}
      internal_groups: ['QA Team']
      external_groups: ['Public Beta']
      changelog: |
        What's new in this release:
        - New features
        - Bug fixes

</Collapsible> <Collapsible summary="Upload with changelog only">

This workflow uploads a build with a changelog but without specifying any groups to explicitly add the build to. The build will only get added to internal groups with "auto-distribute" enabled.

yaml

name: TestFlight with Changelog

jobs:
  testflight:
    name: Upload with Changelog
    type: testflight
    params:
      build_id: ${{ needs.build_ios.outputs.build_id }}
      changelog: "${{ github.commit_message || 'Bug fixes' }}"
      # github.commit_message only available in push & schedule events.

</Collapsible>

Update

Publish an update using EAS Update.

Prerequisites

To publish update previews and to send over-the-air updates, you'll need to run npx eas-cli@latest update:configure, then create new builds. Learn more about configuring EAS Update.

Syntax

yaml

jobs:
  publish_update:
    type: update
    environment: production | preview | development # optional, defaults to production
    env: # optional list of environment variables
      ENV_VAR_NAME: value
    runs_on: string # optional - see https://docs.expo.dev/build-reference/infrastructure/ for available options
    params:
      message: string # optional
      platform: string # optional - android | ios | all, defaults to all
      branch: string # optional
      channel: string # optional - cannot be used with branch
      private_key_path: string # optional
      upload_sentry_sourcemaps: boolean # optional - defaults to "try uploading, but don't fail the job if it fails"

Environment variables

Parameters

You can pass the following parameters into the params list:

Parameter	Type	Description
message	string	Optional. Message to use for the update. If not provided, the commit message will be used.
platform	string	Optional. Platform to use for the update. Can be `android`, `ios`, or `all`. Defaults to `all`.
branch	string	Optional. Branch to use for the update. If not provided, the branch from the workflow run will be used. For manually run workflows you need to provide a value. Example: `${{ github.ref_name \|\| 'testing' }}`. Provide either a branch or a channel, not both.
channel	string	Optional. Channel to use for the update. Provide either a branch or a channel, not both.
private_key_path	string	Optional. Path to the file containing the PEM-encoded private key corresponding to the certificate in EAS Update configuration. You can reference a file type EAS environment variable with `"$VARIABLE_NAME"` syntax. This is equivalent to passing `--private-key-path` to the EAS CLI.
upload_sentry_sourcemaps	boolean	Optional. Whether to upload Sentry sourcemaps. If the value is `true`, the job will upload Sentry source maps and fail if uploading fails. If the value is `false`, the job will not upload sourcemaps to Sentry. If the value is not provided, the job is going to check if `@sentry/react-native` is installed and if it is, try to upload sourcemaps. If that fails, it will only print the error message and continue with the job marked as successful.

Outputs

You can reference the following outputs in subsequent jobs:

Output	Type	Description
first_update_group_id	string	The ID of the first update group.
updates_json	string	A JSON string containing information about all update groups.

Examples

Here are some practical examples of using the update job:

This workflow publishes an update to the production channel whenever you push to the main branch, using the commit message as the update message.

yaml

name: Update Production

on:
  push:
    branches: ['main']

jobs:
  update_production:
    name: Update Production Channel
    type: update
    params:
      channel: production

</Collapsible> <Collapsible summary="Platform-specific updates">

This workflow publishes separate updates for Android and iOS platforms, allowing for platform-specific changes.

yaml

name: Platform-specific Updates

on:
  push:
    branches: ['main']

jobs:
  update_android:
    name: Update Android
    type: update
    params:
      platform: android
      channel: production

  update_ios:
    name: Update iOS
    type: update
    params:
      platform: ios
      channel: production

</Collapsible> <Collapsible summary="Update with branch-based deployment">

This workflow publishes updates based on the branch name, allowing for different environments (staging/production) based on the branch.

yaml

name: Branch-based Updates

on:
  push:
    branches: ['main', 'staging']

jobs:
  update_branch:
    name: Update Branch
    type: update
    params:
      branch: ${{ github.ref_name }}
      message: 'Update for branch: ${{ github.ref_name }}'

</Collapsible>

Maestro

Run Maestro tests on a Android emulator or iOS Simulator build.

important Maestro tests are in alpha.

Syntax

yaml

jobs:
  run_maestro_tests:
    type: maestro
    environment: production | preview | development # optional - defaults to preview
    image: string # optional - see https://docs.expo.dev/build-reference/infrastructure/ for a list of available images.
    params:
      build_id: string # required
      flow_path: string | string[] # required
      shards: number # optional - defaults to 1
      retries: number # optional - defaults to 1
      record_screen: boolean # optional - defaults to false
      include_tags: string | string[] # optional
      exclude_tags: string | string[] # optional
      maestro_version: string # optional - defaults to latest
      android_system_image_package: string # optional
      device_identifier: string | { android: string, ios: string } # optional
      output_format: string # optional - defaults to junit

Parameters

You can pass the following parameters into the params list:

Parameter	Type	Description
build_id	string	Required. The ID of the build to test.
flow_path	string or string[]	Required. The path to the Maestro flow file(s) or directory to run.
shards	number	Optional and experimental. The number of shards to split the tests into. Defaults to 1.
retries	number	Optional. The number of times to retry failed tests. Defaults to 1.
record_screen	boolean	Optional. Whether to record the screen. Defaults to false. Note: recording screen may impact emulator performance. You may want to use large runners when recording screen.
include_tags	string or string[]	Optional. Flow tags to include in the tests. Will be passed to Maestro as `--include-tags`.
exclude_tags	string or string[]	Optional. Flow tags to exclude from the tests. Will be passed to Maestro as `--exclude-tags`.
maestro_version	string	Optional. Version of Maestro to use for the tests. If not provided, the latest version will be used.
output_format	string	Optional. Maestro test report format. Defaults to `junit`. Will be passed to Maestro as `--format`. Can be `junit` or other supported formats.
android_system_image_package	string	Optional. Android Emulator system image package to use. Run `sdkmanager --list` on your machine to list available packages. Choose an `x86_64` variant. Examples: `system-images;android-36;google_apis;x86_64`, `system-images;android-35-ext15;google_apis_playstore;x86_64`. Note that newer images require more computing resources, for which you may want to use large runners.
device_identifier	string or `{ android?: string, ios?: string }` object	Optional. Device identifier to use for the tests. You can also use a single-value expression like `pixel_6`, `iPhone 16 Plus` or `${{ needs.build.outputs.platform == "android" ? "pixel_6" : "iPhone 16 Plus" }}` and an object like `device_identifier: { android: "pixel_6", ios: "iPhone 16 Plus" }`. Note that iOS devices availability differs across runner images. A list of available devices can be found in the jobs logs.
skip_build_check	boolean	Optional. Skip validation of the build (whether an iOS build is a simulator build). Defaults to false.

Examples

Here are some practical examples of using the Maestro job:

This workflow runs Maestro tests on an iOS Simulator build using the default settings.

yaml

name: Basic Maestro Test

jobs:
  test:
    name: Run Maestro Tests
    type: maestro
    environment: preview
    params:
      build_id: ${{ needs.build_ios_simulator.outputs.build_id }}
      flow_path: ./maestro/flows

</Collapsible> <Collapsible summary="Maestro test with sharding">

This workflow runs Maestro tests on an Android emulator build with 3 shards and 2 retries for failed tests.

yaml

name: Sharded Maestro Test

jobs:
  test:
    name: Run Sharded Maestro Tests
    type: maestro
    environment: preview
    runs_on: linux-large-nested-virtualization
    params:
      build_id: ${{ needs.build_android_emulator.outputs.build_id }}
      flow_path: ./maestro/flows
      shards: 3
      retries: 2

</Collapsible> <Collapsible summary="Using Maestro prefixed environment variables">

Maestro can automatically read environment variables in a workflow when the variable is prefixed by MAESTRO_. For more information, see the Maestro documentation on shell variables.

yaml

name: Basic Maestro Test

jobs:
  test:
    name: Run Maestro Tests
    type: maestro
    env:
      MAESTRO_APP_ID: 'com.yourhost.yourapp'
    params:
      build_id: ${{ needs.build_ios_simulator.outputs.build_id }}

</Collapsible> <Collapsible summary="Recording screen and using a specific device">

This workflow runs Maestro tests on an Android emulator build with a specific device and records the screen.

yaml

name: Pixel E2E Test

jobs:
  test:
    name: Run Maestro Tests
    type: maestro
    runs_on: linux-large-nested-virtualization
    params:
      build_id: ${{ needs.build_android_emulator.outputs.build_id }}
      device_identifier: 'pixel_6'
      record_screen: true
      android_system_image_package: 'system-images;android-35;default;x86_64'

</Collapsible> <Collapsible summary="Saving screenshots and recordings">

To save assets created by Maestro commands (such as takeScreenshot or startRecording) to use for debugging later, use the MAESTRO_TESTS_DIR environment variable.

In your Maestro flow file, specify the asset locations:

yaml

appId: com.myapp
---
- launchApp
- startRecording: ${MAESTRO_TESTS_DIR}/my_recording
- takeScreenshot: ${MAESTRO_TESTS_DIR}/my_screenshot
- tapOn: 'Login Button'
- takeScreenshot: ${MAESTRO_TESTS_DIR}/after_login_screenshot
- stopRecording

The assets will be available within the "Maestro Test Results" artifact in the Artifacts section.

</Collapsible>

Maestro Cloud

Run Maestro tests on Maestro Cloud.

important This requires a Maestro Cloud account and Cloud Plan subscription. Go to Maestro docs to learn more.

Syntax

yaml

jobs:
  run_maestro_tests:
    type: maestro-cloud
    environment: production | preview | development # optional - defaults to preview
    image: string # optional- see https://docs.expo.dev/build-reference/infrastructure/ for a list of available images.
    params:
      build_id: string # required - ID of the build to test.
      maestro_project_id: string # required - Maestro Cloud project ID. Example: `proj_01jw6hxgmdffrbye9fqn0pyzm0`.
      flows: string # required - Path to the Maestro flow file or directory containing the flows to run. Corresponds to `--flows` param to `maestro cloud`.
      maestro_api_key: string # optional - defaults to `$MAESTRO_CLOUD_API_KEY`
      include_tags: string | string[] # optional - tags to include in the tests. Will be passed to Maestro as `--include-tags`.
      exclude_tags: string | string[] # optional - tags to exclude from the tests. Will be passed to Maestro as `--exclude-tags`.
      maestro_version: string # optional - version of Maestro to use for the tests. If not provided, the latest version will be used.
      android_api_level: string # optional - Android API level to use for the tests. Will be passed to Maestro as `--android-api-level`.
      maestro_config: string # optional - path to the Maestro `config.yaml` file to use for the tests. Will be passed to Maestro as `--config`.
      device_locale: string # optional - device locale to use for the tests. Will be passed to Maestro as `--device-locale`. Run `maestro cloud --help` for a list of supported values.
      device_model: string # optional - model of the device to use for the tests. Will be passed to Maestro as `--device-model`. Run `maestro cloud --help` for a list of supported values.
      device_os: string # optional - OS of the device to use for the tests. Will be passed to Maestro as `--device-os`. Run `maestro cloud --help` for a list of supported values.
      name: string # optional - name for the Maestro Cloud upload. Corresponds to `--name` param to `maestro cloud`.
      branch: string # optional - override for the branch the Maestro Cloud upload originated from. By default, if the workflow run has been triggered from GitHub, the branch of the workflow run will be used. Corresponds to `--branch` param to `maestro cloud`.
      async: boolean # optional - run the Maestro Cloud tests asynchronously. If true, the status of the job will only denote whether the upload was successful, _not_ whether the tests succeeded. Corresponds to `--async` param to `maestro cloud`.

Parameters

You can pass the following parameters into the params list:

Parameter	Type	Description
build_id	string	Required. The ID of the build to test. Example: `${{ needs.build_android.outputs.build_id }}`.
maestro_project_id	string	Required. The ID of the Maestro Cloud project to use. Corresponds to `--project-id` param to `maestro cloud`. Example: `proj_01jw6hxgmdffrbye9fqn0pyzm0`. Go to Maestro Cloud to find yours.
flows	string	Required. The path to the Maestro flow file or directory containing the flows to run. Corresponds to `--flows` param to `maestro cloud`.
maestro_api_key	string	Optional. The API key to use for the Maestro project. By default, `MAESTRO_CLOUD_API_KEY` environment variable will be used. Corresponds to `--api-key` param to `maestro cloud`.
include_tags	string	Optional. The tags to include in the tests. Corresponds to `--include-tags` param to `maestro cloud`. Example: `"pull,push"`.
exclude_tags	string	Optional. The tags to exclude from the tests. Corresponds to `--exclude-tags` param to `maestro cloud`. Example: `"disabled"`.
maestro_version	string	Optional. The version of Maestro to use. Example: `1.30.0`.
android_api_level	string	Optional. The Android API level to use. Corresponds to `--android-api-level` param to `maestro cloud`. Example: `29`.
maestro_config	string	Optional. The path to the Maestro `config.yaml` file to use. Corresponds to `--config` param to `maestro cloud`. Example: `.maestro/config.yaml`.
device_locale	string	Optional. The locale that will be set on devices used for the tests. Corresponds to `--device-locale` param to `maestro cloud`. Example: `pl_PL`.
device_model	string	Optional. The model of the device to use for the tests. Corresponds to `--device-model` param to `maestro cloud`. Example: `iPhone-11`. Run `maestro cloud --help` for a list of supported values.
device_os	string	Optional. The OS of the device to use for the tests. Corresponds to `--device-os` param to `maestro cloud`. Example: `iOS-18-2`. Run `maestro cloud --help` for a list of supported values.
name	string	Optional. Name for the Maestro Cloud upload. Corresponds to `--name` param to `maestro cloud`.
branch	string	Optional. Override for the branch the Maestro Cloud upload originated from. By default, if the workflow run has been triggered from GitHub, the branch of the workflow run will be used. Corresponds to `--branch` param to `maestro cloud`.
async	boolean	Optional. Run the Maestro Cloud tests asynchronously. If true, the status of the job will only denote whether the upload was successful, not whether the tests succeeded. Corresponds to `--async` param to `maestro cloud`.

important You need to either set maestro_api_key parameter or MAESTRO_CLOUD_API_KEY environment variable in the job environment. Go to "Settings" on Maestro Cloud to generate an API key and then to Environment variables to add it to your project.

Outputs

You can reference the following outputs in subsequent jobs:

Output	Type	Description
maestro_cloud_url	string	URL to the Maestro Cloud upload results page.
total_flows_count	number	Total number of flows that were executed.
successful_flows_count	number	Number of flows that completed successfully (status SUCCESS or WARNING).
failed_flows_count	number	Number of flows that failed (status ERROR or STOPPED).
successful_flow_names_json	string	JSON array containing the names of successful flows.
failed_flow_names_json	string	JSON array containing the names of failed flows.

Note: When using async: true mode, only the maestro_cloud_url output is guaranteed to be valid. Other outputs (flow counts and flow names) may be invalid or empty because the job does not wait for the upload to complete and the flows have not been executed yet.

Examples

Here are some practical examples of using the Maestro job:

This workflow runs Maestro tests on an iOS Simulator build using the default settings.

yaml

name: Basic Maestro Test

jobs:
  test:
    name: Run Maestro Tests
    type: maestro-cloud
    environment: preview
    params:
      build_id: ${{ needs.build_ios_simulator.outputs.build_id }}
      maestro_project_id: proj_01jw6hxgmdffrbye9fqn0pyzm0
      flows: ./maestro/flows

</Collapsible> <Collapsible summary="Using Maestro prefixed environment variables">

Maestro can automatically read environment variables in a workflow when the variable is prefixed by MAESTRO_. For more information, see the Maestro documentation on shell variables.

yaml

name: Basic Maestro Test

jobs:
  test:
    name: Run Maestro Tests
    type: maestro-cloud
    env:
      MAESTRO_APP_ID: 'com.yourhost.yourapp'
    params:
      build_id: ${{ needs.build_ios_simulator.outputs.build_id }}
      maestro_project_id: proj_01jw6hxgmdffrbye9fqn0pyzm0
      flows: ./maestro/flows

</Collapsible> <Collapsible summary="Using Maestro Cloud outputs in subsequent jobs">

This workflow runs Maestro Cloud tests and then uses the test results in a Slack notification.

yaml

name: Maestro Cloud with Notification

jobs:
  maestro_test:
    name: Run Maestro Cloud Tests
    type: maestro-cloud
    environment: preview
    params:
      build_id: ${{ needs.build.outputs.build_id }}
      maestro_project_id: proj_xyz
      flows: ./maestro/flows

  notify:
    name: Send Test Results
    after: [maestro_test]
    type: slack
    environment: production
    params:
      webhook_url: ${{ env.SLACK_WEBHOOK_URL }} # make sure to set it up in the right environment (see "environment: ..." above)
      message: 'Tests complete: ${{ after.maestro_test.outputs.successful_flows_count }}/${{ after.maestro_test.outputs.total_flows_count }} passed'

</Collapsible>

Slack

Send a message to a Slack channel using a Slack webhook URL.

Syntax

yaml

jobs:
  send_slack_notification:
    type: slack
    params:
      webhook_url: string # required
      message: string # required if payload is not provided
      payload: object # required if message is not provided

Parameters

You can pass the following parameters into the params list:

Parameter	Type	Description
webhook_url	string	Required. The Slack webhook URL to send the message to. Currently only hardcoded strings are supported. Using webhooks stored in `env` are upcoming but not yet supported.
message	string	Required if payload is not provided. The message to send.
payload	object	Required if message is not provided. The Slack Block Kit payload to send.

Examples

Here are some practical examples of using the Slack job:

This workflow builds an iOS app and then sends a notification with the app identifier and version from the build job outputs.

yaml

name: Build Notification

jobs:
  build_ios:
    name: Build iOS
    type: build
    params:
      platform: ios
      profile: production

  notify_build:
    name: Notify Build Status
    needs: [build_ios]
    type: slack
    params:
      webhook_url: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
      message: 'Build completed for app ${{ needs.build_ios.outputs.app_identifier }} (version ${{ needs.build_ios.outputs.app_version }})'

</Collapsible> <Collapsible summary="Rich build notification with Block Kit">

This workflow builds an Android app and sends a rich notification using the build job outputs.

yaml

name: Rich Build Notification

jobs:
  build_android:
    name: Build Android
    type: build
    params:
      platform: android
      profile: production

  notify_build:
    name: Notify Build Status
    needs: [build_android]
    type: slack
    params:
      webhook_url: https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
      payload:
        blocks:
          - type: header
            text:
              type: plain_text
              text: 'Build Completed'
          - type: section
            fields:
              - type: mrkdwn
                text: "*App:*\n${{ needs.build_android.outputs.app_identifier }}"
              - type: mrkdwn
                text: "*Version:*\n${{ needs.build_android.outputs.app_version }}"
          - type: section
            fields:
              - type: mrkdwn
                text: "*Build ID:*\n${{ needs.build_android.outputs.build_id }}"
              - type: mrkdwn
                text: "*Platform:*\n${{ needs.build_android.outputs.platform }}"
          - type: section
            text:
              type: mrkdwn
              text: 'Distribution: ${{ needs.build_android.outputs.distribution }}'

</Collapsible>

GitHub Comment

Automatically post reports of your workflow's completed builds, updates, and deployments to GitHub pull requests. It's particularly useful for providing instant feedback on PR builds, sharing test builds with QR codes for easy device testing, displaying EAS Hosting deployment previews, and automating deployment notifications. You can also override the comment contents by providing the payload parameter.

Prerequisites

To use the GitHub Comment job, your project must have a GitHub repository connected. Learn how to connect your GitHub repository to get started.

Syntax

yaml

jobs:
  github_comment:
    type: github-comment
    params:
      message: string # optional - custom message to include in the report
      build_ids: string[] # optional - specific build IDs to include, defaults to all related to the running workflow
      update_group_ids: string[] # optional - specific update group IDs to include, defaults to all related to the workflow
      deployment_ids: string[] # optional - specific deployment IDs to include, defaults to all related to the workflow

  # instead of using message and the builds, updates, and deployments table, you can also override the comment contents with `payload`
  custom_github_comment:
    type: github-comment
    params:
      payload: string # optional - raw markdown/HTML content for fully custom comment

Parameters

The job operates in two mutually exclusive modes:

Mode 1: Auto-with-overrides mode

Default behavior is auto discovery builds and updates, you can specify any of these parameters if you want to:

Parameter	Type	Description
message	string	Optional. Custom message to include at the top of the comment. Defaults to "Your builds, updates, and deployments are ready for testing!"
build_ids	string[]	Optional. Array of specific build IDs to include. If not specified, auto-discovers all completed/failed/canceled builds. Use empty array `[]` to exclude builds.
update_group_ids	string[]	Optional. Array of specific update group IDs to include. If not specified, auto-discovers all successful updates. Use empty array `[]` to exclude updates.
deployment_ids	string[]	Optional. Array of specific deployment IDs to include. If not specified, auto-discovers all successful deployments. Use empty array `[]` to exclude deployments.

Auto-discovery behavior: When build_ids, update_group_ids, or deployment_ids are not specified (undefined), the job automatically discovers all relevant builds, updates, and deployments from the current workflow. To explicitly exclude builds, updates, or deployments, pass an empty array [].

Mode 2: Payload mode

When using payload mode, you cannot specify any other parameters.

Parameter	Type	Description
payload	string	Raw markdown or HTML content to post as the comment. Supports workflow variable interpolation.

Outputs

You can reference the following outputs in subsequent jobs:

Output	Type	Description
comment_url	string	URL of the posted GitHub comment (only available when the comment is successfully posted).

Examples

Here are practical examples demonstrating both modes of the GitHub Comment job:

Auto-with-overrides mode examples

This is the simplest usage - automatically discovers and posts all builds, updates, and deployments from the workflow.

yaml

name: PR Auto Comment

on:
  pull_request: {}

jobs:
  # ...

  comment_on_pr:
    name: Post Results to PR
    after: [build_ios, build_android, publish_update, deploy]
    type: github-comment
    # No params needed - auto-discovers all builds, updates, and deployments

</Collapsible> <Collapsible summary="Custom message with auto-discovery">

Adds a custom message while still auto-discovering all builds, updates, and deployments.

yaml

name: PR Custom Message

on:
  pull_request: {}

jobs:
  # ...

  comment_on_pr:
    name: Post Build to PR
    after: [build_ios, build_android, publish_update, deploy]
    type: github-comment
    params:
      message: '🎉 Preview builds are ready! Please test these changes before approving the PR.'
      # build_ids, update_group_ids, and deployment_ids are undefined, so auto-discovery is enabled

</Collapsible> <Collapsible summary="PR preview with EAS Hosting deployment">

This workflow deploys a preview of your website using EAS Hosting and posts the deployment details to the pull request.

yaml

name: PR Preview

on:
  pull_request: {}

jobs:
  deploy:
    type: deploy
    name: Deploy PR Preview

  comment:
    needs: [deploy]
    type: github-comment

</Collapsible> <Collapsible summary="Specify exact builds and updates">

Explicitly specify which builds and updates to include in the comment.

yaml

name: PR Specific Builds

on:
  pull_request: {}

jobs:
  # ...

  comment_update:
    name: Post Update to PR
    after: [build_ios, build_android, publish_update]
    type: github-comment
    params:
      message: 'Testing builds ready for QA review'
      build_ids:
        - ${{ after.build_ios.outputs.build_id }}
        - ${{ after.build_android.outputs.build_id }}
      update_group_ids:
        - ${{ after.publish_update.outputs.first_update_group_id }}

</Collapsible> <Collapsible summary="Exclude builds, updates, or deployments">

Use empty arrays to exclude specific content types.

yaml

name: PR Updates Only

on:
  pull_request: {}

jobs:
  # ...

  comment_updates_only:
    name: Post Updates Only
    after: [publish_update]
    type: github-comment
    params:
      message: 'New update available for testing!'
      build_ids: [] # Empty array excludes all builds
      deployment_ids: [] # Empty array excludes all deployments
      # update_group_ids undefined = auto-discover updates

</Collapsible>

Payload mode examples

Payload mode gives you complete control over the comment content. Note that when using payload, you cannot specify any other parameters.

yaml

name: Custom PR Comment

on:
  pull_request: {}

jobs:
  # ...

  custom_comment:
    name: Post Custom Comment
    needs: [build_ios]
    type: github-comment
    params:
      # Payload mode: complete control over content
      # Cannot use message, build_ids, or update_group_ids with payload
      payload: |
        ## 🚀 Build Status Update

        ### iOS Build Completed
        - **Build ID**: `${{ needs.build_ios.outputs.build_id }}`
        - **Version**: ${{ needs.build_ios.outputs.app_version }}
        - **Build Number**: ${{ needs.build_ios.outputs.app_build_version }}

        ### Next Steps
        1. Download the build from [EAS Dashboard](https://expo.dev/accounts/[account]/projects/[project]/builds/${{ needs.build_ios.outputs.build_id }})
        2. Test on physical device
        3. Approve for TestFlight distribution

        ---
        *This comment was automatically generated by EAS Workflows*

</Collapsible> <Collapsible summary="Conditional comment based on build status">

This workflow posts different comments based on whether the build succeeded or failed.

yaml

name: Conditional PR Comment

on:
  pull_request: {}

jobs:
  build_android:
    name: Build Android
    type: build
    params:
      platform: android
      profile: preview

  comment_success:
    name: Post Success Comment
    needs: [build_android]
    if: ${{ needs.build_android.status == 'success' }}
    type: github-comment
    params:
      message: '✅ Android build succeeded! Ready for testing.'
      build_ids: # provided only for instructional purposes, you could as well omit this here
        - ${{ needs.build_android.outputs.build_id }}

  comment_failure:
    name: Post Failure Comment
    after: [build_android]
    if: ${{ after.build_android.status == 'failure' }}
    type: github-comment
    params:
      payload: |
        ❌ **Android build failed**

        Please check the [workflow logs](https://expo.dev/accounts/[account]/projects/[project]/workflows) for details.

</Collapsible>

Require Approval

Require approval from a user before continuing with the workflow. A user can approve or reject which translates to success or failure of the job.

Syntax

yaml

jobs:
  require_approval:
    type: require-approval

Parameters

This job doesn't take any parameters.

Examples

Here are some practical examples of using the Require Approval job:

This workflow deploys a web app to preview and then requires approval from a user before deploying to production.

yaml

jobs:
  web_preview:
    name: Deploy Web Preview
    type: deploy

  require_approval:
    name: Deploy Web to Production?
    needs: [web_preview]
    type: require-approval

  web_production:
    name: Deploy Web Production
    needs: [require_approval]
    type: deploy
    params:
      prod: true

</Collapsible> <Collapsible summary="Control flow of the workflow">

This workflow lets a user decide how the story ends by requiring approval before revealing the conclusion.

yaml

jobs:
  show_story_intro:
    name: Dragon and Knight Story Intro
    type: doc
    params:
      md: |
        # The Dragon and the Knight

        Once upon a time, in a land far away, a brave knight set out to face a mighty dragon.

        The dragon roared, breathing fire across the valley, but the knight stood firm, shield raised high.

        Now, the fate of their encounter is in your hands...

  require_approval:
    name: Should the knight and dragon become friends?
    needs: [show_story_intro]
    type: require-approval

  happy_ending:
    name: Friendship Ending
    needs: [require_approval]
    type: doc
    params:
      md: |
        ## A New Friendship

        The knight lowered his sword, and the dragon ceased its fire. They realized they both longed for peace. From that day on, they became the best of friends, protecting the kingdom together.

  epic_battle:
    name: Epic Battle Ending
    after: [require_approval]
    if: ${{ failure() }}
    type: doc
    params:
      md: |
        ## The Epic Battle

        The knight charged forward, and the dragon unleashed a mighty roar. Their battle shook the mountains and echoed through the ages. In the end, both were remembered as fierce and noble adversaries.

</Collapsible>

Doc

Displays a Markdown section in the workflow logs.

Syntax

yaml

jobs:
  show_whats_next:
    type: doc
    params:
      md: string

Parameters

You can pass the following parameters into the params list:

Parameter	Type	Description
md	string	Required. The Markdown content to display. You can use `${{ ... }}` workflow interpolation.

Examples

Here are some practical examples of using the Doc job:

This workflow builds an iOS app and then displays a Markdown section in the workflow logs.

yaml

jobs:
  build_ios:
    name: Build iOS
    type: build
    params:
      platform: ios
      profile: production

  submit:
    name: Submit to App Store
    type: submit
    needs: [build_ios]
    params:
      build_id: ${{ needs.build_ios.outputs.build_id }}
      profile: production

  next_steps:
    name: Next Steps
    needs: [submit]
    type: doc
    params:
      md: |
        # To do next

        Your app has just been sent to [App Store Connect](https://appstoreconnect.apple.com/apps).

        1. Download the app from TestFlight.
        2. Test the app a bunch.
        3. Submit the app for review.

</Collapsible>

Repack

Repackages an app from an existing build. This job repackages the app's metadata and JavaScript bundle without performing a full native rebuild, which is useful for creating a faster build compatible with a specific fingerprint.

Syntax

yaml

jobs:
  repack:
    type: repack
    runs_on: string # optional - see https://docs.expo.dev/build-reference/infrastructure/ for available options
    params:
      build_id: string # required
      profile: string # optional
      embed_bundle_assets: boolean # optional
      message: string # optional
      repack_version: string # optional

Common questions

Repack job is suitable for the following use cases:

Reducing CI build times by reusing existing builds
Trigging full native builds when required
Delivering faster feedback loops to your team

Repack job is not suitable for the following use cases:

Production builds that require builds to go through the complete pipeline for correct symbolication and app signing

</Collapsible> </FAQ>

Parameters

You can pass the following parameters into the params list:

Parameter	Type	Description
build_id	string	Required. The source build ID of the build to repack.
profile	string	Optional. The build profile to use. Defaults to the profile of the source build retrieved from `build_id`.
embed_bundle_assets	boolean	Optional. Whether to embed the bundle assets in the repacked build. By default, this is automatically determined based on the source build.
message	string	Optional. Custom message attached to the build. Corresponds to the `--message` flag when running `eas build`.
repack_version	string	Optional. The version of the `@expo/repack-app` to use. Defaults to the latest version.

Examples

Here are some practical examples of using the Fingerprint with Repack jobs:

This workflow first generates a fingerprint and then builds or repacks the app depending on whether a compatible build for that fingerprint already exists. Finally, it runs Maestro tests.

yaml

name: continuous-deploy-fingerprint

jobs:
  fingerprint:
    id: fingerprint
    type: fingerprint
    # @info Match your build profile's environment #
    environment: production
    # @end #

  android_get_build:
    needs: [fingerprint]
    id: android_get_build
    type: get-build
    params:
      fingerprint_hash: ${{ needs.fingerprint.outputs.android_fingerprint_hash }}
      platform: android

  android_repack:
    needs: [android_get_build]
    id: android_repack
    if: ${{ needs.android_get_build.outputs.build_id }}
    type: repack
    params:
      build_id: ${{ needs.android_get_build.outputs.build_id }}

  android_build:
    needs: [android_get_build]
    id: android_build
    if: ${{ !needs.android_get_build.outputs.build_id }}
    type: build
    params:
      platform: android
      profile: preview-simulator

  android_maestro:
    after: [android_repack, android_build]
    id: android_maestro
    type: maestro
    image: latest
    params:
      build_id: ${{ needs.android_repack.outputs.build_id || needs.android_build.outputs.build_id }}
      flow_path: ['maestro.yaml']

  ios_get_build:
    needs: [fingerprint]
    id: ios_get_build
    type: get-build
    params:
      fingerprint_hash: ${{ needs.fingerprint.outputs.ios_fingerprint_hash }}
      platform: ios

  ios_repack:
    needs: [ios_get_build]
    id: ios_repack
    if: ${{ needs.ios_get_build.outputs.build_id }}
    type: repack
    params:
      build_id: ${{ needs.ios_get_build.outputs.build_id }}

  ios_build:
    needs: [ios_get_build]
    id: ios_build
    if: ${{ !needs.ios_get_build.outputs.build_id }}
    type: build
    params:
      platform: ios
      profile: preview-simulator

  ios_maestro:
    after: [ios_repack, ios_build]
    id: ios_maestro
    type: maestro
    image: latest
    params:
      build_id: ${{ needs.ios_repack.outputs.build_id || needs.ios_build.outputs.build_id }}
      flow_path: ['maestro.yaml']

</Collapsible>