Skip to content
autifyhq

GitHub Action

Run test on Autify for Mobile

v2.5.0 Latest version

Run test on Autify for Mobile

autifyhq

Run test on Autify for Mobile

Run a test plan on Autify for Mobile

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Run test on Autify for Mobile

              
  uses: autifyhq/actions-mobile-test-run@v2.5.0
Learn more about this action in autifyhq/actions-mobile-test-run

Choose a version

actions-mobile-test-run status

Run test on Autify for Mobile

Run a test plan on Autify for Mobile.

See our official documentation to get started: https://help.autify.com/mobile/docs/github-actions-integration

Usage

Run a test plan with a build ID

- uses: autifyhq/actions-mobile-test-run@v2
  with:
    access-token: ${{ secrets.AUTIFY_MOBILE_ACCESS_TOKEN }}
    autify-test-url: https://mobile-app.autify.com/projects/<ID>/test_plans/<ID>
    build-id: AAA

This will succeed immediately once the test is started but won't wait the finish of the test.

Run and wait a test plan with a build ID

- uses: autifyhq/actions-mobile-test-run@v2
  with:
    access-token: ${{ secrets.AUTIFY_MOBILE_ACCESS_TOKEN }}
    autify-test-url: https://mobile-app.autify.com/projects/<ID>/test_plans/<ID>
    build-id: AAA
    wait: true
    timeout: 300

This will keep running the action until the test finishes or times out.

Note: This will consume your GitHub Actions hosted runner's minutes. Be careful when extending the timeout value.

Run a test plan with a build file

- uses: autifyhq/actions-mobile-test-run@v2
  with:
    access-token: ${{ secrets.AUTIFY_MOBILE_ACCESS_TOKEN }}
    autify-test-url: https://mobile-app.autify.com/projects/<ID>/test_plans/<ID>
    build-path: /path/to/my.[app|apk]

This will upload the build file first, then start the test plan with the new build ID.

Options

access-token:
  required: true
  description: "Access token of Autify for Mobile."
autify-test-url:
  required: true
  description: "URL of a test plan e.g. https://moible-app.autify.com/projects/<ID>/test_plans/<ID>"
build-id:
  required: false
  description: "ID of the already uploaded build. (Note: Either build-id or build-path is required but not both)"
build-path:
  required: false
  description: "File path to the iOS app (*.app) or Android app (*.apk). (Note: Either build-id or build-path is required but not both)"
wait:
  required: false
  default: "false"
  description: "When true, the action waits until the test finishes."
timeout:
  required: false
  description: "Timeout seconds when waiting."
max-retry-count:
  required: false
  description: "Maximum retry count while waiting. The command can take up to `timeout * (max-retry-count + 1)`. Only effective with `wait`"
autify-path:
  required: false
  default: "autify"
  description: "A path to `autify` which will be used to invoke Autify CLI internally. Default is searching from PATH."
autify-cli-installer-url:
  required: false
  default: "https://autify-cli-assets.s3.amazonaws.com/autify-cli/channels/stable/install-cicd.bash"
  description: "Autify CLI installer URL"

Outputs

exit-code:
  description: "Exit code of autify-cli. 0 means succeeded."
log:
  description: "Log of stdout and stderr."
build-id:
  description: "Returned build id on the workspace."
result-url:
  description: "Test result URL on Autify for Mobile"

Migrations

v2 from v1

Most of the case, v2 is compatible with v1 inputs. Please try to migrate to v2 because v1 is no more maintained.