Skip to content

Commit 5ce0dbe

Browse files
committed
Adding rollout disclaimer
1 parent ebe90e9 commit 5ce0dbe

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

cli/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,8 @@ If you never release an update that is marked as mandatory, then the above behav
327327

328328
#### Rollout parameter
329329

330+
**IMPORTANT: In order for this parameter to actually take affect, your end users need to be running version `1.6.0-beta+` (for Cordova) or `1.8.0-beta+` (for React Native) of the CodePush plugin. If you release an update that specifies a rollout property, no end user running an older version of the Cordova or React Native plugins will be eligible for the update. Therefore, until you have adopted the neccessary version of the CodePush SDK, we would advise not setting a rollout value on your releases, since no one would end up receiving it.**
331+
330332
This specifies the percentage of users (as an integer between `1` and `100`) that should be eligible to receive this update. It can be helpful if you want to "flight" new releases with a portion of your audience (e.g. 25%), and get feedback and/or watch for exceptions/crashes, before making it broadly available for everyone. If this parameter isn't set, it is treated equivalently to `100`, and therefore, you only need to set it if you want to actually limit how many users will receive it.
331333

332334
When leveraging the rollout capability, there are a few additional considerations to keep in mind:
@@ -570,4 +572,4 @@ You can clear the release history associated with a deployment using the followi
570572
code-push deployment clear <appName> <deploymentName>
571573
```
572574

573-
After running this command, client devices configured to receive updates using its associated deployment key will no longer receive the updates that have been cleared. This command is irreversible, and therefore should not be used in a production deployment.
575+
After running this command, client devices configured to receive updates using its associated deployment key will no longer receive the updates that have been cleared. This command is irreversible, and therefore should not be used in a production deployment.

0 commit comments

Comments
 (0)