Rename CodePushPublicKey to CodePushSigningPublicKey for clarity

Author: Minishlink

README.md

@@ -98,12 +98,14 @@ If you are less in a hurry, you can migrate to `@appzung/react-native-code-push`
 #### Change your iOS setup
 
 1. Run `bundle exec pod install`
+2. (optional) If you already use code signing, rename `CodePushPublicKey` to `CodePushSigningPublicKey` in your `Info.plist`
 
 #### Change your Android setup
 
 1. In `android/settings.gradle` change the lines about CodePush : `include ':appzung_react-native-code-push'` and `project(':appzung_react-native-code-push').projectDir = new File(rootProject.projectDir, '../node_modules/@appzung/react-native-code-push/android/app')`
 2. In `android/app/build.gradle` change the line about CodePush: `apply from: "../../node_modules/@appzung/react-native-code-push/android/codepush.gradle"`
 3. In your Android files (eg. `MainApplication.kt`), rename every `com.microsoft.codepush` prefix imports with `com.appzung.codepush`
+4. (optional) If you already use code signing, rename `CodePushPublicKey` to `CodePushSigningPublicKey` in your strings resources
 
 ### Migrating to AppZung CLI
 

android/app/src/main/java/com/microsoft/codepush/react/CodePush.java

@@ -78,8 +78,11 @@ public CodePush(String deploymentKey, Context context, boolean isDebugMode) {
 
         mCurrentInstance = this;
 
-        String publicKeyFromStrings = getCustomPropertyFromStringsIfExist("PublicKey");
-        if (publicKeyFromStrings != null) mPublicKey = publicKeyFromStrings;
+        String publicKeyFromStrings = getCustomPropertyFromStringsIfExist("SigningPublicKey");
+        if (publicKeyFromStrings != null) {
+            CodePushUtils.log("Executing CodePush with a signing public key.");
+            mPublicKey = publicKeyFromStrings;
+        }
 
         String serverUrlFromStrings = getCustomPropertyFromStringsIfExist("ServerUrl");
         if (serverUrlFromStrings != null) mServerUrl = serverUrlFromStrings;
@@ -124,6 +127,9 @@ private String getPublicKeyByResourceDescriptor(int publicKeyResourceDescriptor)
         if (publicKey.isEmpty()) {
             throw new CodePushInvalidPublicKeyException("Specified public key is empty");
         }
+
+        CodePushUtils.log("Executing CodePush with a signing public key.");
+
         return publicKey;
     }
 

docs/api-android.md

@@ -8,9 +8,9 @@ You can customize CodePush by placing these values in string resources.
     ```
 
 * __Public Key__ - used for bundle verification in the Code Signing Feature. Please refer to [Code Signing](setup-android.md#code-signing-setup) section for more details about the Code Signing Feature.
-  To set the public key, you should add the content of the public key to `strings.xml` with name `CodePushPublicKey`. CodePush automatically gets this property and enables the Code Signing feature. For example:
+  To set the public key, you should add the content of the public key to `strings.xml` with name `CodePushSigningPublicKey`. CodePush automatically gets this property and enables the Code Signing feature. For example:
   ```xml
-  <string moduleConfig="true" name="CodePushPublicKey">your-public-key</string>
+  <string moduleConfig="true" name="CodePushSigningPublicKey">your-public-key</string>
   ```
 
 * __Server Url__ - used for specifying CodePush Server Url (as an Enterprise customer we may setup a custom infra for your needs).

docs/setup-android.md

@@ -90,12 +90,12 @@
 
 You can self sign bundles during release and verify its signature before installation of update. In order to use Public Key for Code Signing you need to do following steps:
 
-Add the `CodePushPublicKey` string resource in `/android/app/src/main/res/values/strings.xml`. It may looks like this:
+Add the `CodePushSigningPublicKey` string resource in `/android/app/src/main/res/values/strings.xml`. It may looks like this:
 
  ```xml
  <resources>
     <string name="app_name">my_app</string>
-    <string name="CodePushPublicKey">-----BEGIN PUBLIC KEY-----
+    <string name="CodePushSigningPublicKey">-----BEGIN PUBLIC KEY-----
 MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtPSR9lkGzZ4FR0lxF+ZA
 P6jJ8+Xi5L601BPN4QESoRVSrJM08roOCVrs4qoYqYJy3Of2cQWvNBEh8ti3FhHu
 tiuLFpNdfzM4DjAw0Ti5hOTfTixqVBXTJPYpSjDh7K6tUvp9MV0l5q/Ps3se1vud

docs/setup-ios.md

@@ -55,14 +55,14 @@
 
 You can self sign bundles during release and verify its signature before installation of update.
 
-In order to configure Public Key for bundle verification you need to add record in `Info.plist` with name `CodePushPublicKey` and string value of public key content. Example:
+In order to configure Public Key for bundle verification you need to add record in `Info.plist` with name `CodePushSigningPublicKey` and string value of public key content. Example:
 
 ```xml
 <plist version="1.0">
   <dict>
     <!-- ...other configs... -->
 
-    <key>CodePushPublicKey</key>
+    <key>CodePushSigningPublicKey</key>
         <string>-----BEGIN PUBLIC KEY-----
 MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANkWYydPuyOumR/sn2agNBVDnzyRpM16NAUpYPGxNgjSEp0etkDNgzzdzyvyl+OsAGBYF3jCxYOXozum+uV5hQECAwEAAQ==
 -----END PUBLIC KEY-----</string>

ios/CodePush/CodePushConfig.m

@@ -35,8 +35,8 @@ - (instancetype)init
     NSString *buildVersion = [infoDictionary objectForKey:(NSString *)kCFBundleVersionKey];
     NSString *deploymentKey = [infoDictionary objectForKey:@"CodePushDeploymentKey"];
     NSString *serverURL = [infoDictionary objectForKey:@"CodePushServerURL"];
-    NSString *publicKey = [infoDictionary objectForKey:@"CodePushPublicKey"];
-    
+    NSString *publicKey = [infoDictionary objectForKey:@"CodePushSigningPublicKey"];
+
     NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
     NSString *clientUniqueId = [userDefaults stringForKey:ClientUniqueIDConfigKey];
     if (clientUniqueId == nil) {
@@ -56,7 +56,10 @@ - (instancetype)init
     if (serverURL) [_configDictionary setObject:serverURL forKey:ServerURLConfigKey];
     if (clientUniqueId) [_configDictionary setObject:clientUniqueId forKey:ClientUniqueIDConfigKey];
     if (deploymentKey) [_configDictionary setObject:deploymentKey forKey:DeploymentKeyConfigKey];
-    if (publicKey) [_configDictionary setObject:publicKey forKey:PublicKeyKey];
+    if (publicKey) {
+        CPLog(@"Executing CodePush with a signing public key.");
+        [_configDictionary setObject:publicKey forKey:PublicKeyKey];
+    }
 
     return self;
 }
@@ -111,6 +114,6 @@ - (void)setServerURL:(NSString *)serverURL
     [_configDictionary setValue:serverURL forKey:ServerURLConfigKey];
 }
 
-//no setter for PublicKey, because it's need to be hard coded within Info.plist for safety
+//no setter for SigningPublicKey, because it's need to be hard coded within Info.plist for safety
 
 @end