GitHub Actions 連携

Autify ではお手持ちのGitHub Actions workflow から簡単にビルドをアップロードしたりテストプランを実行できる公式のGitHub Actions を提供しています。

はじめてみよう

このドキュメントでは、皆さんのGitHub リポジトリでどのようにAutify のGitHub Actions 連携を利用するかを順に説明していきます。

前提条件

まず、すでにGitHub Actions workflow を使ってアプリケーションのビルドを行なっているものとします。そのビルドstep のすぐ後にAutify のテストを実行するstep を追加することで、新しくビルドされたアプリケーションがエンドツーエンドのユーザ体験を損ねていないことを確認できるようにします。

次に、Autify for Mobile でテストプランを作成する必要があります。テストプランのURL (例: https://mobile-app.autify.com/projects/AAA/test_plans/BBB) をメモしておいてください、後ほど利用します。

さらに、パーソナルアクセストークンを生成する必要があります。後ほどGitHub Actions Secrets に保存するために、生成されたトークンはどこかにメモしておいて下さい。

注: パーソナルアクセストークンは1人のユーザに紐づいてしまうので、CI/CD 連携のために組織にマシンユーザを作って、そのパーソナルアクセストークンを使うことをお勧めします。

パーソナルアクセストークンをGitHub Actions Secrets に保存

上で生成したパーソナルアクセストークンをGitHub のドキュメントに従って、Secrets に保存します。Secret の名前は任意ですが、その名前はGitHub Actions を定義するときに参照します。ここではAUTIFY_MOBILE_ACCESS_TOKEN と命名したと仮定しておきます。

Autify for Mobile にビルドをアップロードしたりテストを実行するGitHub Actions step を追加

それでは、お手持ちのGitHub Actions workflow に新しいstep を追加しましょう。以下の例を参考にしてください。autify-test-url の値は、上でメモしたURL になります。

• Run test on Autify for Mobile · Actions · GitHub Marketplace
• Upload build to Autify for Mobile · Actions · GitHub Marketplace

新しいビルドファイルをアップロードしてテストを開始する (テストの完了は待たない):

- uses: autifyhq/actions-mobile-test-run@v2
  with:
    access-token: ${{ secrets.AUTIFY_MOBILE_ACCESS_TOKEN }}
    autify-test-url: https://mobile-app.autify.com/projects/AAA/test_plans/BBB
    build-path: /path/to/your-[ios.app|android.apk]

もしテストが完了するか、タイムアウトするまで待つ場合:

- uses: autifyhq/actions-mobile-test-run@v2
  with:
    access-token: ${{ secrets.AUTIFY_MOBILE_ACCESS_TOKEN }}
    autify-test-url: https://mobile-app.autify.com/projects/AAA/test_plans/BBB
    build-path: /path/to/your-[ios.app|android.apk]
    wait: true
    timeout: 300

警告: この設定はテスト完了を待っている間もGitHub Actions hosted runner の時間を消費します。タイムアウトを延長するときは注意してください。

新しいビルドファイルをアップロードするだけ (workspace-id は上でメモしたURL の/projects/ のすぐ後ろのid):

- uses: autifyhq/actions-mobile-build-upload@v2
  with:
    access-token: ${{ secrets.AUTIFY_MOBILE_ACCESS_TOKEN }}
    workspace-id: AAA
    build-path: /path/to/your-[ios.app|android.apk]

まとめ

Autify のGitHub Actions を使うことで、ビルド後にテストプランの実行を自動化できるので、無駄な時間を使うことなくリグレッションをすぐに検知して適切な行動を取ることができるようになります。