本記事は、佐藤将来が執筆しました。
ストアへのレビュー提出時、毎回同じ文言のリリースノートを記入するのを少し面倒に感じたことはありませんか？
この記事では、そんなちょっとした手間を自動化する方法をご紹介します。
とても簡単に導入出来るため、ぜひご覧下さい💡
この記事で出来るようになること
以下のように、Git 管理したリリースノート用のテキストファイルがストアへのアプリアップロード時に自動で記入されるようになります。
Codemagic とは
まず初めに、簡単に Codemagic についてご紹介します。
Codemagic とは、Flutter 開発に特化した、テストやビルド、デプロイを自動化する CI/CD ツールです。iOS, Android や React Native など、様々なプロジェクトにおいて利用できますが、Flutter プロジェクトでは Workflow Editor という GUI ツールを用いることが出来ます。これにより、yaml ファイルなどの専用ファイルの作成を必要とせずに直感的な操作による開発が可能です。
個人利用であれば無料で使い始めることが出来、十分な無料枠(毎月500分)を提供しています。料金の詳細については こちら をご覧ください。
前提条件
- リリース済みのアプリが App Store Connect 及び Google Play Console へ登録されていること
- Codemagic の Workflow Editor 上で Distribution プロセスが有効化されていること
- iOS の場合は、こちらの記事をご参照ください 👉 CI/CD ツール(Codemagic) を使って Flutter アプリを App Store へ公開する
- Android の場合は、こちらの記事をご参照ください 👉 CI/CD ツール(Codemagic) を使って Flutter アプリを Google Play Store へ公開する
ファイルの作成
では、ここから実際にリリースノートを作成していきましょう。
用意するファイルは、ストアでの言語コード設定によって異なります。 en-US の英語（米国）になっているかそれ以外かに応じて、以下の手順をご選択下さい。
en-US のみ設定している場合
プロジェクトのワーキングディレクトリ（リポジトリのルートディレクトリ、又はモノレポ構成であれば Workflow Editor 内 Build セクションの Project path へ設定しているディレクトリ）に release_notes.txt ファイルを作成します。
ファイル内には、リリースノートの内容の文字列を例えば以下のように記載します：
Bug fixes and performance improvements.
それ以外の言語コードを設定している場合
en-US以外、もしくは複数の言語を指定する場合、プロジェクトのワーキングディレクトリへ対象の言語ごとに release_notes_<language_localization_code>.txt という形式でファイルを作成します。
例えば、日本語の場合は release_notes_ja.txt というファイル名になります。
尚、各ストアにおける言語コードの表記は以下をご確認ください。
※ ストア間で異なるものもあるのでご注意下さい
また、複数のテキストファイルを用意する代わりに以下のように release_notes.json という一つのファイルへまとめることも出来ます：
[
{
"language": "en-US",
"text": "Bug fixes and performance improvements."
},
{
"language": "ja",
"text": "不具合修正および性能改善を行いました。"
}
]
language のフィールドには、対応する言語コードを指定してください。
text にはリリースノートの本文を記載してください。
配布する
では、ここから実際にリリース内容を各ストアのコンソールへアップロードしていきましょう。
App Store Connect
Workflow Editor 上の各種設定については、こちらの記事を適宜ご確認ください。
今回の内容をストアへ反映させるために、Distribution > App Store Connect 内の Submit to App Store review にチェックをつけておきましょう：
その上で、対象のブランチをビルドします：
すると、App Store Connect 上で以下のようにリリースノートのテキスト内容が反映されています🎉
また、TestFlight のレビューにも同内容のテキストを利用することが出来ます：
Google Play Console
Workflow Editor 上の各種設定については、こちらの記事を適宜ご確認ください。
Distribution > Google Play セクションにて、以下のように Production へアップロードされる設定となっていることを確認しましょう：
対象のブランチをビルドします：
Google Play Console へ以下のようにリリースノートが反映されています：
終わりに
お疲れ様でした 🙌
今回の記事により、皆さんの日々のリリース作業の負担が少しでも軽減されますと幸いです。
何かご質問やお困りごとありましたら、サポートコミュニティにご相談ください💡
- GitHub Discussion: https://github.com/orgs/codemagic-ci-cd/discussions
- Discordコミュニティ: https://discord.com/invite/pefznye93R
既にお支払い情報を登録している場合は、ページ右下のチャットウィジェットからもサポートを受けることができます。
これからも Codemagic を使って快適に開発を楽しんでいきましょう！
