mirror of
https://github.com/zhigang1992/react-native-code-push.git
synced 2026-06-12 17:08:58 +08:00
154 lines
6.2 KiB
Markdown
154 lines
6.2 KiB
Markdown
react-native-code-push
|
|
===
|
|
|
|
React Native module for deploying script updates using the CodePush service.
|
|
|
|
Installation
|
|
---
|
|
|
|
```
|
|
npm install --save react-native-code-push
|
|
```
|
|
|
|
After installing the React Native CodePush plugin, open your project in Xcode. Open the `react-native-code-push` in Finder, and drag the `CodePush.xcodeproj` into the Libraries folder of Xcode.
|
|
|
|
|
|
|
|
|
|
In Xcode, click on your project, and select the "Build Phases" tab of your project configuration. Drag libCodePush.a from `Libraries/CodePush.xcodeproj/Products` into the "Link Binary With Libraries" secton of your project's "Build Phases" configuration.
|
|
|
|
|
|
|
|
Under the "Build Settings" tab of your project configuration, find the "Header Search Paths" section and edit the value.
|
|
Add a new value, `$(SRCROOT)/../node_modules/react-native-code-push` and select "recursive" in the dropdown.
|
|
|
|
|
|
|
|
Finally, edit your project's `AppDelegate.m`.
|
|
|
|
At the top of the file, add the following line to import the CodePush headers.
|
|
|
|
```
|
|
#import "CodePush.h"
|
|
```
|
|
|
|
Then, find the following code:
|
|
|
|
```
|
|
jsCodeLocation = [NSURL URLWithString:@"http://localhost:8081/index.ios.bundle?platform=ios&dev=true"];
|
|
```
|
|
|
|
Replace it with this:
|
|
|
|
```
|
|
jsCodeLocation = [CodePush getBundleUrl];
|
|
```
|
|
|
|
This change allows CodePush to load the updated app location after an update has been applied.
|
|
Before any updates are installed, CodePush will load your app from the bundled "main.jsbundle" file.
|
|
After updates are installed, CodePush will load your app from the writable user directory, where the update has been downloaded.
|
|
|
|
Methods
|
|
---
|
|
|
|
* [checkForUpdate](#codepushcheckforupdate): Checks the service for updates
|
|
* [notifyApplicationReady](#codepushnotifyapplicationready): Notifies the plugin that the update operation succeeded.
|
|
* [getCurrentPackage](#codepushgetcurrentpackage): Gets information about the currently applied package.
|
|
|
|
Objects
|
|
---
|
|
|
|
* [LocalPackage](#localpackage): Contains information about a locally installed package.
|
|
* [RemotePackage](#remotepackage): Contains information about an updated package available for download.
|
|
|
|
Getting Started:
|
|
---
|
|
|
|
* Add the plugin to your app
|
|
* Open your app's `Info.plist` and add a "CodePushDeploymentKey" entry with your app's deployment key
|
|
* To publish an update for your app, run `react-native bundle`, and then publish `iOS/main.jsbundle` using the CodePush CLI.
|
|
|
|
Running the Example
|
|
---
|
|
|
|
* Clone this repository
|
|
* From the root of this project, run `npm install`
|
|
* `cd` into `Examples/CodePushDemoApp`
|
|
* From this demo app folder, run `npm install`
|
|
* Open `Info.plist` and fill in the value for CodePushDeploymentKey
|
|
* Run `npm start` to launch the packager
|
|
* Open `CodePushDemoApp.xcodeproj` in Xcode
|
|
* Launch the project
|
|
|
|
Running Tests
|
|
---
|
|
|
|
* Open `CodePushDemoApp.xcodeproj` in Xcode
|
|
* Navigate to the test explorer (small grey diamond near top left)
|
|
* Click on the 'play' button next to CodePushDemoAppTests
|
|
* After the tests are completed, green ticks should appear next to the test cases to indicate success
|
|
|
|
|
|
## LocalPackage
|
|
Contains details about an update package that has been downloaded locally or already applied (currently installed package).
|
|
### Properties
|
|
- __deploymentKey__: Deployment key of the package. (String)
|
|
- __description__: Package description. (String)
|
|
- __label__: Package label. (String)
|
|
- __appVersion__: The native version of the application this package update is intended for. (String)
|
|
- __isMandatory__: Flag indicating if the update is mandatory. (Boolean)
|
|
- __packageHash__: The hash value of the package. (String)
|
|
- __packageSize__: The size of the package, in bytes. (Number)
|
|
|
|
### Methods
|
|
- __apply(rollbackTimeout): Promise__: Applies this package to the application. The application will be reloaded with this package and on every application launch this package will be loaded.
|
|
If the rollbackTimeout parameter is provided, the application will wait for a codePush.notifyApplicationReady() for the given number of milliseconds.
|
|
If codePush.notifyApplicationReady() is called before the time period specified by rollbackTimeout, the apply operation is considered a success.
|
|
Otherwise, the apply operation will be marked as failed, and the application is reverted to its previous version.
|
|
|
|
## RemotePackage
|
|
Contains details about an update package that is available for download.
|
|
### Properties
|
|
- __deploymentKey__: Deployment key of the package. (String)
|
|
- __description__: Package description. (String)
|
|
- __label__: Package label. (String)
|
|
- __appVersion__: The native version of the application this package update is intended for. (String)
|
|
- __isMandatory__: Flag indicating if the update is mandatory. (Boolean)
|
|
- __packageHash__: The hash value of the package. (String)
|
|
- __packageSize__: The size of the package, in bytes. (Number)
|
|
- __downloadUrl__: The URL at which the package is available for download. (String)
|
|
|
|
### Methods
|
|
- __download(): Promise<LocalPackage>__: Downloads the package update from the CodePush service. Returns a Promise that resolves with the LocalPackage.
|
|
|
|
## codePush.checkForUpdate
|
|
Queries the CodePush server for updates.
|
|
```javascript
|
|
codePush.checkForUpdate(): Promise<RemotePackage>;
|
|
```
|
|
|
|
`checkForUpdate` returns a Promise that resolves when the server responds with an update.
|
|
|
|
|
|
Usage:
|
|
```javascript
|
|
codePush.checkForUpdate().then((update) => {
|
|
console.log(update);
|
|
});
|
|
```
|
|
|
|
## codePush.getCurrentPackage
|
|
```javascript
|
|
codePush.getCurrentPackage(): Promise<LocalPackage>;
|
|
```
|
|
Get the currently installed package information. Returns a Promise that resolves with the local package.
|
|
|
|
## codePush.notifyApplicationReady
|
|
```javascript
|
|
codePush.notifyApplicationReady(): Promise<void>;
|
|
```
|
|
|
|
Notifies the plugin that the update operation succeeded.
|
|
Calling this function is required if a rollbackTimeout parameter is passed to your ```LocalPackage.apply``` call.
|
|
If automatic rollback was not used, calling this function is not required and will result in a noop.
|