docs: add missing --mode description (#1914)

react-native-community · Apr 17, 2023 · c6c24bf · c6c24bf
1 parent d8b7e32
commit c6c24bf
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/packages/cli-platform-ios/README.md b/packages/cli-platform-ios/README.md
@@ -47,6 +47,16 @@ react-native run-ios --simulator "iPhone 14"
 
 [Deprecated] Explicitly set the scheme configuration to use default: 'Debug'.
 
+#### `--mode <string>`
+
+Explicitly set the scheme configuration to use. This option is case sensitive.
+
+Example:
+
+```sh
+react-native run-ios --mode "Release"
+```
+
 #### `--scheme <string>`
 
 Explicitly set Xcode scheme to use.
@@ -127,6 +137,16 @@ react-native build-ios --simulator "iPhone 14"
 
 [Deprecated] Explicitly set the scheme configuration to use default: 'Debug'.
 
+#### `--mode <string>`
+
+Explicitly set the scheme configuration to use. This option is case sensitive.
+
+Example:
+
+```sh
+react-native build-ios --mode "Release"
+```
+
 #### `--scheme <string>`
 
 Explicitly set Xcode scheme to use.

diff --git a/packages/cli-platform-ios/src/commands/buildIOS/index.ts b/packages/cli-platform-ios/src/commands/buildIOS/index.ts
@@ -212,7 +212,8 @@ export const iosBuildOptions = [
   },
   {
     name: '--mode <string>',
-    description: 'Explicitly set the scheme configuration to use',
+    description:
+      'Explicitly set the scheme configuration to use. This option is case sensitive.',
   },
   {
     name: '--configuration <string>',