fastlane 2.158.0 → 2.163.0

data/fastlane/lib/fastlane/actions/app_store_connect_api_key.rb

@@ -1,3 +1,5 @@
+require 'base64'
+
 module Fastlane
   module Actions
     module SharedValues
@@ -9,6 +11,7 @@ module Fastlane
         key_id = options[:key_id]
         issuer_id = options[:issuer_id]
         key_content = options[:key_content]
+        is_key_content_base64 = options[:is_key_content_base64]
         key_filepath = options[:key_filepath]
         duration = options[:duration]
         in_house = options[:in_house]
@@ -17,17 +20,22 @@ module Fastlane
           UI.user_error!(":key_content or :key_filepath is required")
         end
 
+        # New lines don't get read properly when coming from an ENV
+        # Replacing them literal version with a new line
+        key_content = key_content.gsub('\n', "\n") if key_content
+
         # This hash matches the named arguments on
         # the Spaceship::ConnectAPI::Token.create method
         key = {
           key_id: key_id,
           issuer_id: issuer_id,
           key: key_content || File.binread(key_filepath),
+          is_key_content_base64: is_key_content_base64,
           duration: duration,
           in_house: in_house
         }
 
-        Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY] = key
+        Actions.lane_context.set_sensitive(SharedValues::APP_STORE_CONNECT_API_KEY, key)
 
         return key
       end
@@ -55,8 +63,14 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :key_content,
                                        env_name: "APP_STORE_CONNECT_API_KEY_KEY",
                                        description: "The content of the key p8 file",
+                                       sensitive: true,
                                        optional: true,
                                        conflicting_options: [:filepath]),
+          FastlaneCore::ConfigItem.new(key: :is_key_content_base64,
+                                       env_name: "APP_STORE_CONNECT_API_KEY_IS_KEY_CONTENT_BASE64",
+                                       description: "Whether :key_content is Base64 encoded or not",
+                                       type: Boolean,
+                                       default_value: false),
           FastlaneCore::ConfigItem.new(key: :duration,
                                        env_name: "APP_STORE_CONNECT_API_KEY_DURATION",
                                        description: "The token session duration",

data/fastlane/lib/fastlane/actions/check_app_store_metadata.rb

@@ -7,6 +7,7 @@ module Fastlane
       def self.run(config)
         require 'precheck'
         Precheck.config = config
+        Precheck.config[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
         return Precheck::Runner.new.run
       end
 

data/fastlane/lib/fastlane/actions/clean_build_artifacts.rb

@@ -23,6 +23,7 @@ module Fastlane
 
         Actions.lane_context[Actions::SharedValues::SIGH_PROFILE_PATHS] = nil
         Actions.lane_context[Actions::SharedValues::DSYM_PATHS] = nil
+        Actions.lane_context[Actions::SharedValues::DSYM_LATEST_UPLOADED_DATE] = nil
 
         UI.success('Cleaned up build artifacts 🐙')
       end

data/fastlane/lib/fastlane/actions/docs/capture_android_screenshots.md

@@ -198,7 +198,7 @@ class JUnit4StyleTests {
 
 ```
 
-There is an [example project](https://github.com/fastlane/fastlane/tree/master/screengrab/example/src/androidTest/java/tools/fastlane/localetester) showing how to use use JUnit 3 or 4 and Espresso with the screengrab Java library to capture screenshots during a UI test run.
+There is an [example project](https://github.com/fastlane/fastlane/tree/master/screengrab/example/src/androidTest/java/tools/fastlane/localetester) showing how to use JUnit 3 or 4 and Espresso with the screengrab Java library to capture screenshots during a UI test run.
 
 Using JUnit 4 is preferable because of its ability to perform actions before and after the entire test class is run. This means you will change the device's locale far fewer times when compared with JUnit 3 running those commands before and after each test method.
 
@@ -251,7 +251,7 @@ new CleanStatusBar()
 <details>
 <summary>Launch Arguments</summary>
 
-You can provide additional arguments to your testcases on launch. These strings will be available in your tests through `InstrumentationRegistry.getArguments()`.
+You can provide additional arguments to your test cases on launch. These strings will be available in your tests through `InstrumentationRegistry.getArguments()`.
 
 ```ruby
 screengrab(

data/fastlane/lib/fastlane/actions/docs/capture_ios_screenshots.md

@@ -251,7 +251,7 @@ to update your `SnapshotHelper.swift` files. In case you modified your `Snapshot
 
 ## Launch Arguments
 
-You can provide additional arguments to your app on launch. These strings will be available in your app (eg. not in the testing target) through `ProcessInfo.processInfo.arguments`. Alternatively, use user-default syntax (`-key value`) and they will be available as key-value pairs in `UserDefaults.standard`.
+You can provide additional arguments to your app on launch. These strings will be available in your app (e.g. not in the testing target) through `ProcessInfo.processInfo.arguments`. Alternatively, use user-default syntax (`-key value`) and they will be available as key-value pairs in `UserDefaults.standard`.
 
 ```ruby-skip-tests
 launch_arguments([

data/fastlane/lib/fastlane/actions/docs/create_app_online.md

@@ -2,7 +2,7 @@
   <img src="/img/actions/produce.png" width="250">
 </p>
 
-###### Create new iOS apps on App Store Connect and Dev Portal using your command line
+###### Create new iOS apps on App Store Connect and Apple Developer Portal using your command line
 
 _produce_ creates new iOS apps on both the Apple Developer Portal and App Store Connect with the minimum required information.
 

data/fastlane/lib/fastlane/actions/docs/frame_screenshots.md

@@ -133,7 +133,7 @@ The general parameters are defined in the `default` key and can be:
 | `stack_title` | Specifies whether _frameit_ should display the keyword above the title when both keyword and title are defined. If it is false, the title and keyword will be displayed side by side when both keyword and title are defined. | `false` |
 | `title_below_image` | Specifies whether _frameit_ should place the title and optional keyword below the device frame. If it is false, it will be placed above the device frame. | `false` |
 | `show_complete_frame` | Specifies whether _frameit_ should shrink the device frame so that it is completely shown in the framed screenshot. If it is false, clipping of the device frame might occur at the bottom (when `title_below_image` is `false`) or top (when `title_below_image` is `true`) of the framed screenshot. | `false` |
-| `padding` | The content of the framed screenshot will be resized to match the specified `padding` around all edges. The vertical padding is also applied between the text and the top or bottom (depending on `title_below_image`) of the device frame. <p> There are 3 different options of specyfying the padding: <p> 1. Default: An integer value that defines both horizontal and vertical padding in pixels. <br> 2. A string that defines (different) padding values in pixels for horizontal and vertical padding. The syntax is `"<horizontal>x<vertical>"`, e.g. `"30x60"`. <br> 3. A string that defines (different) padding values in percentage for horizontal and vertical padding. The syntax is `"<horizontal>%x<vertical>%"`, e.g. `"5%x10%"`. <br> **Note:** The percentage is calculated from the smallest image dimension (height or width). <p> A combination of option 2 and 3 is possible, e.g. `"5%x40"`. | `50` |
+| `padding` | The content of the framed screenshot will be resized to match the specified `padding` around all edges. The vertical padding is also applied between the text and the top or bottom (depending on `title_below_image`) of the device frame. <p> There are 3 different options of specifying the padding: <p> 1. Default: An integer value that defines both horizontal and vertical padding in pixels. <br> 2. A string that defines (different) padding values in pixels for horizontal and vertical padding. The syntax is `"<horizontal>x<vertical>"`, e.g. `"30x60"`. <br> 3. A string that defines (different) padding values in percentage for horizontal and vertical padding. The syntax is `"<horizontal>%x<vertical>%"`, e.g. `"5%x10%"`. <br> **Note:** The percentage is calculated from the smallest image dimension (height or width). <p> A combination of option 2 and 3 is possible, e.g. `"5%x40"`. | `50` |
 | `interline_spacing` | Specifies whether _frameit_ should add or subtract this many pixels between the individual lines of text. This only applies to a multi-line `title` and/or `keyword` to expand or squash together the individual lines of text. | `0` |
 | `font_scale_factor` | Specifies whether _frameit_ should increase or decrease the font size of the text. Is ignored for `keyword` or `title`, if `font_size` is specified. | `0.1` |
 | `frame` | Overrides the color of the frame to be used. (Valid values are `BLACK`, `WHITE`, `GOLD` and `ROSE_GOLD`) | NA |
@@ -161,9 +161,10 @@ The `keyword` and `title` parameters are both used in `default` and `data`. They
 
 | Key | Description | Default value |
 |-----|-------------|---------------|
-| `color` | The font color for the text. Specify a hex/html color code. | `#000000` (black) |
+| `color` | The font color for the text. Specify a HEX/HTML color code. | `#000000` (black) |
 | `font` | The font family for the text. Specify the (relative) path to the font file (e.g. an OpenType Font). | The default `imagemagick` font, which is system dependent. |
 | `font_size` | The font size for the text specified in points. If not specified or `0`, font will be scaled automatically to fit the available space. _frameit_ still shrinks the text, if it would not fit. | NA |
+| `font_weight` | The [font weight for the text](https://imagemagick.org/script/command-line-options.php#weight). Specify an integer value (e.g. 900). | NA |
 | `text` | The text that should be used for the `keyword` or `title`. <p> Note: If you want to use localised text, use [`.strings` files](#strings-files). | NA |
 
 ### Example

data/fastlane/lib/fastlane/actions/docs/run_tests.md

@@ -81,7 +81,7 @@ _scan_ uses the latest APIs and tools to make running tests plain simple and off
 👱 | Automatically switches to the [travis formatter](https://github.com/kattrali/xcpretty-travis-formatter) when running on Travis
 📖 | Helps you resolve common test errors like simulator not responding
 
-_scan_ uses a plain `xcodebuild` command, therefore keeping 100% compatible with `xcodebuild`. To generate the nice output, _scan_ uses [xcpretty](https://github.com/supermarin/xcpretty). You can alway access the raw output in `~/Library/Logs/scan`.
+_scan_ uses a plain `xcodebuild` command, therefore keeping 100% compatible with `xcodebuild`. To generate the nice output, _scan_ uses [xcpretty](https://github.com/supermarin/xcpretty). You can always access the raw output in `~/Library/Logs/scan`.
 
 ![img/actions/scanScreenshot.png](/img/actions/scanScreenshot.png)
 ![img/actions/slack.png](/img/actions/slack.png)
@@ -100,7 +100,7 @@ That's all you need to run your tests. If you want more control, here are some a
 fastlane scan --workspace "Example.xcworkspace" --scheme "AppName" --device "iPhone 6" --clean
 ```
 
-If you need to use a different xcode install, use `xcode-select` or define `DEVELOPER_DIR`:
+If you need to use a different Xcode install, use `xcode-select` or define `DEVELOPER_DIR`:
 
 ```no-highlight
 DEVELOPER_DIR="/Applications/Xcode6.2.app" scan

data/fastlane/lib/fastlane/actions/docs/sync_code_signing.md

@@ -130,9 +130,9 @@ match
 
 You can find more information about GitHub basic authentication and personal token generation here: [https://developer.github.com/v3/auth/#basic-authentication](https://developer.github.com/v3/auth/#basic-authentication)
 
-##### Git Storage on Azure Devops
+##### Git Storage on Azure DevOps
 
-If you're running a pipeline on Azure Devops and using git storage in a another repository on the same project, you might want to use `bearer` token authentication.
+If you're running a pipeline on Azure DevOps and using git storage in a another repository on the same project, you might want to use `bearer` token authentication.
 
 Using parameter:
 
@@ -533,7 +533,7 @@ Storing your private keys in a Git repo may sound off-putting at first. We did a
 
 ### Google Cloud Storage
 
-All your keys and provisioning profiles are encrypted using Google managed keys. 
+All your keys and provisioning profiles are encrypted using Google managed keys.
 
 ### What could happen if someone stole a private key?
 

data/fastlane/lib/fastlane/actions/docs/upload_to_play_store.md

@@ -49,7 +49,7 @@ The previous p12 configuration is still currently supported.
 
 ## Quick Start
 
-> Before using _supply_ to connect to Google Play Store, you'll need to set up your app manually first by uploading at least one build to Google Play Store. See [fastane/fastlane#14686](https://github.com/fastlane/fastlane/issues/14686) for more info.
+> Before using _supply_ to connect to Google Play Store, you'll need to set up your app manually first by uploading at least one build to Google Play Store. See [fastlane/fastlane#14686](https://github.com/fastlane/fastlane/issues/14686) for more info.
 
 - `cd [your_project_folder]`
 - `fastlane supply init`
@@ -198,6 +198,6 @@ For more information, see the `fastlane action google_play_track_version_codes`
 - `:check_superseded_tracks`
   - Google Play will automatically remove releases that are superseded now
 - `:deactivate_on_promote`
-  - Google Play will automatically deactive a release from its previous track on promote
+  - Google Play will automatically deactivate a release from its previous track on promote
 
 :

data/fastlane/lib/fastlane/actions/docs/upload_to_testflight.md

@@ -32,7 +32,7 @@ For all commands, you can either use an [API Key](#app-store-connect-api-key) or
 
 The App Store Connect API Key is the preferred authentication method (if you are able to use it).
 
-- Uses offial App Store Connect API
+- Uses official App Store Connect API
 - No need for 2FA
 - Better performance over Apple ID
 
@@ -244,7 +244,7 @@ If you are on multiple App Store Connect teams, iTunes Transporter may need a pr
 
 ## Use an Application Specific Password to upload
 
-_pilot_/`upload_to_testflight` can use an [Application Specific Password via the `FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD` envirionment variable](https://docs.fastlane.tools/best-practices/continuous-integration/#application-specific-passwords) to upload a binary if both the `skip_waiting_for_build_processing` and `apple_id` options are set. (If any of those are not set, it will use the normal Apple login process that might require 2FA authentication.)
+_pilot_/`upload_to_testflight` can use an [Application Specific Password via the `FASTLANE_APPLE_APPLICATION_SPECIFIC_PASSWORD` environment variable](https://docs.fastlane.tools/best-practices/continuous-integration/#application-specific-passwords) to upload a binary if both the `skip_waiting_for_build_processing` and `apple_id` options are set. (If any of those are not set, it will use the normal Apple login process that might require 2FA authentication.)
 
 ## Role for App Store Connect User
 _pilot_/`upload_to_testflight` updates build information and testers after the build has finished processing. App Store Connect requires the  "App Manager" or "Admin" role for your Apple account to update this information. The "Developer" role will allow builds to be uploaded but _will not_ allow updating of build information and testers.

data/fastlane/lib/fastlane/actions/download_dsyms.rb

@@ -2,6 +2,7 @@ module Fastlane
   module Actions
     module SharedValues
       DSYM_PATHS = :DSYM_PATHS
+      DSYM_LATEST_UPLOADED_DATE = :DSYM_LATEST_UPLOADED_DATE
     end
     class DownloadDsymsAction < Action
       # rubocop:disable Metrics/PerceivedComplexity
@@ -9,6 +10,7 @@ module Fastlane
         require 'openssl'
         require 'spaceship'
         require 'net/http'
+        require 'date'
 
         # Team selection passed though FASTLANE_ITC_TEAM_ID and FASTLANE_ITC_TEAM_NAME environment variables
         # Prompts select team if multiple teams and none specified
@@ -30,6 +32,7 @@ module Fastlane
         wait_for_dsym_processing = params[:wait_for_dsym_processing]
         wait_timeout = params[:wait_timeout]
         min_version = Gem::Version.new(params[:min_version]) if params[:min_version]
+        after_uploaded_date = DateTime.parse(params[:after_uploaded_date]) unless params[:after_uploaded_date].nil?
 
         platform = Spaceship::ConnectAPI::Platform.map(itc_platform)
 
@@ -81,6 +84,7 @@ module Fastlane
         builds.each do |build|
           asc_app_version = build.app_version
           asc_build_number = build.version
+          uploaded_date = DateTime.parse(build.uploaded_date)
 
           message = []
           message << "Found train (version): #{asc_app_version}"
@@ -97,6 +101,11 @@ module Fastlane
             next
           end
 
+          if after_uploaded_date && after_uploaded_date >= uploaded_date
+            UI.verbose("Upload date #{after_uploaded_date} not reached: #{uploaded_date}")
+            next
+          end
+
           message = []
           message << "Found build version: #{asc_build_number}"
           message << ", comparing to supplied build_number: #{build_number}" if build_number
@@ -108,11 +117,11 @@ module Fastlane
           end
 
           UI.verbose("Build_version: #{asc_build_number} matches #{build_number}, grabbing dsym_url") if build_number
-          get_details_and_download_dsym(app: app, train: asc_app_version, build_number: asc_build_number, platform: itc_platform, wait_for_dsym_processing: wait_for_dsym_processing, wait_timeout: wait_timeout, output_directory: output_directory)
+          get_details_and_download_dsym(app: app, train: asc_app_version, build_number: asc_build_number, uploaded_date: uploaded_date, platform: itc_platform, wait_for_dsym_processing: wait_for_dsym_processing, wait_timeout: wait_timeout, output_directory: output_directory)
         end
       end
 
-      def self.get_details_and_download_dsym(app: nil, train: nil, build_number: nil, platform: nil, wait_for_dsym_processing: nil, wait_timeout: nil, output_directory: nil)
+      def self.get_details_and_download_dsym(app: nil, train: nil, build_number: nil, uploaded_date: nil, platform: nil, wait_for_dsym_processing: nil, wait_timeout: nil, output_directory: nil)
         start = Time.now
         download_url = nil
 
@@ -144,7 +153,7 @@ module Fastlane
         end
 
         if download_url
-          self.download(download_url, app.bundle_id, train, build_number, output_directory)
+          self.download(download_url, app.bundle_id, train, build_number, uploaded_date, output_directory)
           return if build_number
         else
           UI.message("No dSYM URL for #{build_number} (#{train})")
@@ -159,19 +168,26 @@ module Fastlane
         latest_build = Spaceship::ConnectAPI.get_builds(filter: filter, sort: "-uploadedDate", includes: "preReleaseVersion").first
 
         if latest_build.nil?
-          UI.user_error!("Could not find latest bulid for version #{version}")
+          UI.user_error!("Could not find latest build for version #{version}")
         end
 
         return latest_build
       end
 
-      def self.download(download_url, bundle_id, train_number, build_version, output_directory)
+      def self.download(download_url, bundle_id, train_number, build_version, uploaded_date, output_directory)
         result = self.download_file(download_url)
         path   = write_dsym(result, bundle_id, train_number, build_version, output_directory)
         UI.success("🔑  Successfully downloaded dSYM file for #{train_number} - #{build_version} to '#{path}'")
 
         Actions.lane_context[SharedValues::DSYM_PATHS] ||= []
         Actions.lane_context[SharedValues::DSYM_PATHS] << File.expand_path(path)
+
+        unless uploaded_date.nil?
+          Actions.lane_context[SharedValues::DSYM_LATEST_UPLOADED_DATE] ||= uploaded_date
+          current_latest = Actions.lane_context[SharedValues::DSYM_LATEST_UPLOADED_DATE]
+          Actions.lane_context[SharedValues::DSYM_LATEST_UPLOADED_DATE] = [current_latest, uploaded_date].max
+          UI.verbose("Most recent build uploaded_date #{Actions.lane_context[SharedValues::DSYM_LATEST_UPLOADED_DATE]}")
+        end
       end
 
       def self.write_dsym(data, bundle_id, train_number, build_number, output_directory)
@@ -192,6 +208,7 @@ module Fastlane
         else
           http = Net::HTTP.new(uri.host, uri.port)
         end
+        http.read_timeout = 300
         http.use_ssl = (uri.scheme == "https")
         res = http.get(uri.request_uri)
         res.body
@@ -286,6 +303,12 @@ module Fastlane
                                        env_name: "DOWNLOAD_DSYMS_MIN_VERSION",
                                        description: "The minimum app version for dSYMs you wish to download",
                                        optional: true),
+          FastlaneCore::ConfigItem.new(key: :after_uploaded_date,
+                                       short_option: "-d",
+                                       env_name: "DOWNLOAD_DSYMS_AFTER_UPLOADED_DATE",
+                                       description: "The uploaded date after which you wish to download dSYMs",
+                                       optional: true,
+                                       is_string: true),
           FastlaneCore::ConfigItem.new(key: :output_directory,
                                        short_option: "-s",
                                        env_name: "DOWNLOAD_DSYMS_OUTPUT_DIRECTORY",
@@ -310,7 +333,8 @@ module Fastlane
 
       def self.output
         [
-          ['DSYM_PATHS', 'An array to all the zipped dSYM files']
+          ['DSYM_PATHS', 'An array to all the zipped dSYM files'],
+          ['DSYM_LATEST_UPLOADED_DATE', 'Date of the most recent uploaded time of successfully downloaded dSYM files']
         ]
       end
 
@@ -332,7 +356,8 @@ module Fastlane
           'download_dsyms(version: "1.0.0", build_number: "345")',
           'download_dsyms(version: "1.0.1", build_number: 42)',
           'download_dsyms(version: "live")',
-          'download_dsyms(min_version: "1.2.3")'
+          'download_dsyms(min_version: "1.2.3")',
+          'download_dsyms(after_uploaded_date: "2020-09-11T19:00:00+01:00")'
         ]
       end
 

data/fastlane/lib/fastlane/actions/ensure_git_status_clean.rb

@@ -7,7 +7,13 @@ module Fastlane
     # Raises an exception and stop the lane execution if the repo is not in a clean state
     class EnsureGitStatusCleanAction < Action
       def self.run(params)
-        repo_status = Actions.sh("git status --porcelain")
+        if params[:ignored]
+          ignored_file = params[:ignored]
+          repo_status = Actions.sh("git status --porcelain --ignored #{ignored_file}")
+        else
+          repo_status = Actions.sh("git status --porcelain")
+        end
+
         repo_clean = repo_status.empty?
 
         if repo_clean
@@ -65,7 +71,12 @@ module Fastlane
                                        description: "The flag whether to show the git diff if the repo is dirty",
                                        optional: true,
                                        default_value: false,
-                                       is_string: false)
+                                       is_string: false),
+          FastlaneCore::ConfigItem.new(key: :ignored,
+                                       env_name: "FL_ENSURE_GIT_STATUS_CLEAN_IGNORED_FILE",
+                                       description: "The flag whether to ignore file the git status if the repo is dirty",
+                                       optional: true,
+                                       is_string: true)
         ]
       end
 

data/fastlane/lib/fastlane/actions/get_certificates.rb

@@ -13,6 +13,7 @@ module Fastlane
 
         begin
           Cert.config = params # we alread have the finished config
+          Cert.config[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
 
           Cert::Runner.new.launch
           cert_file_path = ENV["CER_FILE_PATH"]

data/fastlane/lib/fastlane/actions/get_provisioning_profile.rb

@@ -15,6 +15,7 @@ module Fastlane
         require 'credentials_manager/appfile_config'
 
         Sigh.config = values # we already have the finished config
+        Sigh.config[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
 
         path = Sigh::Manager.start
 

data/fastlane/lib/fastlane/actions/latest_testflight_build_number.rb

@@ -37,6 +37,21 @@ module Fastlane
         user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
 
         [
+          FastlaneCore::ConfigItem.new(key: :api_key_path,
+                                       env_name: "APPSTORE_BUILD_NUMBER_API_KEY_PATH",
+                                       description: "Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file)",
+                                       optional: true,
+                                       conflicting_options: [:api_key],
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find API key JSON file at path '#{value}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       env_name: "APPSTORE_BUILD_NUMBER_API_KEY",
+                                       description: "Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option)",
+                                       type: Hash,
+                                       optional: true,
+                                       sensitive: true,
+                                       conflicting_options: [:api_key_path]),
           FastlaneCore::ConfigItem.new(key: :live,
                                        short_option: "-l",
                                        env_name: "CURRENT_BUILD_NUMBER_LIVE",

data/fastlane/lib/fastlane/actions/register_device.rb

@@ -11,23 +11,39 @@ module Fastlane
         require 'spaceship'
 
         name = params[:name]
+        platform = params[:platform]
         udid = params[:udid]
 
-        credentials = CredentialsManager::AccountManager.new(user: params[:username])
-        Spaceship.login(credentials.user, credentials.password)
-        Spaceship.select_team
+        platform = Spaceship::ConnectAPI::BundleIdPlatform.map(platform)
+
+        if (token = api_token(params))
+          UI.message("Using App Store Connect API token...")
+          Spaceship::ConnectAPI.token = token
+        else
+          UI.message("Login to App Store Connect (#{params[:username]})")
+          credentials = CredentialsManager::AccountManager.new(user: params[:username])
+          Spaceship::ConnectAPI.login(credentials.user, credentials.password, use_portal: true, use_tunes: false)
+          UI.message("Login successful")
+        end
 
         begin
-          Spaceship::Device.create!(name: name, udid: udid)
+          Spaceship::ConnectAPI::Device.create(name: name, platform: platform, udid: udid)
         rescue => ex
           UI.error(ex.to_s)
-          UI.crash!("Failed to register new device (name: #{name}, UDID: #{udid})")
+          UI.crash!("Failed to register new device (name: #{name}, platform: #{platform}, UDID: #{udid})")
         end
 
         UI.success("Successfully registered new device")
         return udid
       end
 
+      def self.api_token(params)
+        params[:api_key] ||= Actions.lane_context[SharedValues::APP_STORE_CONNECT_API_KEY]
+        api_token ||= Spaceship::ConnectAPI::Token.create(params[:api_key]) if params[:api_key]
+        api_token ||= Spaceship::ConnectAPI::Token.from_json_file(params[:api_key_path]) if params[:api_key_path]
+        return api_token
+      end
+
       def self.description
         "Registers a new device to the Apple Dev Portal"
       end
@@ -35,14 +51,38 @@ module Fastlane
       def self.available_options
         user = CredentialsManager::AppfileConfig.try_fetch_value(:apple_dev_portal_id)
         user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id)
+        platform = Actions.lane_context[Actions::SharedValues::PLATFORM_NAME].to_s
 
         [
           FastlaneCore::ConfigItem.new(key: :name,
                                        env_name: "FL_REGISTER_DEVICE_NAME",
                                        description: "Provide the name of the device to register as"),
+          FastlaneCore::ConfigItem.new(key: :platform,
+                                       env_name: "FL_REGISTER_DEVICE_PLATFORM",
+                                       description: "Provide the platform of the device to register as (ios, mac)",
+                                       optional: true,
+                                       default_value: platform.empty? ? "ios" : platform,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("The platform can only be ios or mac") unless %('ios', 'mac').include?(value)
+                                       end),
           FastlaneCore::ConfigItem.new(key: :udid,
                                        env_name: "FL_REGISTER_DEVICE_UDID",
                                        description: "Provide the UDID of the device to register as"),
+          FastlaneCore::ConfigItem.new(key: :api_key_path,
+                                       env_name: "FL_REGISTER_DEVICE_API_KEY_PATH",
+                                       description: "Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file)",
+                                       optional: true,
+                                       conflicting_options: [:api_key],
+                                       verify_block: proc do |value|
+                                         UI.user_error!("Couldn't find API key JSON file at path '#{value}'") unless File.exist?(value)
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :api_key,
+                                       env_name: "FL_REGISTER_DEVICE_API_KEY",
+                                       description: "Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#use-return-value-and-pass-in-as-an-option)",
+                                       type: Hash,
+                                       optional: true,
+                                       sensitive: true,
+                                       conflicting_options: [:api_key_path]),
           FastlaneCore::ConfigItem.new(key: :team_id,
                                      env_name: "REGISTER_DEVICE_TEAM_ID",
                                      code_gen_sensitive: true,
@@ -66,6 +106,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :username,
                                        env_name: "DELIVER_USER",
                                        description: "Optional: Your Apple ID",
+                                       optional: true,
                                        default_value: user,
                                        default_value_dynamic: true)
         ]