Automating app distribution with DeployGate using the GitHub Actions

by Ryosuke Horie

Slide 1

Slide 1 text

Slide 2

Slide 2 text

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

© ZOZO Technologies, Inc. https://wear.jp/  ・日本最大級のファッションコーディネートアプリ  ・ 1,300万ダウンロード突破、コーディネート投稿総数は800万件   以上（ともに2019年3月末時点）  ・全世界（App Store / Google Playが利用可能な全ての国）で  ダウンロードが可能  ・ 10万人以上のフォロワーを持つユーザー（WEARISTA）も誕生  5

Slide 6

Slide 6 text

Slide 7

Slide 7 text

Slide 8

Slide 8 text

Slide 9

Slide 9 text

Slide 10

Slide 10 text

© ZOZO Technologies, Inc. どう作るか？  10 ● Pull Requestを作成したタイミングでビルドを実行  ● ブランチごとにDeployGateの配布ページでアプリを配布  ○ 配布ページは無制限に作成できdistribution_nameパラメータで配布ページを自動生成可能  ○ Pull Requestのcompareで指定するブランチ名で配布ページを作成  ○ 参考: gitのブランチごとに別のバージョンのアプリをDeployGateで並行して配信する 

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Slide 13

Slide 13 text

Slide 14

Slide 14 text

© ZOZO Technologies, Inc. CIサービスの選択  14 ● ZOZOTOWN、WEARチームではBitriseを使用  ● BitriseのPull Requestトリガーで実行するWorkflowのstepを増やしたくない  ○ ビルド時間が伸びるのを防ぎたい  ● 別チームがZOZOテクノロジーズのOrganizationでGitHub Actionsの検証を開始  ● ZOZOTOWN AndroidチームでもGitHub Actionsを検証を兼ねて利用してみることに決定 

Slide 15

Slide 15 text

Slide 16

Slide 16 text

Slide 17

Slide 17 text

© ZOZO Technologies, Inc. Workflowの構成要素  17 ● 次の3つが基本の構成要素  ○ Job  ■ Stepから構成されるタスクの定義  ■ 並列・シーケンシャルでの実行が可能  ○ Step  ■ Jobが実行するタスクの集合  ■ コマンドまたはActionを実行可能  ○ Action  ■ CircleCI Orbのような仕組み  ■ 特定の処理・設定をまとめてパッケージ化されたものを利用可能  ■ 自作のカスタムアクションを作成し公開することも可能 

Slide 18

Slide 18 text

Slide 19

Slide 19 text

© ZOZO Technologies, Inc. 19 name: Android CI on Pull Request on: pull_request jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8 - name: Build with Gradle run: ./gradlew assemblDebug - name: Distribute App run: | curl \ -F "token=${{secrets.DEPLOYGATE_TOKEN}}" \ -F "file=@app/build/outputs/apk/debug/app-debug.apk" \ -F "message=git-hash:`git rev-parse --short $GITHUB_SHA`" \ -F "distribution_name=$GITHUB_HEAD_REF" \ https://deploygate.com/api/users/${{secrets.DEPLOYGATE_USER}}/apps

Slide 20

Slide 20 text

© ZOZO Technologies, Inc. 20 name: Android CI on Pull Request #Workflow名 on: pull_request jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8 - name: Build with Gradle run: ./gradlew assemblDebug - name: Distribute App run: | curl \ -F "token=${{secrets.DEPLOYGATE_TOKEN}}" \ -F "file=@app/build/outputs/apk/debug/app-debug.apk" \ -F "message=git-hash:`git rev-parse --short $GITHUB_SHA`" \ -F "distribution_name=$GITHUB_HEAD_REF" \ https://deploygate.com/api/users/${{secrets.DEPLOYGATE_USER}}/apps

Slide 21

Slide 21 text

© ZOZO Technologies, Inc. 21 name: Android CI on Pull Request on: pull_request #Pull RequestのタイミングでWorkflowをトリガー jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8 - name: Build with Gradle run: ./gradlew assemblDebug - name: Distribute App run: | curl \ -F "token=${{secrets.DEPLOYGATE_TOKEN}}" \ -F "file=@app/build/outputs/apk/debug/app-debug.apk" \ -F "message=git-hash:`git rev-parse --short $GITHUB_SHA`" \ -F "distribution_name=$GITHUB_HEAD_REF" \ https://deploygate.com/api/users/${{secrets.DEPLOYGATE_USER}}/apps

Slide 22

Slide 22 text

© ZOZO Technologies, Inc. WorkflowのトリガーとなるGitHubイベント名   ● on: イベント名  ● 1つまたは複数のイベントを指定可能  ● Pull Requestのタイミングでトリガーにしたい場合 pull_request を指定  ● 指定できるイベント名は次のドキュメントにまとまっている  ○ https://help.github.com/en/articles/events-that-trigger-workflows  22

Slide 23

Slide 23 text

© ZOZO Technologies, Inc. 23 name: Android CI on Pull Request on: pull_request jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8 - name: Build with Gradle run: ./gradlew assemblDebug - name: Distribute App run: | curl \ -F "token=${{secrets.DEPLOYGATE_TOKEN}}" \ -F "file=@app/build/outputs/apk/debug/app-debug.apk" \ -F "message=git-hash:`git rev-parse --short $GITHUB_SHA`" \ -F "distribution_name=$GITHUB_HEAD_REF" \ https://deploygate.com/api/users/${{secrets.DEPLOYGATE_USER}}/apps

Slide 24

Slide 24 text

© ZOZO Technologies, Inc. 24 name: Android CI on Pull Request on: pull_request jobs: #Jobの定義 build: #Job id runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8 - name: Build with Gradle run: ./gradlew assemblDebug - name: Distribute App run: | curl \ -F "token=${{secrets.DEPLOYGATE_TOKEN}}" \ -F "file=@app/build/outputs/apk/debug/app-debug.apk" \ -F "message=git-hash:`git rev-parse --short $GITHUB_SHA`" \ -F "distribution_name=$GITHUB_HEAD_REF" \ https://deploygate.com/api/users/${{secrets.DEPLOYGATE_USER}}/apps

Slide 25

Slide 25 text

© ZOZO Technologies, Inc. Jobの定義とJob id  ● Jobs 以下に複数のJobを定義可能  ○ デフォルトではJobは平行に実行される  ● 各jobごとに違う名前(Job id)を使用        ● needsキーワードを使用するとJobの依存関係を定義可能  25 jobs: build: #Job id build2: #Job id build3: #Job id jobs: build: build2: needs: build build3: needs: [build, build2]

Slide 26

Slide 26 text

© ZOZO Technologies, Inc. 26 name: Android CI on Pull Request on: pull_request jobs: build: runs-on: ubuntu-latest #Jobを実行する仮想マシンの種類 steps: - uses: actions/checkout@v1 - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8 - name: Build with Gradle run: ./gradlew assemblDebug - name: Distribute App run: | curl \ -F "token=${{secrets.DEPLOYGATE_TOKEN}}" \ -F "file=@app/build/outputs/apk/debug/app-debug.apk" \ -F "message=git-hash:`git rev-parse --short $GITHUB_SHA`" \ -F "distribution_name=$GITHUB_HEAD_REF" \ https://deploygate.com/api/users/${{secrets.DEPLOYGATE_USER}}/apps

Slide 27

Slide 27 text

© ZOZO Technologies, Inc. 27 name: Android CI on Pull Request on: pull_request jobs: build: runs-on: ubuntu-latest steps: #Stepの定義書かれた順に実行 - uses: actions/checkout@v1 - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8 - name: Build with Gradle run: ./gradlew assemblDebug - name: Distribute App run: | curl \ -F "token=${{secrets.DEPLOYGATE_TOKEN}}" \ -F "file=@app/build/outputs/apk/debug/app-debug.apk" \ -F "message=git-hash:`git rev-parse --short $GITHUB_SHA`" \ -F "distribution_name=$GITHUB_HEAD_REF" \ https://deploygate.com/api/users/${{secrets.DEPLOYGATE_USER}}/apps

Slide 28

Slide 28 text

© ZOZO Technologies, Inc. name: Android CI on Pull Request on: pull_request jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 #usesでactions/checkoutを使用しソースコードをCheckout - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8 - name: Build with Gradle run: ./gradlew assemblDebug - name: Distribute App run: | curl \ -F "token=${{secrets.DEPLOYGATE_TOKEN}}" \ -F "file=@app/build/outputs/apk/debug/app-debug.apk" \ -F "message=git-hash:`git rev-parse --short $GITHUB_SHA`" \ -F "distribution_name=$GITHUB_HEAD_REF" \ https://deploygate.com/api/users/${{secrets.DEPLOYGATE_USER}}/apps 28

Slide 29

Slide 29 text

© ZOZO Technologies, Inc. usesキーワード  ● StepはコマンドまたはActionを実行可能  ● usesキーワードにより公開されているActionをStepの中で使用  ● actions/checkoutはGitHubが公開しているAction  ○ https://github.com/actions/checkout  ● ActionはMarketplaceで探せる他、3rdパーティ製ActionをまとめたRepositoryがある  ○ https://github.com/marketplace?type=actions  ○ https://github.com/sdras/awesome-actions    29

Slide 30

Slide 30 text

© ZOZO Technologies, Inc. name: Android CI on Pull Request on: pull_request jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - name: set up JDK 1.8 uses: actions/setup-java@v1 #usesでactions/setup-javaを使用しJDKをSetup with: #withでActionへパラメータを渡す java-version: 1.8 - name: Build with Gradle run: ./gradlew assemblDebug - name: Distribute App run: | curl \ -F "token=${{secrets.DEPLOYGATE_TOKEN}}" \ -F "file=@app/build/outputs/apk/debug/app-debug.apk" \ -F "message=git-hash:`git rev-parse --short $GITHUB_SHA`" \ -F "distribution_name=$GITHUB_HEAD_REF" \ https://deploygate.com/api/users/${{secrets.DEPLOYGATE_USER}}/apps 30

Slide 31

Slide 31 text

© ZOZO Technologies, Inc. name: Android CI on Pull Request on: pull_request jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8 - name: Build with Gradle run: ./gradlew assemblDebug #buildType debugでAPKをビルド - name: Distribute App run: | curl \ -F "token=${{secrets.DEPLOYGATE_TOKEN}}" \ -F "file=@app/build/outputs/apk/debug/app-debug.apk" \ -F "message=git-hash:`git rev-parse --short $GITHUB_SHA`" \ -F "distribution_name=$GITHUB_HEAD_REF" \ https://deploygate.com/api/users/${{secrets.DEPLOYGATE_USER}}/apps 31

Slide 32

Slide 32 text

© ZOZO Technologies, Inc. name: Android CI on Pull Request on: pull_request jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - name: set up JDK 1.8 uses: actions/setup-java@v1 with: java-version: 1.8 - name: Build with Gradle run: ./gradlew assemblDebug - name: Distribute App run: | #cURLコマンドでDeployGateへAPKをアップロード curl \ -F "token=${{secrets.DEPLOYGATE_TOKEN}}" \ -F "file=@app/build/outputs/apk/debug/app-debug.apk" \ -F "message=git-hash:`git rev-parse --short $GITHUB_SHA`" \ -F "distribution_name=$GITHUB_HEAD_REF" \ https://deploygate.com/api/users/${{secrets.DEPLOYGATE_USER}}/apps 32

Slide 33

Slide 33 text

Slide 34

Slide 34 text

Slide 35

Slide 35 text

© ZOZO Technologies, Inc. ブランチ名の取得  ● 環境変数に関するドキュメントを確認  ○ https://help.github.com/en/articles/virtual-environments-for-github-actions  ● 環境変数GITHUB_REFでWorkflowのトリガーとなったブランチのrefを取得可能とある  ○ 実際に試すと refs/pull//merge と返ってくる  ○ 同様にGITHUB_SHAはWorkflowをトリガーとなったコミットを指していない  ● 暫定で環境変数GITHUB_HEAD_REFからブランチ名を取得  ○ ドキュメントではForkしたRepositoryのみに設定とあるが通常のRepositoryでも取得できてしまっている  35

Slide 36

Slide 36 text

© ZOZO Technologies, Inc. まとめ  ● GitHub ActionsでPull RequestをトリガーにDeployGateでのアプリ配布を簡単に実現できた  ● GitHub Actionsは豊富なGitHubのイベントをトリガーにWorkflowを実行できる  ○ GitHubを中心とした開発フローの自動化がとてもやりやすい  ● 自作Actionの作成も可能なのでDeployGateでの配布をActionとして公開したい  36