@appcircle/codepush-cli 0.1.0 → 0.1.1-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -49
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,10 +3,35 @@
|
|
|
3
3
|
> The implementation has been modified and may differ from the original.
|
|
4
4
|
> Documentation is currently being updated to reflect these changes.
|
|
5
5
|
|
|
6
|
+
|
|
6
7
|
# CodePush CLI
|
|
7
8
|
|
|
8
9
|
The CodePush CLI is a Node.js application that allows users to interact with CodePush Server.
|
|
9
10
|
|
|
11
|
+
## Table of Contents
|
|
12
|
+
1. [Installation](#installation)
|
|
13
|
+
2. [Getting started](#getting-started)
|
|
14
|
+
3. [Usage](#usage)
|
|
15
|
+
4. [Account Management](#account-management)
|
|
16
|
+
- [Authentication](#authentication)
|
|
17
|
+
- [Access Keys](#access-keys)
|
|
18
|
+
5. [App Management](#app-management)
|
|
19
|
+
- [Deployment Management](#deployment-management)
|
|
20
|
+
6. [Releasing Updates](#releasing-updates)
|
|
21
|
+
- [Releasing Updates (General)](#releasing-updates-general)
|
|
22
|
+
- [Releasing Updates (React Native)](#releasing-updates-react-native)
|
|
23
|
+
7. [Debugging CodePush Integration](#debugging-codepush-integration)
|
|
24
|
+
8. [Patching Update Metadata](#patching-update-metadata)
|
|
25
|
+
9. [Promoting Updates](#promoting-updates)
|
|
26
|
+
10. [Rolling Back Updates](#rolling-back-updates)
|
|
27
|
+
11. [Viewing Release History](#viewing-release-history)
|
|
28
|
+
12. [Clearing Release History](#clearing-release-history)
|
|
29
|
+
13. [Code Signing for CodePush](#code-signing-for-codepush)
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
10
35
|
## Installation
|
|
11
36
|
|
|
12
37
|
To run the CodePush CLI, follow these steps:
|
|
@@ -731,57 +756,10 @@ After running this command, client devices configured to receive updates using i
|
|
|
731
756
|
|
|
732
757
|
## Code Signing for CodePush
|
|
733
758
|
|
|
734
|
-
Code
|
|
735
|
-
|
|
736
|
-
### 1. Generate a Signing Key
|
|
737
|
-
|
|
738
|
-
**Create private and public keys using OpenSSL:**
|
|
739
|
-
|
|
740
|
-
```shell
|
|
741
|
-
# generate private RSA key and write it to private.pem file
|
|
742
|
-
openssl genrsa -out private.pem
|
|
743
|
-
|
|
744
|
-
# export public key from private.pem into public.pem
|
|
745
|
-
openssl rsa -pubout -in private.pem -out public.pem
|
|
746
|
-
```
|
|
747
|
-
|
|
748
|
-
### 2. Configure CodePush CLI
|
|
749
|
-
|
|
750
|
-
**Specify the path to your private key when releasing updates:**
|
|
759
|
+
Code signing ensures that updates deployed via CodePush are secure and verified. You can enable code signing when releasing updates by using the `--privateKeyPath` or `-k` option and specifying the path to your private key.
|
|
751
760
|
|
|
752
761
|
```shell
|
|
753
762
|
appcircle-code-push release-react <appName> <platform> --privateKeyPath private.pem
|
|
754
763
|
```
|
|
755
764
|
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
#### iOS
|
|
759
|
-
|
|
760
|
-
**Add the public key to your `Info.plist`:**
|
|
761
|
-
|
|
762
|
-
- Open your `Info.plist` file.
|
|
763
|
-
- Add a new entry:
|
|
764
|
-
|
|
765
|
-
```xml
|
|
766
|
-
<key>CodePushPublicKey</key>
|
|
767
|
-
<string>-----BEGIN PUBLIC KEY-----
|
|
768
|
-
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...
|
|
769
|
-
-----END PUBLIC KEY-----</string>
|
|
770
|
-
```
|
|
771
|
-
|
|
772
|
-
Replace the placeholder with the actual contents of your `public.pem` file.
|
|
773
|
-
|
|
774
|
-
#### Android
|
|
775
|
-
|
|
776
|
-
**Add the public key to your `strings.xml`:**
|
|
777
|
-
|
|
778
|
-
- Open `res/values/strings.xml`.
|
|
779
|
-
- Add the following entry:
|
|
780
|
-
|
|
781
|
-
```xml
|
|
782
|
-
<string name="CodePushPublicKey">-----BEGIN PUBLIC KEY-----
|
|
783
|
-
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA...
|
|
784
|
-
-----END PUBLIC KEY-----</string>
|
|
785
|
-
```
|
|
786
|
-
|
|
787
|
-
Replace the placeholder with the actual contents of your `public.pem` file.
|
|
765
|
+
For more information on how to configure code signing for your releases, refer to the [Appcircle documentation.](https://docs.appcircle.io/code-push/code-push-code-signing)
|