Skip to content

Commit 5f49e22

Browse files
doc++
1 parent 6f81d12 commit 5f49e22

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -158,15 +158,19 @@ application.on(application.resumeEvent, () => {
158158

159159
## Releasing updates
160160
Once your app has been configured and distributed to your users, and you've made some code and/or asset changes,
161-
it's time to instantly release them!
161+
it's time to instantly unleash those changes onto your users!
162+
163+
> ⚠️ 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.
164+
165+
> 💁‍♂️ 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.
162166
163167
The easiest way to do this is to use the `release-nativescript` command in our CodePush CLI. Its (most relevant) options are:
164168

165169
|param|alias|default|description
166170
|---|---|---|---
167171
|deploymentName|d|"Staging"|Deploy to either "Staging" or "Production".
168-
|description|des||Description of the changes made to the app with this release.
169-
|targetBinaryVersion|t||Semver expression that specifies the binary app version(s) this release is targeting (e.g. 1.1.0, ~1.2.3).
172+
|description|des|not set|Description of the changes made to the app with this release.
173+
|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`.
170174
|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.
171175

172176
Have a few examples for both platforms:
@@ -188,18 +192,14 @@ nativescript-code-push release-nativescript <codepush-android-appname> android -
188192
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)
189193
```
190194

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.
192-
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-
195195
## CodePush CLI tricks
196196
Here are a few commands you may find useful:
197197

198198
### Which releases did I create and what are the install metrics?
199199
Using a command like this will tell you how many apps have the update installed:
200200

201201
```shell
202-
nativescript-code-push deployment history <codepush-ios-appname> Staging
202+
nativescript-code-push deployment history <codepush-appname> Staging
203203
```
204204

205205
Which produces something like this:
@@ -215,26 +215,26 @@ Which produces something like this:
215215
This dumps the details of the most recent release for both the Staging and Production environments of your app:
216216

217217
```shell
218-
nativescript-code-push deployment ls <codepush-ios-appname>
218+
nativescript-code-push deployment ls <codepush-appname>
219219
```
220220

221221
And if you want to dump your deployment keys as well, use:
222222

223223
```shell
224-
nativescript-code-push deployment ls <codepush-ios-appname> --displayKeys
224+
nativescript-code-push deployment ls <codepush-appname> --displayKeys
225225
```
226226

227227
Which produces something like this:
228228

229229
|Name|Deployment Key|Update Metadata|Install Metrics
230230
|---|---|---|---
231-
|Production|r1DVaLfKjc0Y5d6BzqX45SFVss6a4ksvOXqog|No updates released|No installs recorded
232-
|Staging|YTmVMy0GLCknVu3GVIynTxmfwxJN4ksvOXqog|Label: v5|Active: 11% (2 of 19)
231+
|Production|r1DVaLfKjc0Y5d6BzqX45SF|No updates released|No installs recorded
232+
|Staging|YTmVMy0GLCknVu3GVIynTxm|Label: v5|Active: 11% (2 of 19)
233233
| | |App Version: 1.0.0|Total: 2
234234
| | |Mandatory: Yes|
235235
| | |Release Time: an hour ago|
236-
| | |Released By: eddyverbruggen@gmail.com/
237-
| | |Description: Mandatory iOS version!/
236+
| | |Released By: eddyverbruggen@gmail.com|
237+
| | |Description: Mandatory iOS version!|
238238

239239
## Testing CodePush packages during development
240240
You may want to play with CodePush before using it in production (smart move!).

0 commit comments

Comments
 (0)