Skip to content

Commit ed4644f

Browse files
Making more clear what --mandatory means and does
1 parent fd02159 commit ed4644f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ The easiest way to do this is to use the `release-nativescript` command in our C
171171
|deploymentName|d|"Staging"|Deploy to either "Staging" or "Production".
172172
|description|des|not set|Description of the changes made to the app with this release.
173173
|targetBinaryVersion|t|`App_Resources`|Semver expression that specifies the binary app version(s) this release is targeting (e.g. 1.1.0, ~1.2.3). The default is the exact version in `App_Resources/iOS/Info.plist` or `App_Resources/Android/AndroidManifest.xml`.
174-
|mandatory|m|not set|This specifies whether the update should be considered mandatory or not (e.g. it includes a critical security fix). This attribute is simply round tripped to the client, who can then decide if and how they would like to enforce it. This is flag, so its absence indicates an optional release.
174+
|mandatory|m|not set|This specifies whether or not the update should be considered "urgent" (e.g. it includes a critical security fix). This attribute is simply round tripped to the client, who can then decide if and how they would like to enforce it. If this flag is not set, the update is considered "not urgent" so you may choose to wait for the next cold boot of the app.
175175

176176
Have a few examples for both platforms:
177177

@@ -181,7 +181,7 @@ Have a few examples for both platforms:
181181
nativescript-code-push release-nativescript <codepush-ios-appname> ios # deploy to Staging
182182
nativescript-code-push release-nativescript <codepush-ios-appname> ios --d Production # deploy to Production (default: Staging)
183183
nativescript-code-push release-nativescript <codepush-ios-appname> ios --targetBinaryVersion ~1.0.0 # release to users running any 1.x version (default: the exact version in Info.plist)
184-
nativescript-code-push release-nativescript <codepush-ios-appname> ios --mandatory --description "My mandatory iOS version" # mandatory release for iOS
184+
nativescript-code-push release-nativescript <codepush-ios-appname> ios --mandatory --description "My mandatory iOS version" # a release for iOS that needs to be applied ASAP.
185185
```
186186

187187
#### Android

0 commit comments

Comments
 (0)