From 4b00cfbed97d756024db0e7d93f2a6e7272135d4 Mon Sep 17 00:00:00 2001 From: Felix Angelov Date: Thu, 3 Aug 2023 16:36:48 -0500 Subject: [PATCH] feat(shorebird_cli): improve `shorebird.yaml` inline doc comments (#1018) --- .../lib/src/commands/init_command.dart | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/packages/shorebird_cli/lib/src/commands/init_command.dart b/packages/shorebird_cli/lib/src/commands/init_command.dart index 3cbf7b3f..90fb3efc 100644 --- a/packages/shorebird_cli/lib/src/commands/init_command.dart +++ b/packages/shorebird_cli/lib/src/commands/init_command.dart @@ -217,13 +217,20 @@ For more information about Shorebird, visit ${link(uri: Uri.parse('https://shore Map? flavors, }) { const content = ''' -# This file is used to configure the Shorebird updater used by your application. -# Learn more at https://shorebird.dev +# This file is used to configure the Shorebird updater used by your app. +# Learn more at https://docs.shorebird.dev # This file should be checked into version control. # This is the unique identifier assigned to your app. -# It is used by your app to request the correct patches from Shorebird servers. +# Your app_id is not a secret and is just used to identify your app +# when requesting patches from Shorebird's servers. app_id: + +# auto_update controls if Shorebird should automatically update in the background on launch. +# If auto_update: false, you will need to use package:shorebird_code_push to trigger updates. +# https://pub.dev/packages/shorebird_code_push +# Uncomment the following line to disable automatic updates. +# auto_update: false '''; final editor = YamlEditor(content)..update(['app_id'], appId);