Skip to content

Commit 6f81d12

Browse files
doc++
1 parent 4ff7e23 commit 6f81d12

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -167,11 +167,11 @@ The easiest way to do this is to use the `release-nativescript` command in our C
167167
|deploymentName|d|"Staging"|Deploy to either "Staging" or "Production".
168168
|description|des||Description of the changes made to the app with this release.
169169
|targetBinaryVersion|t||Semver expression that specifies the binary app version(s) this release is targeting (e.g. 1.1.0, ~1.2.3).
170-
|mandatory|m|not set, so "optional"|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.
170+
|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.
171171

172172
Have a few examples for both platforms:
173173

174-
### iOS
174+
#### iOS
175175

176176
```shell
177177
nativescript-code-push release-nativescript <codepush-ios-appname> ios # deploy to Staging
@@ -180,18 +180,20 @@ nativescript-code-push release-nativescript <codepush-ios-appname> ios --targetB
180180
nativescript-code-push release-nativescript <codepush-ios-appname> ios --mandatory --description "My mandatory iOS version" # mandatory release for iOS
181181
```
182182

183-
### Android
183+
#### Android
184184

185185
```shell
186186
nativescript-code-push release-nativescript <codepush-android-appname> android # deploy to Staging
187187
nativescript-code-push release-nativescript <codepush-android-appname> android --d Production # deploy to Production (default: Staging)
188188
nativescript-code-push release-nativescript <codepush-android-appname> android --targetBinaryVersion ~1.0.0 # release to users running any 1.x version (default: the exact version in AndroidManifest.xml)
189189
```
190190

191-
### Tips
192-
> Make sure to create a *release build* first, so use the same command that you'd use for app store distribution, just don't send it to the AppStore. You can even Webpack and Uglify your app, it's all transparent to this plugin.
191+
> ⚠️ Make sure to create a *release build* first, so use the same command that you'd use for app store distribution, just don't send it to the AppStore. You can even Webpack and Uglify your app, it's all transparent to this plugin.
193192
194-
> When releasing updates to CodePush, you do not need to bump your app's version since you aren't modifying the app store version at all. CodePush will automatically generate a "label" for each release you make (e.g. `v3`) in order to help identify it within your release history.
193+
> 💁‍♂️ When releasing updates to CodePush, you do not need to bump your app's version since you aren't modifying the app store version at all. CodePush will automatically generate a "label" for each release you make (e.g. `v3`) in order to help identify it within your release history.
194+
195+
## CodePush CLI tricks
196+
Here are a few commands you may find useful:
195197

196198
### Which releases did I create and what are the install metrics?
197199
Using a command like this will tell you how many apps have the update installed:
@@ -206,7 +208,6 @@ Which produces something like this:
206208
|---|---|---|---|---|---
207209
|v2|an hour ago|1.0.0|Yes|Mandatory iOS version!|Active: 11% (2 of 19)
208210
|||||Total: 2|
209-
||||||
210211
|v1|2 hours ago|1.0.0|No|Awesome iOS version!|Active: 26% (5 of 19)
211212
|||||Total: 5|
212213

@@ -228,7 +229,6 @@ Which produces something like this:
228229
|Name|Deployment Key|Update Metadata|Install Metrics
229230
|---|---|---|---
230231
|Production|r1DVaLfKjc0Y5d6BzqX45SFVss6a4ksvOXqog|No updates released|No installs recorded
231-
| | | |
232232
|Staging|YTmVMy0GLCknVu3GVIynTxmfwxJN4ksvOXqog|Label: v5|Active: 11% (2 of 19)
233233
| | |App Version: 1.0.0|Total: 2
234234
| | |Mandatory: Yes|

0 commit comments

Comments
 (0)