Skip to content

Commit ee5dc47

Browse files
author
Richard Hua
committed
Merge pull request #79 from Microsoft/rollback-documentation
Add documentation on rollback command
2 parents 57fcf51 + 1f6e178 commit ee5dc47

File tree

3 files changed

+22
-5
lines changed

3 files changed

+22
-5
lines changed

cli/README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
CodePush is a cloud service that enables Cordova and React Native developers to deploy mobile app updates directly to their users' devices. It works by acting as a central repository that developers can publish updates to (JS, HTML, CSS and images), and that apps can query for updates from (using provided client SDKs for [Cordova](http://github.com/Microsoft/cordova-plugin-code-push) and [React Native](http://github.com/Microsoft/react-native-code-push)). This allows you to have a more deterministic and direct engagement model with your userbase, when addressing bugs and/or adding small features that don't require you to re-build a binary and re-distribute it through the respective app stores.
44

5-
![CodePush CLI](https://cloud.githubusercontent.com/assets/116461/11233671/1d0329ae-8d75-11e5-8cf4-781109ca83b8.png)
5+
![CodePush CLI](https://cloud.githubusercontent.com/assets/696206/11605036/5a934e56-9aaa-11e5-87ad-01cddeaf07dc.PNG)
66

77
## Installation
88

@@ -184,12 +184,29 @@ code-push promote <appName> <sourceDeploymentName> <destDeploymentName>
184184
code-push promote MyApp Staging Production
185185
```
186186

187+
The release produced by a promotion will be annotated in the output of the `deployment history` command.
188+
189+
## Rolling back undesired updates
190+
191+
If you release an update that is broken or contains unintended features, it is easy to roll it back using the `rollback` command:
192+
193+
```
194+
code-push rollback <appName> <deploymentName>
195+
code-push rollback MyApp Production
196+
```
197+
198+
This has the effect of issuing another release with the same contents and metadata as the version prior to the latest one. Note that this means that issuing a second consecutive `rollback` command simply cancels out the first one.
199+
200+
The release produced by a rollback will be annotated in the output of the `deployment history` command.
201+
187202
## Viewing release history
188203

189-
You can view a history of the 50 most recent releases for a specific app deployment (including promotions) using the following command:
204+
You can view a history of the 50 most recent releases for a specific app deployment using the following command:
190205

191206
```
192207
code-push deployment history <appName> <deploymentName>
193208
```
194209

210+
![Deployment History](https://cloud.githubusercontent.com/assets/696206/11605068/14e440d0-9aab-11e5-8837-69ab09bfb66c.PNG)
211+
195212
*NOTE: The history command can also be run using the "h" alias*

cli/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "code-push-cli",
3-
"version": "1.2.3-beta",
3+
"version": "1.3.0-beta",
44
"description": "Management CLI for the CodePush service",
55
"main": "script/cli.js",
66
"scripts": {
@@ -27,7 +27,7 @@
2727
"base-64": "^0.1.0",
2828
"chalk": "^1.1.0",
2929
"cli-table": "^0.3.1",
30-
"code-push": "1.2.1-beta",
30+
"code-push": "1.3.0-beta",
3131
"fs": "0.0.2",
3232
"moment": "^2.10.6",
3333
"opener": "^1.4.1",

sdk/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "code-push",
3-
"version": "1.2.1-beta",
3+
"version": "1.3.0-beta",
44
"description": "Management SDK for the CodePush service",
55
"main": "script/index.js",
66
"scripts": {

0 commit comments

Comments
 (0)