Add support for line breaks when starting a new version from GitHub Actions

.github/workflows/beta.yml

@@ -22,7 +22,8 @@ on:
         type: string
         description: |
           iOS changelog: Used for the App Store release notes. If the changelog 
-          is not provided, the deployment for iOS will be skipped.
+          is not provided, the deployment for iOS will be skipped. Use '\n' for 
+          line breaks.
       # For web deployments, we don't have a changelog.
       deploy-web-app:
         type: boolean
@@ -34,6 +35,7 @@ on:
         description: |
           Android changelog: Used for the Google Play Store release notes. If the 
           changelog is not provided, the deployment for Android will be skipped.
+          Use '\n' for line breaks.
 
 # Set permissions to none.
 #

.github/workflows/stable.yml

@@ -22,7 +22,8 @@ on:
         type: string
         description: |
           iOS changelog: Used for the App Store release notes. If the changelog 
-          is not provided, the deployment for iOS will be skipped.
+          is not provided, the deployment for iOS will be skipped. Use '\n' for 
+          line breaks.
       # For web deployments, we don't have a changelog.
       deploy-web-app:
         type: boolean
@@ -34,6 +35,7 @@ on:
         description: |
           Android changelog: Used for the Google Play Store release notes. If the 
           changelog is not provided, the deployment for Android will be skipped.
+          Use '\n' for line breaks.
 
 # Set permissions to none.
 #

tools/sz_repo_cli/lib/src/commands/src/deploy_android_command.dart

@@ -177,10 +177,14 @@ class DeployAndroidCommand extends Command {
     // Create folder, if it doesn't exist.
     await changelogFile.parent.create(recursive: true);
 
+    // When passing the changelog from GitHub Actions to the CLI, the line
+    // breaks are escaped. We need to replace them with actual line breaks.
+    final whatsNewWithLineBreaks = whatsNew.replaceAll(r'\n', '\n');
+
     // Write changelog into file. Fastlane will pick it up automatically.
     //
     // See: https://docs.fastlane.tools/actions/upload_to_play_store/#changelogs-whats-new
-    await changelogFile.writeAsString(whatsNew);
+    await changelogFile.writeAsString(whatsNewWithLineBreaks);
   }
 
   String _getGooglePlayTrackFromStage() {

tools/sz_repo_cli/lib/src/common/src/app_store_connect_utils.dart

@@ -143,6 +143,10 @@ Future<void> publishToAppStoreConnect({
   required AppStoreConnectConfig appStoreConnectConfig,
   String? whatsNew,
 }) async {
+  // When passing the changelog from GitHub Actions to the CLI, the line breaks
+  // are escaped. We need to replace them with actual line breaks.
+  String? whatsNewWithLineBreaks = whatsNew?.replaceAll('\\n', '\n');
+
   final track = _getAppleTrack(
     stage: stage,
     stageToTracks: stageToTracks,
@@ -157,9 +161,9 @@ Future<void> publishToAppStoreConnect({
       // The app version will be automatically released right after it has
       // been approved by App Review.
       'AFTER_APPROVAL',
-      if (whatsNew != null) ...[
+      if (whatsNewWithLineBreaks != null) ...[
         '--whats-new',
-        whatsNew,
+        whatsNewWithLineBreaks,
       ],
       if (track is AppStoreTrack) ...[
         '--app-store',