feat(shorebird_cli): include shorebird.yaml in release and patch metadata

packages/shorebird_cli/lib/src/commands/patch/patch_command.dart

@@ -314,6 +314,7 @@ NOTE: this is ${styleBold.wrap('not')} recommended. Asset changes cannot be incl
             operatingSystem: platform.operatingSystem,
             operatingSystemVersion: platform.operatingSystemVersion,
             shorebirdVersion: packageVersion,
+            shorebirdYaml: shorebirdEnv.getShorebirdYaml()!,
           ),
         );
         final updateMetadata = await patcher.updatedCreatePatchMetadata(

packages/shorebird_cli/lib/src/commands/release/release_command.dart

@@ -487,6 +487,7 @@ ${summary.join('\n')}
         operatingSystem: platform.operatingSystem,
         operatingSystemVersion: platform.operatingSystemVersion,
         shorebirdVersion: packageVersion,
+        shorebirdYaml: shorebirdEnv.getShorebirdYaml()!,
       ),
     );
     final updatedMetadata = await releaser.updatedReleaseMetadata(baseMetadata);

packages/shorebird_cli/lib/src/config/shorebird_yaml.dart

@@ -22,6 +22,9 @@ class ShorebirdYaml {
   factory ShorebirdYaml.fromJson(Map<dynamic, dynamic> json) =>
       _$ShorebirdYamlFromJson(json);
 
+  /// Converts this [ShorebirdYaml] to a JSON map.
+  Map<String, dynamic> toJson() => _$ShorebirdYamlToJson(this);
+
   /// The base app id.
   ///
   /// Example:

packages/shorebird_cli/lib/src/metadata/build_environment_metadata.dart

@@ -1,5 +1,6 @@
 import 'package:equatable/equatable.dart';
 import 'package:json_annotation/json_annotation.dart';
+import 'package:shorebird_cli/src/config/config.dart';
 
 part 'build_environment_metadata.g.dart';
 
@@ -21,6 +22,7 @@ class BuildEnvironmentMetadata extends Equatable {
     required this.shorebirdVersion,
     required this.operatingSystem,
     required this.operatingSystemVersion,
+    required this.shorebirdYaml,
     this.xcodeVersion,
   });
 
@@ -32,13 +34,15 @@ class BuildEnvironmentMetadata extends Equatable {
     String shorebirdVersion = '4.5.6',
     String operatingSystem = 'macos',
     String operatingSystemVersion = '1.2.3',
+    ShorebirdYaml shorebirdYaml = const ShorebirdYaml(appId: '123'),
     String? xcodeVersion = '15.0',
   }) =>
       BuildEnvironmentMetadata(
         flutterRevision: flutterRevision,
         shorebirdVersion: shorebirdVersion,
         operatingSystem: operatingSystem,
         operatingSystemVersion: operatingSystemVersion,
+        shorebirdYaml: shorebirdYaml,
         xcodeVersion: xcodeVersion,
       );
   // coverage:ignore-end
@@ -57,6 +61,7 @@ class BuildEnvironmentMetadata extends Equatable {
     String? shorebirdVersion,
     String? operatingSystem,
     String? operatingSystemVersion,
+    ShorebirdYaml? shorebirdYaml,
     String? xcodeVersion,
   }) =>
       BuildEnvironmentMetadata(
@@ -65,6 +70,7 @@ class BuildEnvironmentMetadata extends Equatable {
         operatingSystem: operatingSystem ?? this.operatingSystem,
         operatingSystemVersion:
             operatingSystemVersion ?? this.operatingSystemVersion,
+        shorebirdYaml: shorebirdYaml ?? this.shorebirdYaml,
         xcodeVersion: xcodeVersion ?? this.xcodeVersion,
       );
 
@@ -92,6 +98,9 @@ class BuildEnvironmentMetadata extends Equatable {
   /// Reason: issues may occur on some OS versions and not others.
   final String operatingSystemVersion;
 
+  /// The shorebird.yaml file for this project.
+  final ShorebirdYaml shorebirdYaml;
+
   /// The version of Xcode used to build the patch. Only provided for iOS
   /// patches.
   ///
@@ -105,6 +114,7 @@ class BuildEnvironmentMetadata extends Equatable {
         shorebirdVersion,
         operatingSystem,
         operatingSystemVersion,
+        shorebirdYaml,
         xcodeVersion,
       ];
 }

packages/shorebird_cli/test/src/commands/patch/aar_patcher_test.dart

@@ -10,6 +10,7 @@ import 'package:shorebird_cli/src/artifact_builder.dart';
 import 'package:shorebird_cli/src/artifact_manager.dart';
 import 'package:shorebird_cli/src/code_push_client_wrapper.dart';
 import 'package:shorebird_cli/src/commands/patch/patch.dart';
+import 'package:shorebird_cli/src/config/config.dart';
 import 'package:shorebird_cli/src/engine_config.dart';
 import 'package:shorebird_cli/src/logger.dart';
 import 'package:shorebird_cli/src/metadata/metadata.dart';
@@ -528,6 +529,7 @@ void main() {
             operatingSystem: operatingSystem,
             operatingSystemVersion: operatingSystemVersion,
             shorebirdVersion: packageVersion,
+            shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
           ),
         );
 

packages/shorebird_cli/test/src/commands/patch/android_patcher_test.dart

@@ -13,6 +13,7 @@ import 'package:shorebird_cli/src/code_push_client_wrapper.dart';
 import 'package:shorebird_cli/src/code_signer.dart';
 import 'package:shorebird_cli/src/commands/patch/patch.dart';
 import 'package:shorebird_cli/src/common_arguments.dart';
+import 'package:shorebird_cli/src/config/config.dart';
 import 'package:shorebird_cli/src/doctor.dart';
 import 'package:shorebird_cli/src/engine_config.dart';
 import 'package:shorebird_cli/src/logger.dart';
@@ -645,6 +646,7 @@ Looked in:
             operatingSystem: operatingSystem,
             operatingSystemVersion: operatingSystemVersion,
             shorebirdVersion: packageVersion,
+            shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
           ),
         );
 

packages/shorebird_cli/test/src/commands/patch/ios_framework_patcher_test.dart

@@ -12,6 +12,7 @@ import 'package:shorebird_cli/src/artifact_manager.dart';
 import 'package:shorebird_cli/src/code_push_client_wrapper.dart';
 import 'package:shorebird_cli/src/commands/patch/patch.dart';
 import 'package:shorebird_cli/src/common_arguments.dart';
+import 'package:shorebird_cli/src/config/config.dart';
 import 'package:shorebird_cli/src/doctor.dart';
 import 'package:shorebird_cli/src/engine_config.dart';
 import 'package:shorebird_cli/src/executables/aot_tools.dart';
@@ -843,6 +844,7 @@ void main() {
                 operatingSystem: operatingSystem,
                 operatingSystemVersion: operatingSystemVersion,
                 shorebirdVersion: packageVersion,
+                shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
               ),
             );
 
@@ -862,6 +864,7 @@ void main() {
                     operatingSystem: operatingSystem,
                     operatingSystemVersion: operatingSystemVersion,
                     shorebirdVersion: packageVersion,
+                    shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
                     xcodeVersion: xcodeVersion,
                   ),
                 ),
@@ -889,6 +892,7 @@ void main() {
                 operatingSystem: operatingSystem,
                 operatingSystemVersion: operatingSystemVersion,
                 shorebirdVersion: packageVersion,
+                shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
               ),
             );
 
@@ -909,6 +913,7 @@ void main() {
                     operatingSystem: operatingSystem,
                     operatingSystemVersion: operatingSystemVersion,
                     shorebirdVersion: packageVersion,
+                    shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
                     xcodeVersion: xcodeVersion,
                   ),
                 ),

packages/shorebird_cli/test/src/commands/patch/ios_patcher_test.dart

@@ -16,6 +16,7 @@ import 'package:shorebird_cli/src/code_push_client_wrapper.dart';
 import 'package:shorebird_cli/src/code_signer.dart';
 import 'package:shorebird_cli/src/commands/patch/patch.dart';
 import 'package:shorebird_cli/src/common_arguments.dart';
+import 'package:shorebird_cli/src/config/config.dart';
 import 'package:shorebird_cli/src/doctor.dart';
 import 'package:shorebird_cli/src/engine_config.dart';
 import 'package:shorebird_cli/src/executables/aot_tools.dart';
@@ -1608,6 +1609,7 @@ For more information see: ${supportedFlutterVersionsUrl.toLink()}''',
                 operatingSystem: operatingSystem,
                 operatingSystemVersion: operatingSystemVersion,
                 shorebirdVersion: packageVersion,
+                shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
               ),
             );
 
@@ -1627,6 +1629,7 @@ For more information see: ${supportedFlutterVersionsUrl.toLink()}''',
                     operatingSystem: operatingSystem,
                     operatingSystemVersion: operatingSystemVersion,
                     shorebirdVersion: packageVersion,
+                    shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
                     xcodeVersion: xcodeVersion,
                   ),
                 ),
@@ -1654,6 +1657,7 @@ For more information see: ${supportedFlutterVersionsUrl.toLink()}''',
                 operatingSystem: operatingSystem,
                 operatingSystemVersion: operatingSystemVersion,
                 shorebirdVersion: packageVersion,
+                shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
               ),
             );
 
@@ -1675,6 +1679,7 @@ For more information see: ${supportedFlutterVersionsUrl.toLink()}''',
                     operatingSystemVersion: operatingSystemVersion,
                     shorebirdVersion: packageVersion,
                     xcodeVersion: xcodeVersion,
+                    shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
                   ),
                 ),
               ),

packages/shorebird_cli/test/src/commands/release/android_releaser_test.dart

@@ -10,6 +10,7 @@ import 'package:shorebird_cli/src/code_push_client_wrapper.dart';
 import 'package:shorebird_cli/src/code_signer.dart';
 import 'package:shorebird_cli/src/commands/release/android_releaser.dart';
 import 'package:shorebird_cli/src/common_arguments.dart';
+import 'package:shorebird_cli/src/config/config.dart';
 import 'package:shorebird_cli/src/doctor.dart';
 import 'package:shorebird_cli/src/engine_config.dart';
 import 'package:shorebird_cli/src/logger.dart';
@@ -655,6 +656,7 @@ To change the version of this release, change your app's version in your pubspec
           operatingSystem: operatingSystem,
           operatingSystemVersion: operatingSystemVersion,
           shorebirdVersion: packageVersion,
+          shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
         ),
       );
 
@@ -678,6 +680,7 @@ To change the version of this release, change your app's version in your pubspec
                   operatingSystem: operatingSystem,
                   operatingSystemVersion: operatingSystemVersion,
                   shorebirdVersion: packageVersion,
+                  shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
                 ),
               ),
             ),
@@ -705,6 +708,7 @@ To change the version of this release, change your app's version in your pubspec
                   operatingSystem: operatingSystem,
                   operatingSystemVersion: operatingSystemVersion,
                   shorebirdVersion: packageVersion,
+                  shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
                 ),
               ),
             ),

packages/shorebird_cli/test/src/commands/release/ios_framework_releaser_test.dart

@@ -10,6 +10,7 @@ import 'package:shorebird_cli/src/artifact_builder.dart';
 import 'package:shorebird_cli/src/artifact_manager.dart';
 import 'package:shorebird_cli/src/code_push_client_wrapper.dart';
 import 'package:shorebird_cli/src/commands/release/ios_framework_releaser.dart';
+import 'package:shorebird_cli/src/config/config.dart';
 import 'package:shorebird_cli/src/doctor.dart';
 import 'package:shorebird_cli/src/executables/executables.dart';
 import 'package:shorebird_cli/src/logger.dart';
@@ -398,6 +399,7 @@ void main() {
             operatingSystem: operatingSystem,
             operatingSystemVersion: operatingSystemVersion,
             shorebirdVersion: packageVersion,
+            shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
           ),
         );
 
@@ -421,6 +423,7 @@ void main() {
                   operatingSystem: operatingSystem,
                   operatingSystemVersion: operatingSystemVersion,
                   shorebirdVersion: packageVersion,
+                  shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
                   xcodeVersion: xcodeVersion,
                 ),
               ),

packages/shorebird_cli/test/src/commands/release/ios_releaser_test.dart

@@ -14,6 +14,7 @@ import 'package:shorebird_cli/src/code_push_client_wrapper.dart';
 import 'package:shorebird_cli/src/code_signer.dart';
 import 'package:shorebird_cli/src/commands/release/ios_releaser.dart';
 import 'package:shorebird_cli/src/common_arguments.dart';
+import 'package:shorebird_cli/src/config/config.dart';
 import 'package:shorebird_cli/src/doctor.dart';
 import 'package:shorebird_cli/src/executables/xcodebuild.dart';
 import 'package:shorebird_cli/src/logger.dart';
@@ -768,6 +769,7 @@ To change the version of this release, change your app's version in your pubspec
             operatingSystem: operatingSystem,
             operatingSystemVersion: operatingSystemVersion,
             shorebirdVersion: packageVersion,
+            shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
           ),
         );
 
@@ -791,6 +793,7 @@ To change the version of this release, change your app's version in your pubspec
                   operatingSystem: operatingSystem,
                   operatingSystemVersion: operatingSystemVersion,
                   shorebirdVersion: packageVersion,
+                  shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
                   xcodeVersion: xcodeVersion,
                 ),
               ),

packages/shorebird_cli/test/src/metadata/build_environment_metadata_test.dart

@@ -1,3 +1,4 @@
+import 'package:shorebird_cli/src/config/config.dart';
 import 'package:shorebird_cli/src/metadata/metadata.dart';
 import 'package:test/test.dart';
 
@@ -10,6 +11,7 @@ void main() {
         operatingSystemVersion: '1.2.3',
         shorebirdVersion: '4.5.6',
         xcodeVersion: '15.0',
+        shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
       );
       expect(
         BuildEnvironmentMetadata.fromJson(metadata.toJson()).toJson(),
@@ -25,6 +27,7 @@ void main() {
           operatingSystemVersion: '1.2.3',
           shorebirdVersion: '4.5.6',
           xcodeVersion: '15.0',
+          shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
         );
 
         expect(metadata.copyWith(), equals(metadata));
@@ -37,13 +40,15 @@ void main() {
           operatingSystemVersion: '1.2.3',
           shorebirdVersion: '4.5.6',
           xcodeVersion: '15.0',
+          shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
         );
         final newMetadata = metadata.copyWith(
           flutterRevision: 'asdf',
           operatingSystem: 'windows',
           operatingSystemVersion: '11',
           shorebirdVersion: '1.2.3',
           xcodeVersion: '14.0',
+          shorebirdYaml: const ShorebirdYaml(appId: 'app-id2'),
         );
         expect(
           newMetadata,
@@ -54,6 +59,7 @@ void main() {
               operatingSystemVersion: '11',
               shorebirdVersion: '1.2.3',
               xcodeVersion: '14.0',
+              shorebirdYaml: ShorebirdYaml(appId: 'app-id2'),
             ),
           ),
         );
@@ -68,13 +74,15 @@ void main() {
           operatingSystemVersion: '1.2.3',
           shorebirdVersion: '4.5.6',
           xcodeVersion: '15.0',
+          shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
         );
         const otherMetadata = BuildEnvironmentMetadata(
           flutterRevision: '853d13d954df3b6e9c2f07b72062f33c52a9a64b',
           operatingSystem: 'macos',
           operatingSystemVersion: '1.2.3',
           shorebirdVersion: '4.5.6',
           xcodeVersion: '15.0',
+          shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
         );
         expect(metadata, equals(otherMetadata));
       });
@@ -86,13 +94,15 @@ void main() {
           operatingSystemVersion: '1.2.3',
           shorebirdVersion: '4.5.6',
           xcodeVersion: '15.0',
+          shorebirdYaml: ShorebirdYaml(appId: 'app-id'),
         );
         const otherMetadata = BuildEnvironmentMetadata(
           flutterRevision: '853d13d954df3b6e9c2f07b72062f33c52a9a64b',
           operatingSystem: 'macos',
           operatingSystemVersion: '1.2.3',
           shorebirdVersion: '4.5.6',
           xcodeVersion: '15.1',
+          shorebirdYaml: ShorebirdYaml(appId: 'app-id2'),
         );
         expect(metadata, isNot(equals(otherMetadata)));
       });