[Feature]: アプリ ID 設定についての Issue 自動生成とツールを開発する

[Kotaro666-dev]

概要

close: #179

本 PR で対象とするアプリ ID 設定周りの変更箇所は、以下のコメントにまとめています。

https://github.com/yumemi-inc/flutter-mobile-project-template/issues/179#issuecomment-2062874553

レビュー観点

• 期待されている処理が正常に実行されているか
• スクリプト内に怪しい箇所や考慮漏れしているところがないか

レビューレベル

• [ ] Lv1: ぱっとみて違和感がないかチェックして Approve する
• [x] Lv2: 仕様レベルまで理解して、仕様通りに動くかある程度検証して Approve する
• [ ] Lv3: 実際に環境で動作確認したうえで Approve する

レビュー優先度

• [ ] すぐに見てもらいたい ( hotfix など ) 🚀
• [ ] 今日中に見てもらいたい 🚗
• [ ] 今日〜明日中で見てもらいたい 🚶
• [x] 数日以内で見てもらいたい 🐢

画像 / 動画

UI 上の変更はないため、スキップします。

動作確認手順

以下の Markdown に記載された内容でローカル環境で実行してみてください。

https://github.com/yumemi-inc/flutter-mobile-project-template/compare/feature/179-implement-rename-application-id-tool?expand=1#diff-22ed6bde2623390ae1aa07ef45a9d539795b9f2d345987aaecd748297225aac8

動作検証時のログ

bash-3.2$ pwd
/Users/k_kamashima/flutter-mobile-project-template/scripts
bash-3.2$ bash scripts/rename-application-id.sh "com.example.rename"
Starting application ID renaming process...
[Step1] Replacing the application ID definition in the configuration JSON files within the flavor directory...
   Modifying file: /Users/k_kamashima/flutter-mobile-project-template/apps/app/flavor/dev.json
   Modifying file: /Users/k_kamashima/flutter-mobile-project-template/apps/app/flavor/prd.json
   Modifying file: /Users/k_kamashima/flutter-mobile-project-template/apps/app/flavor/stg.json
[Step2] Replacing the namespace definition in build.gradle in app module with new application ID...
[Step3] Creating new MainActivity.kt...
[Step4] Deleting old MainActivity.kt...
Application ID renaming process completed.
diff --git a/apps/app/android/app/build.gradle b/apps/app/android/app/build.gradle
index c83b57f..afc40ca 100644
--- a/apps/app/android/app/build.gradle
+++ b/apps/app/android/app/build.gradle
@@ -42,7 +42,7 @@ tasks.whenTaskAdded { task ->
 }

 android {
-    namespace "jp.co.yumemi.flutter_app"
+    namespace "com.example.rename"
     compileSdk 34
     ndkVersion flutter.ndkVersion

diff --git a/apps/app/android/app/src/main/kotlin/jp/co/yumemi/flutter_app/MainActivity.kt b/apps/app/android/app/src/main/kotlin/jp/co/yumemi/flutter_app/MainActivity.kt
deleted file mode 100644
index ccc7325..0000000
--- a/apps/app/android/app/src/main/kotlin/jp/co/yumemi/flutter_app/MainActivity.kt
+++ /dev/null
@@ -1,5 +0,0 @@
-package jp.co.yumemi.flutter_app
-
-import io.flutter.embedding.android.FlutterActivity
-
-class MainActivity: FlutterActivity()
diff --git a/apps/app/flavor/dev.json b/apps/app/flavor/dev.json
index 5ba9ec3..bf98f95 100644
--- a/apps/app/flavor/dev.json
+++ b/apps/app/flavor/dev.json
@@ -1,6 +1,6 @@
 {
     "flavor": "dev",
     "appName": "dev-Template",
-    "appId": "jp.co.yumemi.template",
+    "appId": "com.example.rename",
     "appIdSuffix": ".dev"
 }
diff --git a/apps/app/flavor/prd.json b/apps/app/flavor/prd.json
index c6dcb85..2929e00 100644
--- a/apps/app/flavor/prd.json
+++ b/apps/app/flavor/prd.json
@@ -1,6 +1,6 @@
 {
     "flavor": "prd",
     "appName": "Template",
-    "appId": "jp.co.yumemi.template",
+    "appId": "com.example.rename",
     "appIdSuffix": ""
 }
diff --git a/apps/app/flavor/stg.json b/apps/app/flavor/stg.json
index 0e7698c..d3722da 100644
--- a/apps/app/flavor/stg.json
+++ b/apps/app/flavor/stg.json
@@ -1,6 +1,6 @@
 {
     "flavor": "stg",
     "appName": "stg-Template",
-    "appId": "jp.co.yumemi.template",
+    "appId": "com.example.rename",
     "appIdSuffix": ".stg"
 }

生成される APK 解析結果

変更したアプリ ID が package 名に付与されていることを確認した

Path: apps/app/build/app/outputs/apk/debug/app-debug.apk

備考

Issue 自動生成に関しては、main マージ後に実際にテンプレートプロジェクト作成して issue が作成されるかを検証する必要があります。

[github-actions[bot]]

Visit the preview URL for this PR (updated for commit 2c8b38c):

https://flutter-mobile-project-template-catalog--pr188-feature-v69dln1z.web.app

_{(expires Mon, 29 Apr 2024 00:58:43 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 9ea56735a63d07a7cfe62eb204b0528284c37c23}

[github-actions[bot]]

Ready for review :rocket:

[iseruuuuu]

僕が現状でできる限りの確認をさせていただきました🙇

動作確認の結果

• 検証ブランチ：feature/179-implement-rename-application-id-tool

以下のコマンドを実行

bash rename-application-id.sh "com.example.rename"

実行後の変化として、

• [x] build.gradeのnamespaceが変更されている
• [x] MainActivity.ktが削除されて、新しいものが作られる
• [x] flavorの３種類が変更されている

そのため、「動作検証時のログ」と同じ結果になったことが確認できました。

証拠の画像

チェック項目

• [x] 期待されている処理が正常に実行されているか

[iseruuuuu]

懸念点(自己解決できました)

~appIdは、環境ごとにわけなくてもいいのか？~

背景

• 環境分けの記事を見る感じだと、それぞれ違っている👀

  自己理解

  • appIdは３つとも同じでも良さそう。
  • 理由として、flavorのappIdはiOSのみでしか使用していない。
  • iOSのBundle IDの内容は、${appid}${appidSuffix}になるため以下の通りになる
• prd・・・com.example.rename.stg
• dev・・・com.example.rename.dev
• stg・・・com.example.rename

~iOSのファイルが変更されていない？~

自己理解

• iOSの場合は、flavorごとのjsonファイルに定義されたappIdを参照しているため、iOS個別の変更などは不要。
• こちらのコメントから理解できました。

備考

• 自己解決できた内容も正しいかどうかを記載させていただいております。認識が正しければ無視してください。

[Kotaro666-dev]

@iseruuuuu CC: @tatsutakein

再レビュー依頼

再度レビューをお願いします。

背景

こちらのコミットで、新しい変更を加えました。

変更内容

本 PR で対応したシェルスクリプトを ./scripts 配下から ./tools 配下に移動した。

issue 内の提案にも tools 配下に設置する記載があったことを失念していました。

提案 自動でアプリ ID 設定できるようにツールを開発して tools 配下に置く

[Kotaro666-dev]

レビューありがとうございます。 マージします。

[Kotaro666-dev]

動作テスト結果

テンプレートプロジェクトを使ってプロジェクト生成時に issue が自動生成されることを確認した。