fastlane-plugin-react_native_release 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1b56dd04e4f45053993e073fb79a804c7280c02a323b8a4d8d0faff8013bd3a
-  data.tar.gz: a656b84729a0f3257da1699386f2cb3d1761a8dd0187f206a0a99a690fa32c41
+  metadata.gz: 85c358216aed69c8872ccca434dd6840958d56f9cd0d123d01df7aa623c5bbba
+  data.tar.gz: e76aeb88e60329c64251caf091e7806a570e985d7e915c8a96a88b1783cd4e9d
 SHA512:
-  metadata.gz: 863e046372fedf07bde580efa5f2301afa51cb9d35ad43beaf0db0f063b8f703b7ee8f8d9ea3bbf7ba66bb98538e9a924ad17a8558e6a2f6b36a851b20ecdd7a
-  data.tar.gz: 7eddc07b20b17f2d8fa386703172bece9c5c0a7d3577cef7df7a0be3c54f0998130a511b2b6ed35f277c21200366311908837c535621d920b6f97ce4e866aaeb
+  metadata.gz: d752e0955a2fa7c73e2f8a38db76cd2e8da383e203ebe743c2ed0b0bf5716812018f9d8c13311d0832eb6d59b1ce36d8e0800c8eb318b34cdc0bf799cf8b9eef
+  data.tar.gz: 2bfc9c7a783887edcf8ad103ac6b17c535f2ca48ab1f7dec40698644a1f6d1c37687d99fb193b5e619a11ba90fb9dd61aa956398b718c62856dfa590cbba15cb

data/README.md

@@ -1,86 +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:
 
-To upload builds to TestFlight or AppStore Connect, CI will need a cookie that was generated with a 2FA code. The `react_native_release` lane generates and stores this code securely in Github. We then use this token on CI during the IOS build upload step to TestFlight or AppStore Connect.
+### Install plugin into fastlane folders
 
-This is managed by the `fastlane-plugin-react_native_release` plugin in the iOS project. Start by adding the plugin to the iOS project by running:
+1. In the root of your project. This is used to run release commands over the entire project.
 
 ```bash
-cd ios && fastlane add_plugin react_native_release
+fastlane add_plugin react_native_release
 ```
 
-Then add the `read_fastlane_session` command to the end of the `before_all` step in your `<root>/ios/Fastfile`:
+2. In `./android/fastlane`
 
-```yaml
-  before_all do
-    setup_circle_ci
-    read_fastlane_session
-  end
+```bash
+fastlane add_plugin react_native_release
 ```
 
-Next add an `.env` file at `<root>/fastlane/.env` with the following configuration.
+3. In `./ios/fastlane`
 
-| 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. |
-| CRYPTEX_PASSWORD | String | The secret key used to encrypt/decrypt the `FASTLANE_SESSION` value. |
+```bash
+fastlane add_plugin react_native_release
+```
 
+### Add or update .env files
 
-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.
+We leverage `.env` files in a number of different places.
 
-## About React Native Release
+`<root>/fastlane/.env`:
 
-Simplify releases for React Native apps.
+| 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.                                                                                                                             |
 
-This plugin:
+`<root>/android/fastlane/.env`:
 
-- 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
+| 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.                                                                                                                             |
 
-The main branch and tagging flow looks like this:
-![Branch / Tag Flow](https://monosnap.com/image/Tn71leeWdCwwjSdwjYKHK4pnyjG1v4.png)
+`<root>/ios/fastlane/.env`:
 
-If a hotfix is required the flow looks like this:
-![Hotfix Flow](https://monosnap.com/image/ctwlef0A3TbLbRk1xJrlVroNB8F9ot.png)
+| 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.                                                                                                                             |
 
-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)
+**Note: In followup releases, we will add a `react-native-release init` script to generate these for you.**
 
-## Example
+### Setup CI
+
+Step 1. If you've already setup Fastlane Match, skip this section. Each provider is different, but conceptually you'll want to:
+
+- 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.
 
-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`.
+Step 2. Add the following to your CI environment variables:
+
+- 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)
+
+### Configuring builds to upload to TestFlight and AppStore Connect on CI
+
+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
 
-**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,109 @@
+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]
+        cryptex_app_key = app_key_for(namespace)
+        existing_app_vars = {}
+
+        if !is_ci && !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),
+        ]
+      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

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

@@ -0,0 +1,75 @@
+require 'fastlane/action'
+require 'fastlane/plugin/cryptex'
+
+module Fastlane
+  module Actions
+    class CreateFastlaneSessionAction < Action
+      def self.run(params)
+        username = params[:username]
+        key = Helper::ReactNativeReleaseHelper::FASTLANE_SESSION_CRYPTEX_KEY
+        fastlane_key = Helper::ReactNativeReleaseHelper::FASTLANE_CRYPTEX_KEY
+        fastlane_session_cookie_path = "#{File.expand_path('~')}/.fastlane/spaceship/#{username}/cookie"
+
+        UI.message "Generating a new fastlane session."
+        UI.message "Please enter the 6 digit 2FA code if one is sent to your device otherwise the script will continue automatically."
+        
+        sh("fastlane spaceauth -u #{username.shellescape}")
+
+        # store the session
+        other_action.cryptex(
+          type: "import",
+          in: fastlane_session_cookie_path,
+          key: key
+        )
+
+        # store the username that created the session in fastlane_vars
+        existing_fastlane_vars = other_action.cryptex(
+          type: 'export_env',
+          key: fastlane_key,
+        )
+
+        other_action.cryptex(
+          type: "import_env",
+          key: fastlane_key,
+          # PILOT_USERNAME needs to be set to the same username as the session above
+          hash: existing_fastlane_vars.merge({ 'PILOT_USERNAME' => username })
+        )
+
+        UI.success "Uploaded session for #{username} to #{key}."
+      end
+
+      def self.description
+        "Simplify 2FA authentication for App Store Connect"
+      end
+
+      def self.authors
+        ["cball", "isaiahgrey93"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        "Creates a cookie for authenticating with App Store connecting. Handles generating, encrypting, and storing the cookie."
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :username,
+                                       env_name: "FL_CREATE_FASTLANE_SESSION_USERNAME",
+                                       description: "Enter the Apple username to generate a App Store Connect session",
+                                       type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://docs.fastlane.tools/advanced/#control-configuration-by-lane-and-by-platform
+        #
+        [:ios, :android].include?(platform)
+      end
+
+    end
+  end
+end