fastlane-plugin-react_native_release 0.3.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c6db2dcb8566ef24876fd189f29f38cd3cbecdd59c8ce89e7df399b10e6902c
-  data.tar.gz: 2626f9f632f1fa7deaa98ec880171692c3c05db8bea3bc1fe70bed115cad312b
+  metadata.gz: 3b8d333b98e735533f90b2cb2e443f0565756066be831850f3a981b6c4522228
+  data.tar.gz: b5ed1dda7f25ce3804805f150b871db2eaa90178b6c3c0bb1bbb8f812f0d406f
 SHA512:
-  metadata.gz: bf7a63f2298aa414a703ad735465802f4268e2d3f0c7e2f5023d96338447c811b88f8bd68ca26d67a8b5a274054ee4c12baa9021d237d9c9b706842951e375fb
-  data.tar.gz: da7e7e339c2e834d17d829db5f4e5df449c1fb1c52b6d5b5cf0e5c039f7c510efb47550fd326210a76afad6221958fa4022ab605af98edb91dd4e4176d3f9dda
+  metadata.gz: c8ee11d162d5ef17168b9d39e882bbc5018036082cf9d4b70b090e66cd568183e620ec1eb7735c01275f9bd1d7a3c35d534dd9472c86fc55d8b4728d355d230c
+  data.tar.gz: 84658b6da50fa4f8bd13eb471201a611068874091891bf864106739314338db646d1cde5719fc8d0c8ba36e229b84953d0a097b2fd4b8dd3b8bf2a27582cfc6c

data/README.md

@@ -1,80 +1,159 @@
-# React Native Release 
+# React Native Release
 
 [![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-react_native_release)
 
-## Getting Started
+Simplify releases for your React Native apps. This plugin contains many actions to help you with your release workflow.
 
-This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-react_native_release`, add it to your project by running:
+It helps cut a new `beta` or `release` version of your app:
 
-```bash
-fastlane add_plugin react_native_release
-```
+- Authenticates and stores an encrypted App Store Connect session that is later used for TestFlight and App Store operations
+- Prompts the user for a `major/minor/patch` version bump
+- Bumps the version of the iOS and Android app appropriately
+- Creates a tag
+- Handles hotfix releases
+- Handles merging version bumps and hotfixes back to the appropriate branches
+
+It encrypts, and on CI, decrypts values from a standalone "context" git repository:
+
+- Android keystore file (including helping you generate one)
+- Google Play Credentials to upload to the Play Store
+- Fastlane config ENV variables
+- App ENV variables (API_URL, feature flags, etc)
+
+### Philosophies
+
+**Use Fastlane Match**
+
+Certificates and provisioning profiles should be created and managed by Fastlane Match
+
+**Builds Run on CI**
+
+We support local builds for projects, but they should only be used in emergency situations.
+
+**CI uses a machine user**
+
+This is a best practice.
+
+**ENV vars are managed through React Native Release**
+
+We do this for portability and ease of configuration. Outside of the ENV vars to configure CRYPTEX, you shouldn't have to add ENV vars to CI.
+
+For App ENV vars, we provide some additional functionality via namespaces. Valid namespaces are `alpha`, `beta`, `release`, and empty (root). Root ENV vars are "global". Namespaced variables are merged into the Root ENV vars at build time via the `decrypt_app_vars` action. This allows you to easily overwrite ENV vars for specific types of builds, all without configuring separate targets and schemes in XCode.
+
+The main branch and tagging flow looks like this (note this may be out of date. Revisit after workflow updates):
+
+![Branch / Tag Flow](https://monosnap.com/image/Tn71leeWdCwwjSdwjYKHK4pnyjG1v4.png)
+
+If a hotfix is required the flow looks like this (note this may be out of date. Revisit after workflow updates):
+
+![Hotfix Flow](https://monosnap.com/image/ctwlef0A3TbLbRk1xJrlVroNB8F9ot.png)
+
+Here's what it looks like in action:
+![Releasing a beta](https://api.monosnap.com/image/download?id=IEISpG4vgMeGPl31it8GxPbiTror2i)
+(this example uses `"release": "bundle exec fastlane run react_native_release"` as a yarn script)e
+
+## Prerequisites
 
 ### Ensure your project confirms to Semantic Versioning
+
 Projects using React Native Release should use Semantic Versioning. At the very least, you need major, minor, and patch numbers in your version.
 
 **iOS**
 Use `agvtool` to get and set a version across your project. From the `ios` directory, do the following:
-* `agvtool what-marketing-version` to see your current version
-* `agvtool new-marketing-version 0.1.0` to set a new version
+
+- `agvtool what-marketing-version` to see your current version
+- `agvtool new-marketing-version 0.1.0` to set a new version
 
 **Android**
-* Set `versionName` in `app/build.gradle`. (`versionName "0.1.0"`)
+
+- Set `versionName` in `app/build.gradle`. (`versionName "0.1.0"`)
 
 :exclamation: If you don't complete these steps, releases will fail. :exclamation:
 
-### Configuring builds to TestFlight and AppStore Connect on CI
+## Installation
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. Since React Native projects contain both `iOS` and `Android` apps, we need to install the plugin in multiple places:
+
+### Install plugin into fastlane folders
+
+1. In the root of your project. This is used to run release commands over the entire project.
+
+```bash
+fastlane add_plugin react_native_release
+```
+
+2. In `./android/fastlane`
+
+```bash
+fastlane add_plugin react_native_release
+```
 
-To upload builds to TestFlight or AppStore Connect, your CI will need a session cookie that was generated with a 2FA code. React Native Release generates and stores this code securely in Github, when the local release script runs, and CI consumes the cookie during the IOS build upload step for jobs uploading to TestFlight or AppStore Connect.
+3. In `./ios/fastlane`
+
+```bash
+fastlane add_plugin react_native_release
+```
 
-To enable the fastlane session add an `.env` file at `<root>/fastlane/.env` with the following configuration.
+### Add or update .env files
 
-| KEY | TYPE | DESCRIPTION |
-|-----|------|-------------|
-| FASTLANE_ENV_GIT_URL | String | The repository where the hashed session token will be stored. **Ensure this repository before running the release script!** (Must be a separate repository solely for securely storing the session token). |
-| FASTLANE_ENV_USERNAME | String | The Apple Developer Account email to authenticate with 2FA and generate a session token for. |
+We leverage `.env` files in a number of different places.
 
-Note: Apple requires 2FA on all accounts now and the IOS build steps will fail if you attempt to upload to TestFlight or AppStore Connect without a session token.
+`<root>/fastlane/.env`:
 
-#### Important!
+| KEY               | TYPE    | DESCRIPTION                                                                                                                                                                                   |
+| ----------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| CRYPTEX_GIT_URL   | String  | The repository where the hashed session token will be stored. **Ensure this repository before running the release script!** (You can leverage the same repository you use for Fastlane Match) |
+| CRYPTEX_PASSWORD  | String  | The secret key used to encrypt/decrypt the `FASTLANE_SESSION` value.                                                                                                                          |
+| CRYPTEX_SKIP_DOCS | Boolean | Force the underlying encryption plugin to skip README generation.                                                                                                                             |
 
-Before running the release script, we will need to authenticate locally and generate an initial token to store credentials in the keychain to be used  in the release script.
+`<root>/android/fastlane/.env`:
 
-1. Using the same *Apple Developer Account* (`FASTLANE_ENV_USERNAME`) in the `<root>/fastlane/.env` authenticate on [AppStore Connect](https://appstoreconnect.apple.com/login).
+| KEY                  | TYPE    | DESCRIPTION                                                                                                                                                                                   |
+| -------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| ANDROID_KEY_PASSWORD | String  | The password generated from `generate_android_keystore` or a manual keystore command.`                                                                                                        |
+| ANDROID_KEY_ALIAS    | String  | The alias for the keystore                                                                                                                                                                    |
+| CRYPTEX_GIT_URL      | String  | The repository where the hashed session token will be stored. **Ensure this repository before running the release script!** (You can leverage the same repository you use for Fastlane Match) |
+| CRYPTEX_PASSWORD     | String  | The secret key used to encrypt/decrypt the `FASTLANE_SESSION` value.                                                                                                                          |
+| CRYPTEX_SKIP_DOCS    | Boolean | Force the underlying encryption plugin to skip README generation.                                                                                                                             |
 
-2. Then run `fastlane spaceauth -u {YOUR FASTLANE_ENV_USERNAME}`, enter your Apple Developer Account password and complete the 2FA code if prompted.
+`<root>/ios/fastlane/.env`:
 
-These steps are required for every machine, otherwise the release script will fail.
+| KEY               | TYPE    | DESCRIPTION                                                                                                                                                                                   |
+| ----------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| MATCH_GIT_URL     | String  | The repository used for Fastlane match. Typically the same as CRYPTEX_GIT_URL                                                                                                                 |
+| MATCH_PASSWORD    | String  | The password used to encrypt / decrypt Fastlane Match certs and profiles                                                                                                                      |
+| GYM_WORKSPACE     | String  | The name of the workspace file (Myproject.xcworkspace)                                                                                                                                        |
+| GYM_SCHEME        | String  | The scheme to build within the workspace (Myproject)                                                                                                                                          |
+| GYM_OUTPUT_NAME   | String  | The name of the `.ipa` file to output (Myproject)                                                                                                                                             |
+| CRYPTEX_GIT_URL   | String  | The repository where the hashed session token will be stored. **Ensure this repository before running the release script!** (You can leverage the same repository you use for Fastlane Match) |
+| CRYPTEX_PASSWORD  | String  | The secret key used to encrypt/decrypt the `FASTLANE_SESSION` value.                                                                                                                          |
+| CRYPTEX_SKIP_DOCS | Boolean | Force the underlying encryption plugin to skip README generation.                                                                                                                             |
 
+**Note: In followup releases, we will add a `react-native-release init` script to generate these for you.**
 
-## About React Native Release
+### Setup CI
 
-Simplify releases for React Native apps.
+Step 1. If you've already setup Fastlane Match, skip this section. Each provider is different, but conceptually you'll want to:
 
-This plugin:
+- Create a machine user account on your source code provider (GitHub or BitBucket) and invite that account to both the mobile and certs repo.
+- Enable CI on the main mobile repository by pressing "Follow" or "Build"
+- In an Incognito tab, log into your CI provider with the machine user account.
+- Add a user key instead of the default deploy key. This will allow CI to auth as the machine user and gain access to _both_ the mobile repo and the context repo.
 
-- cuts a new `beta` or `production` release
-- prompts the user for a `major/minor/patch` version bump
-- bumps the version of the iOS and Android app appropriately
-- tags a release based on the iOS and Android version
-- handles hotfix releases
-- handles merging version bumps and hotfixes back to the appropriate branches
+Step 2. Add the following to your CI environment variables:
 
-The main branch and tagging flow looks like this:
-![Branch / Tag Flow](https://monosnap.com/image/Tn71leeWdCwwjSdwjYKHK4pnyjG1v4.png)
+- CRYPTEX_GIT_URL=(your context repo ssh git url)
+- CRYPTEX_PASSWORD=(your context repo password)
+- CRYPTEX_VERBOSE=true
+- CRYPTEX_DIGEST=sha256 (note: if you have a pre-existing setup, you should set this to md5 - see https://github.com/hjanuschka/fastlane-plugin-cryptex/pull/10)
 
-If a hotfix is required the flow looks like this:
-![Hotfix Flow](https://monosnap.com/image/ctwlef0A3TbLbRk1xJrlVroNB8F9ot.png)
+### Configuring builds to upload to TestFlight and AppStore Connect on CI
 
-Here's what it looks like in action:
-![Releasing a beta](https://api.monosnap.com/image/download?id=IEISpG4vgMeGPl31it8GxPbiTror2i)
-(this example uses `"release": "bundle exec fastlane run react_native_release"` as a yarn script)
+To upload builds to TestFlight or AppStore Connect, CI will need to restore a previously generated session. While possible to use an Application Specific Password to upload builds, it will not have the additional permissions required for other TestFlight / App Store operations. As such, we require generating a session.
 
 ## Example
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
-
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+See /example to see how to use the plugin. (TODO)
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/react_native_release/actions/accept_android_sdk_licenses.rb

@@ -0,0 +1,46 @@
+require 'fastlane/action'
+require 'fastlane/plugin/cryptex'
+
+module Fastlane
+  module Actions
+    class AcceptAndroidSdkLicensesAction < Action
+      def self.run(params)
+        sh("yes | $ANDROID_HOME/tools/bin/sdkmanager --licenses || if [ $? -ne '141' ]; then exit $?; fi;")
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Accepts Android sdk licenses"
+      end
+
+      def self.details
+        # Optional:
+        # this is your chance to provide a more detailed description of this action
+      end
+
+      def self.available_options
+        []
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # "Saves the current vars in android/fastlane/.env and ios/fastlane/.env"
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ["cball", "isaiahgrey93"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/react_native_release/actions/add_app_var.rb

@@ -0,0 +1,107 @@
+require 'fastlane/action'
+require 'fastlane/plugin/cryptex'
+
+module Fastlane
+  module Actions
+    class AddAppVarAction < Action
+      def self.run(params)
+        is_ci = ENV['CI'] === 'true'
+        namespace = params[:namespace]
+        key = params[:key]
+        value = params[:value]
+        skip_confirmation= params[:skip_confirmation]
+        cryptex_app_key = app_key_for(namespace)
+        existing_app_vars = {}
+
+        if !is_ci && !skip_confirmation && !UI.confirm("This will add #{key}=#{value} to the #{cryptex_app_key} namespace in the encrypted context repo. Proceed?")
+          UI.abort_with_message!("Stepping away...")
+        end
+
+        begin
+          existing_app_vars = other_action.cryptex(
+            type: 'export_env',
+            key: cryptex_app_key,
+          )
+        rescue => ex
+          # If key doesn't exist cryptex will error
+        end
+
+        other_action.cryptex(
+          type: "import_env",
+          key: cryptex_app_key,
+          hash: existing_app_vars.merge({ key => value })
+        )
+
+        UI.success('Encrypted app ENV vars')
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Adds a single ENV var to the encrypted repository"
+      end
+
+      def self.details
+        # Optional:
+        # this is your chance to provide a more detailed description of this action
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :namespace,
+                                       env_name: "FL_ADD_APP_VAR_NAMESPACE",
+                                       description: "What namespace should we use? (alpha, beta, release, ENTER = root)", # a short description of this parameter
+                                       type: String,
+                                       verify_block: lambda do |value|
+                                        unless Helper::ReactNativeReleaseHelper::VALID_NAMESPACES.include?(value)
+                                          UI.user_error!("Invalid namespace #{value}. Valid targets are #{Helper::ReactNativeReleaseHelper::VALID_NAMESPACES.join(', ')}") 
+                                          next
+                                        end
+                                      end),
+          FastlaneCore::ConfigItem.new(key: :key,
+                                       env_name: "FL_ADD_APP_VAR_KEY",
+                                       description: "Enter the ENV name",
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :value,
+                                       env_name: "FL_ADD_APP_VAR_VALUE",
+                                       description: "Enter the ENV value",
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :skip_confirmation,
+                                       env_name: "FL_ENCRYPT_APP_VARS_SKIP_CONFIRMATION", # The name of the environment variable
+                                       description: "Allows commands to be run from within CLI and skip the UI.message confirmation dialog", # a short description of this parameter
+                                       type: Boolean,
+                                       short_option:'s',
+                                       default_value: false,
+                                       optional: true),
+        ]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # "Saves the current vars in android/fastlane/.env and ios/fastlane/.env"
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ["cball", "isaiahgrey93","cmejet"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+
+      # Returns the app key for cryptex. optionally namespaced
+      def self.app_key_for(namespace)
+        default_app_key = Helper::ReactNativeReleaseHelper::APP_CRYPTEX_KEY 
+        return default_app_key if namespace.strip.empty?
+
+        "#{namespace}_#{default_app_key}"
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/react_native_release/actions/add_fastlane_var.rb

@@ -0,0 +1,99 @@
+require 'fastlane/action'
+require 'fastlane/plugin/cryptex'
+
+module Fastlane
+  module Actions
+    class AddFastlaneVarAction < Action
+      def self.run(params)
+        is_ci = ENV['CI'] === 'true'
+        cryptex_key = Helper::ReactNativeReleaseHelper::FASTLANE_CRYPTEX_KEY
+       
+        key = params[:key]
+        value = params[:value]
+        existing_app_vars = {}
+
+        if !is_ci && !UI.confirm("This will add #{key}=#{value} to the #{cryptex_key} namespace in the encrypted context repo. Proceed?")
+          UI.abort_with_message!("Stepping away...")
+        end
+
+        begin
+          existing_vars = other_action.cryptex(
+            type: 'export_env',
+            key:  cryptex_key
+          )
+        rescue => ex
+          # If key doesn't exist cryptex will error
+        end
+
+        other_action.cryptex(
+          type: "import_env",
+          key:  cryptex_key,
+          hash: existing_vars.merge({ key => value })
+        )
+
+        UI.success('Encrypted fastlane ENV vars')
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Adds a single ENV var for fastlane to the encrypted repository"
+      end
+
+      def self.details
+        # Optional:
+        # this is your chance to provide a more detailed description of this action
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :key,
+                                       env_name: "FL_ADD_APP_VAR_KEY",
+                                       description: "Enter the ENV name",
+                                       type: String),
+          FastlaneCore::ConfigItem.new(key: :value,
+                                       env_name: "FL_ADD_APP_VAR_VALUE",
+                                       description: "Enter the ENV value",
+                                       type: String),
+        ]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # "Saves the current vars in android/fastlane/.env and ios/fastlane/.env"
+      end
+
+      def self.authors
+        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
+        ["cball", "isaiahgrey93"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :android].include?(platform)
+      end
+
+      # Returns a path for an env var. optionally namespaced
+      def self.env_path_for(namespace)
+        return default_env_path if namespace.strip.empty?
+        "#{default_env_path}.#{namespace}"
+      end
+
+      # Returns the app key for cryptex. optionally namespaced
+      def self.app_key_for(namespace)
+        default_app_key = Helper::ReactNativeReleaseHelper::APP_CRYPTEX_KEY 
+        return default_app_key if namespace.strip.empty?
+
+        "#{namespace}_#{default_app_key}"
+      end
+
+      def self.default_env_path
+        Helper::ReactNativeReleaseHelper::APP_ENV_PATH
+      end
+    end
+  end
+end