Flutterでステージング環境やテスト環境へのデプロイを自動化 & 本番環境と共存させる【GitHub Actions x Firebase App Distribution】

name: Deploy dev ios

on:
  # mainブランチへのマージでデプロイしたい場合 publicリポジトリだと無料なのでこれでいいと思う
  push:
    branches:
     - main
  # macOSはGitHubActionsの時間数を食うのでプライベートリポジトリの場合は自分はしたい時だけ手動でdev環境にデプロイしてます(できればmainブランチpushでトリガーしたい)
  workflow_dispatch:
jobs:
  build_ios:
    runs-on: macos-latest
    env:
      BUILD_CERTIFICATE_BASE64: ${{ secrets.IOS_P12_BASE64 }}
      P12_PASSWORD: ${{ secrets.IOS_P12_PASSWORD }}
      BUILD_PROVISION_PROFILE_BASE64: ${{ secrets.IOS_PROVISION_PROFILE_BASE64 }}
      KEYCHAIN_PASSWORD: ${{ secrets.IOS_KEYCHAIN_PASSWORD }}
      APPLICATION_NAME: exampleApp # bundleIDの最後の要素のアプリ名
      TEAM_NAME: exampleTeam # プロジェクトのチームや会社名
    steps:
      - uses: actions/checkout@v2
      - name: cache flutter dependencies
        uses: actions/cache@v2
        with:
          path: /Users/runner/hostedtoolcache/flutter
          key: ${{ runner.os }}-flutter
      - name: install flutter
        uses: subosito/flutter-action@v1
        with:
          flutter-version: '2.5.0'
      - name: set up environment
        run: |
          cat ios/envs/dev/Release.xcconfig >> ios/Flutter/Release.xcconfig
          cp -f ios/envs/dev/ExportOptions.plist ios/
          cp -f ios/envs/dev/GoogleService-Info.plist ios/
      - name: set up provisioning profile
        # <https://docs.github.com/ja/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development>
        run: |
          CERTIFICATE_PATH=$RUNNER_TEMP/$TEAM_NAME.p12
          PP_PATH=$RUNNER_TEMP/$APPLICATION_NAME.mobileprovision
          KEYCHAIN_PATH=$RUNNER_TEMP/$TEAM_NAME.keychain-db
          echo -n "$BUILD_CERTIFICATE_BASE64" | base64 --decode --output $CERTIFICATE_PATH
          echo -n "$BUILD_PROVISION_PROFILE_BASE64" | base64 --decode --output $PP_PATH
          security create-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
          security set-keychain-settings -lut 21600 $KEYCHAIN_PATH
          security unlock-keychain -p "$KEYCHAIN_PASSWORD" $KEYCHAIN_PATH
          security import $CERTIFICATE_PATH -P "$P12_PASSWORD" -A -t cert -f pkcs12 -k $KEYCHAIN_PATH
          security list-keychain -d user -s $KEYCHAIN_PATH
          mkdir -p ~/Library/MobileDevice/Provisioning\\ Profiles
          cp $PP_PATH ~/Library/MobileDevice/Provisioning\\ Profiles
      - name: install dependencies
        run: |
          flutter pub get
          find . -name "Podfile" -execdir pod install \\;
      - name: build ios app
        run: |
          flutter build ipa \\
          --release \\
          --export-options-plist=ios/ExportOptions.plist \\
      - name: upload artifact
        uses: actions/upload-artifact@v2
        with:
          name: ios-build
          path: build/ios/ipa/example_app.ipa
      - name: clean up keychain and provisioning profile
        if: ${{ always() }}
        run: |
          security delete-keychain $RUNNER_TEMP/$TEAM_NAME.keychain-db
          rm ~/Library/MobileDevice/Provisioning\\ Profiles/$APPLICATION_NAME.mobileprovision
  deploy_ios:
    runs-on: macos-latest
    needs: build_ios
    env:
      GCP_PROJECT_ID: example-app
      GCP_SA_KEY: ${{ secrets.GCP_SA_KEY_BASE64 }}
      APP_ID: example-app-id # Firebaseのやつ
      RELEASE_BINARY_PATH: ios/example_app.ipa
      RELEASE_NOTES_PATH: ios/release-notes.txt
      TESTER_GROUPS: example-app-group
    steps:
      - uses: actions/checkout@v2
      - name: download artifact
        uses: actions/download-artifact@master
        with:
          name: ios-build
          path: ios
      - name: set up cloud sdk
        uses: google-github-actions/setup-gcloud@master
        with:
          project_id: ${{ env.GCP_PROJECT_ID }}
          service_account_key: ${{ env.GCP_SA_KEY }}
          export_default_credentials: true
      - name: install firebase
        run: curl -sL <https://firebase.tools> | bash
      - name: deploy
        run: firebase appdistribution:distribute $RELEASE_BINARY_PATH --app $APP_ID --release-notes-file "$RELEASE_NOTES_PATH" --groups "$TESTER_GROUPS"

...
steps:
  # 省略
  - name: set up environment
    run: |
      cat ios/envs/dev/Release.xcconfig >> ios/Flutter/Release.xcconfig
      cp -f ios/envs/dev/ExportOptions.plist ios/
      cp -f ios/envs/dev/GoogleService-Info.plist ios/

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "<http://www.apple.com/DTDs/PropertyList-1.0.dtd>">
<plist version="1.0">
<dict>
    <key>compileBitcode</key>
    <true/>
    <key>destination</key>
    <string>export</string>
    <key>method</key>
    <string>ad-hoc</string> // 配布形式 本番ならapp-storeとかになる
    <key>provisioningProfiles</key>
    <dict>
        <key>com.exampleTeam.exampleAppDev</key> // Apple Bundle ID
        <string>exampleAppDev</string> // Provisioning Profile ファイル名
    </dict>
    <key>signingCertificate</key>
    <string>Apple Distribution</string>
    <key>signingStyle</key>
    <string>manual</string>
    <key>stripSwiftSymbols</key>
    <true/>
    <key>teamID</key>
    <string>ADZK6RM6CL</string> // チームID
    <key>thinning</key>
    <string>&lt;none&gt;</string>
</dict>
</plist>

DISPLAY_APPLICATION_NAME=exampleAppDev # 表示するアプリ名
BUNDLE_ID_SUFFIX=exampleAppDev # BundleIDの最後のやつ
PROVISIONING_PROFILE_NAME=exampleAppDev # Provisioning Profile ファイル名

DISPLAY_APPLICATION_NAME=exampleAppDev
BUNDLE_ID_SUFFIX=exampleAppDev

PRODUCT_BUNDLE_IDENTIFIER = com.exampleTeam.$(BUNDLE_ID_SUFFIX);

PROVISIONING_PROFILE_SPECIFIER = "$(PROVISIONING_PROFILE_NAME)";

XXXXXXXXXXXXXXX / * Profile * / = {
...
    PRODUCT_BUNDLE_IDENTIFIER = "com.exampleTeam.$(BUNDLE_ID_SUFFIX)";
    PRODUCT_NAME = xxxxxxxxxxx;
    PROVISIONING_PROFILE_SPECIFIER = "$(PROVISIONING_PROFILE_NAME)";
...
}

XXXXXXXXXXXXXXX / * Debug * / = {
...
    PRODUCT_BUNDLE_IDENTIFIER = "com.exampleTeam.$(BUNDLE_ID_SUFFIX)";
    PRODUCT_NAME = xxxxxxxxxxx;
    PROVISIONING_PROFILE_SPECIFIER = "$(PROVISIONING_PROFILE_NAME)";
...
}

XXXXXXXXXXXXXXX / * Release * / = {
...
    PRODUCT_BUNDLE_IDENTIFIER = "com.exampleTeam.$(BUNDLE_ID_SUFFIX)";
    PRODUCT_NAME = xxxxxxxxxxx;
    PROVISIONING_PROFILE_SPECIFIER = "$(PROVISIONING_PROFILE_NAME)";
...
}

<dict>
<!-- 省略 -->
    <key>CFBundleName</key>
    <string>$(DISPLAY_APPLICATION_NAME)</string>
    <key>CFBundleDisplayName</key>
    <string>$(DISPLAY_APPLICATION_NAME)</string>
<!-- 省略 -->
</dict>

      - name: import app icon
        run: flutter pub run flutter_launcher_icons:main -f flutter_icons-dev.yml

# <https://pub.dev/packages/flutter_launcher_icons>
# flutter pub run flutter_launcher_icons:main -f flutter_icons-dev.yml
flutter_icons:
  android: true
  ios: true
  image_path: "assets/launcher_icon/icon-dev.png"

jobs:
  build_ios:
    # jobs配下のenvならrunnerの環境変数として$~~で読み込み可能
    env:
      EXAMPLE_ENV: example-env-value
...
      - name: build ios app
        run: |
          flutter build ipa \\
          --release \\
          --export-options-plist=ios/ExportOptions.plist \\
          --dart-define=EXAMPLE_ENV=$EXAMPLE_ENV

      - name: upload artifact
        uses: actions/upload-artifact@v2
        with:
          name: ios-build
          path: build/ios/ipa/exampleApp.ipa # DISPLAY_APPLICATION_NAME.ipa

      - name: download artifact
        uses: actions/download-artifact@master
        with:
          name: ios-build
          path: ios

      - name: set up cloud sdk
        uses: google-github-actions/setup-gcloud@master
        with:
          project_id: ${{ env.GCP_PROJECT_ID }}
          service_account_key: ${{ env.GCP_SA_KEY }}
          export_default_credentials: true

      APP_ID: xxxxxxxxxxxxx # Firebaseでアプリ作成したときののApp ID
      RELEASE_BINARY_PATH: ios/exampleApp.ipa # DISPLAY_APPLICATION_NAME.ipa
      RELEASE_NOTES_PATH: ios/release-notes.txt # このファイル作っておいたらrelease notes変更できる
      TESTER_GROUPS: example-team # testerは　firebase コンソール上から作成可能。ない場合エラー出る。

...
      - name: install firebase
        run: curl -sL <https://firebase.tools> | bash
      - name: deploy
        run: firebase appdistribution:distribute $RELEASE_BINARY_PATH --app $APP_ID --release-notes-file "$RELEASE_NOTES_PATH" --groups "$TESTER_GROUPS"

name: Deploy dev android

on:
  # androidはmainブランチにマージされた時点でdev環境にデプロイされる
  push:
    branches:
      - main
  workflow_dispatch:
jobs:
  build_android:
    runs-on: ubuntu-latest
    env:
      # NOTE: android/app/build.gradleで下記STORE_FILE_PATHを直接指定している
      STORE_FILE_PATH: android/release.keystore
      KEYSTORE_PASSWORD: ${{ secrets.KEYSTORE_PASSWORD }}
      KEY_ALIAS: ${{ secrets.KEY_ALIAS }}
      KEY_PASSWORD: ${{ secrets.KEY_PASSWORD }}
      APPLICATION_NAME: example_app # applicationIdの最後の要素のアプリ名
    steps:
      - uses: actions/checkout@v2
      - name: Cache Flutter dependencies
        uses: actions/cache@v2
        with:
          path: /opt/hostedtoolcache/flutter
          key: ${{ runner.os }}-flutter
      - name: install flutter
        uses: subosito/flutter-action@v1
        with:
          flutter-version: '2.5.0'
      - name: set up config
        run: cp android/envs/dev/google-services.json android/app/
      - name: create store file for sign
        run: echo "${{ secrets.KEYSTORE_BASE64 }}" | base64 -d > $STORE_FILE_PATH
      - name: install dependencies
        run: flutter pub get
      - name: build android app
        run: |
          flutter build appbundle \\
          --release \\
      - name: upload artifact
        uses: actions/upload-artifact@v2
        with:
          name: android-build
          path: build/app/outputs/bundle/release/app-release.aab

  deploy_android:
    runs-on: ubuntu-latest
    needs: build_android
    env:
      GCP_PROJECT_ID: example-app
      GCP_SA_KEY: ${{ secrets.GCP_SA_KEY_BASE64 }}
      APP_ID: example-app-id # Firebaseのやつ
      RELEASE_BINARY_PATH: android/app-release.aab
      RELEASE_NOTES_PATH: android/release-notes.txt
      TESTER_GROUPS: example-app-group
    steps:
      - uses: actions/checkout@v2
      - name: download artifact
        uses: actions/download-artifact@master
        with:
          name: android-build
          path: android
      - name: set up cloud sdk
        uses: google-github-actions/setup-gcloud@master
        with:
          project_id: ${{ env.GCP_PROJECT_ID }}
          service_account_key: ${{ env.GCP_SA_KEY }}
          export_default_credentials: true
      - name: install firebase
        run: curl -sL <https://firebase.tools> | bash
      - name: deploy
        run: firebase appdistribution:distribute $RELEASE_BINARY_PATH --app $APP_ID --release-notes-file "$RELEASE_NOTES_PATH" --groups "$TESTER_GROUPS"