Skip to content

revopush 2.0 migration guide #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kit2o merged 1 commit into from
Jan 19, 2026
Merged

revopush 2.0 migration guide #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .vitepress/config.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,15 @@ export default defineConfig({
{text: 'Expo integration', link: '/intro/expo'},
]
},
{
text: 'Revopush 2.0',
collapsed: true,
items: [
{text: 'What is Revopush 2.0?', link: '/revopush20/intro'},
{text: 'Getting started', link: '/revopush20/getting-started'},
{text: 'Migrate from Revopush 1.x', link: '/revopush20/migration'},
]
},
{
text: 'Troubleshooting',
collapsed: true,
Expand Down
268 changes: 9 additions & 259 deletions intro/revopush-diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,259 +1,9 @@
# Revopush 2.0 User guide

This 5-minute guide will help you to set up your first Revopush 2.0 integration

## Create an account

First, you need to create an account at the following service: https://app.revopush.org/register

## Create an application

1. Go to [Applications](https://app.revopush.org/applications) and add an application

![Add new application](/images/intro/add-new-app.png)

2. Enter application name and save it

![Add new application modal](/images/intro/add-new-app-modal.png)

3. As a result, you will see your application in the list with two deployments available out of the box

![Application list](/images/intro/add-new-app-list.png)

## Setup mobile client SDK

- For React Native **>=0.76**, or you need support for New Architecture, you should use Revopush client SDK.

| React Native version(s) | Supporting CodePush version(s) |
|------------------------------------|---------------------------------------------|
| 0.76, 0.77, 0.78, 0.79, 0.80, 0.81 | @revopush/react-native-code-push@2.5.0-rc.2 |

#### For this guide we will use Revopush SDK

Install Revopush client:

```bash
npm install --save @revopush/react-native-code-push@2.5.0-rc.2
```

#### Setup iOS

Go to the `ios/[ProjectName]/AppDelegate.swift` and replace:

```swift
import CodePush // [!code ++]

override func bundleURL() -> URL? {
#if DEBUG
RCTBundleURLProvider.sharedSettings().jsBundleURL(forBundleRoot: "index")
#else
Bundle.main.url(forResource: "main", withExtension: "jsbundle") // [!code --]
CodePush.bundleURL() // [!code ++]
#endif
}
```

Go to the `ios/[ProjectName]/AppDelegate.mm` and replace:

```Objc
#import <CodePush/CodePush.h> // [!code ++]

- (NSURL *)bundleURL
{
#if DEBUG
return [[RCTBundleURLProvider sharedSettings] jsBundleURLForBundleRoot:@"index"];
#else
return [[NSBundle mainBundle] URLForResource:@"main" withExtension:@"jsbundle"]; // [!code --]
return [CodePush bundleURL]; // [!code ++]
#endif
}
```

::: warning
Put this line to `ios/.xcode.env.local` and `ios/.xcode.env`

```shell
export SOURCEMAP_FILE="$DERIVED_FILE_DIR/main.jsbundle.map"
```

:::

#### Setup Android

Go to the `android/app/build.gradle` and add:

```kotlin
apply plugin: "com.android.application"
apply plugin: "org.jetbrains.kotlin.android"
apply plugin: "com.facebook.react"

apply from: "../../node_modules/@revopush/react-native-code-push/android/codepush.gradle" // [!code ++]
```

Then apply changes to MainApplication.kt in the `android/app/src/main/../MainApplication.kt`

```kotlin
import com.facebook.react.soloader.OpenSourceMergedSoMapping
import com.facebook.soloader.SoLoader

import com.microsoft.codepush.react.CodePush // [!code ++]

class MainApplication : Application(), ReactApplication {

override val reactNativeHost: ReactNativeHost =
object : DefaultReactNativeHost(this) {
override fun getPackages(): List<ReactPackage> =
PackageList(this).packages.apply {}

override fun getJSBundleFile(): String { // [!code ++]
return CodePush.getJSBundleFile()// [!code ++]
}// [!code ++]

override fun getJSMainModuleName(): String = "index"
}
}
```

After you configure your React Native application go to app settings to get Deployment keys:

![Application deployments](/images/intro/deployments-list.png)

### Setup deployment key for iOS

Add the `CodePushServerURL` and `CodePushDeploymentKey` to the file `ios/[ProjectName]/Info.plist`

```xml
<key>CodePushServerURL</key>
<string>https://api.revopush.org</string>
<key>CodePushDeploymentKey</key>
<string>YOUR_DEPLOYMENT_KEY</string>
```

### Setup deployment key for Android

Add the `CodePushServerUrl` and `CodePushDeploymentKey` to the file `android/app/src/main/res/values/strings.xml`

```xml
<resources>
<string moduleConfig="true" name="CodePushServerUrl">https://api.revopush.org</string>
<string moduleConfig="true" name="CodePushDeploymentKey">YOUR_DEPLOYMENT_KEY</string>
</resources>

```

## JS configuration

Configure the SDK in the JavaScript layer of your app (minimal setup):

```js
import codePush from "@revopush/react-native-code-push";

class MyApp extends Component {}

MyApp = codePush(MyApp);
```

More details: [JS SDK API](/sdk/api-js)

## Configure CLI

After registration, install the Revopush CLI.

Uninstall existing version of Revopush CLI:

```shell
npm uninstall -g @revopush/code-push-cli
```

Install Revopush CLI version:

```shell
npm i -g @revopush/code-push-cli@0.0.8
```

Login to Revopush CLI using the following command:

```shell
revopush login
```

This will launch a browser, asking you to authenticate with either your GitHub or Google account.
This will generate an access key that you need to copy/paste into the CLI (it will prompt you for it).
You are now successfully authenticated and can safely close your browser window.

```shell
Opening your browser...
Visit https://app.revopush.org/cli-login?hostname=<YOUR_HOST_NAME> and enter the code

Enter your access key:
```

Read more about [Revopush CLI](/cli/getting-started)

## Make a release

To use **Diff updates** together with Revopush SDK 2.0, you must first create a base release for the specific binary version of the app you are targeting.

#### What is a base release?

A base release is a snapshot of your assets and JavaScript bundle exactly as they were shipped to the app stores together with your IPA/APK.

This snapshot is then used as a baseline to generate diffs only for assets and the JS bundle that already exist in the store build and on users’ devices.

As a result, update payload sizes are reduced by 10–20×, and update delivery to users becomes significantly faster.

To create a base release, you first need to build release APK/IPA files for the target platform and then provide these files as CLI parameters to create the base release.

```shell
revopush release-native <APPLICATION_NAME> ios ./path_to_ipa/app.ipa
```

```shell
revopush release-react <APPLICATION_NAME> android ./path_to_ipa/app.apk
```

Full command specification:

```shell
revopush release-native <appName> <platform> <targetBinary> [options]

Options:
--help Show help [boolean]
-d, --deploymentName Deployment to release the update to [string] [default: "Staging"]
-t, --targetBinaryVersion Semver expression that specifies the binary app version(s) this release is targeting (e.g. 1.1.0, ~1.2.3). [string] [default: null]
-v, --version Show version number [boolean]
```

#### Regular release

```shell
revopush release-react <APPLICATION_NAME> ios -d <DEPLOYMENT_NAME>
```

```shell
revopush release-react <APPLICATION_NAME> android -d <DEPLOYMENT_NAME>
```

::: warning
To properly calculate diff updates when using `-o` or `--outputDir` parameter, the output directory must end with **CodePush**.

For example:

```shell
revopush release-react <APPLICATION_NAME> android -d <DEPLOYMENT_NAME> -o ./build/CodePush
```
:::

Read more about Releases in [Releasing updates guide](/cli/releasing-updates)

## Run application in release mode

If you want to test integration locally run the app in Release mode on an emulator or real device:

```shell
npx react-native run-ios --mode Release --no-packager
npx react-native run-android --mode Release --no-packager
```

This ensures the app doesn't rely on the local Metro bundler and uses the deployed update instead.

---
head:
- - meta
- http-equiv: refresh
content: 0; url=/revopush20/getting-started
---

# Redirecting...
If you are not redirected automatically, [click here](/revopush20/getting-started).
Loading