fastlane 1.104.0 → 1.105.0

data/lib/fastlane/actions/copy_artifacts.rb

@@ -46,6 +46,13 @@ module Fastlane
         "Small action to save your build artifacts. Useful when you use reset_git_repo"
       end
 
+      def self.details
+        [
+          "This action copies artifacs to a target directory. It's useful if you have a CI that will pick up these artifacts and attach them to the build. Useful e.g. for storing your `.ipa`s, `.dSYM.zip`s, `.mobileprovision`s, `.cert`s",
+          "Make sure your target_path is gitignored, and if you use `reset_git_repo`, make sure the artifacts are added to the exclude list"
+        ].join("\n")
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :keep_original,
@@ -78,6 +85,24 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'copy_artifacts(
+            target_path: "artifacts",
+            artifacts: ["*.cer", "*.mobileprovision", "*.ipa", "*.dSYM.zip"]
+          )
+
+          # Reset the git repo to a clean state, but leave our artifacts in place
+          reset_git_repo(
+            exclude: "artifacts"
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/crashlytics.rb

@@ -76,7 +76,7 @@ module Fastlane
           # iOS Specific
           FastlaneCore::ConfigItem.new(key: :ipa_path,
                                        env_name: "CRASHLYTICS_IPA_PATH",
-                                       description: "Path to your IPA file. Optional if you use the `gym` or `xcodebuild` action",
+                                       description: "Path to your IPA file. Optional if you use the _gym_ or _xcodebuild_ action",
                                        default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH] || ipa_path_default,
                                        optional: true,
                                        verify_block: proc do |value|
@@ -154,6 +154,29 @@ module Fastlane
       def self.author
         ["KrauseFx", "pedrogimenez"]
       end
+
+      def self.details
+        [
+          "Additionally you can specify `notes`, `emails`, `groups` and `notifications`.",
+          "Distributing to Groups: When using the `groups` parameter, it's important to use the group **alias** names for each group you'd like to distribute to. A group's alias can be found in the web UI. If you're viewing the Beta page, you can open the groups dialog here:"
+        ].join("\n")
+      end
+
+      def self.example_code
+        [
+          'crashlytics',
+          'crashlytics(
+            crashlytics_path: "./Pods/Crashlytics/", # path to your Crashlytics submit binary.
+            api_token: "...",
+            build_secret: "...",
+            ipa_path: "./app.ipa"
+          )'
+        ]
+      end
+
+      def self.category
+        :beta
+      end
     end
   end
 end

data/lib/fastlane/actions/create_keychain.rb

@@ -86,6 +86,22 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'create_keychain(
+            name: "KeychainName",
+            default_keychain: true,
+            unlock: true,
+            timeout: 3600,
+            lock_when_sleeps: true
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/create_pull_request.rb

@@ -95,6 +95,24 @@ module Fastlane
       def self.is_supported?(platform)
         return true
       end
+
+      def self.example_code
+        [
+          'create_pull_request(
+            api_token: ENV["GITHUB_TOKEN"],
+            repo: "fastlane/fastlane",
+            title: "Amazing new feature",
+            head: "my-feature",                 # optional, defaults to current branch name
+            base: "master",                     # optional, defaults to "master"
+            body: "Please pull this in!",       # optional
+            api_url: "http://yourdomain/api/v3" # optional, for Github Enterprise, defaults to "https://api.github.com"
+          )'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/danger.rb

@@ -24,7 +24,10 @@ module Fastlane
       end
 
       def self.details
-        "More information: https://github.com/danger/danger"
+        [
+          "Formalize your Pull Request etiquette.",
+          "More information: https://github.com/danger/danger"
+        ].join("\n")
       end
 
       def self.available_options
@@ -61,6 +64,22 @@ module Fastlane
         true
       end
 
+      def self.example_code
+        [
+          'danger',
+          'danger(
+            danger_id: "unit-tests",
+            dangerfile: "tests/MyOtherDangerFile",
+            github_api_token: ENV["GITHUB_API_TOKEN"],
+            verbose: true
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.authors
         ["KrauseFx"]
       end

data/lib/fastlane/actions/debug.rb

@@ -14,6 +14,16 @@ module Fastlane
         true
       end
 
+      def self.example_code
+        [
+          'debug'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.author
         "KrauseFx"
       end

data/lib/fastlane/actions/default_platform.rb

@@ -19,6 +19,16 @@ module Fastlane
         "Defines a default platform to not have to specify the platform"
       end
 
+      def self.example_code
+        [
+          'default_platform :android'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.author
         "KrauseFx"
       end

data/lib/fastlane/actions/delete_keychain.rb

@@ -9,6 +9,10 @@ module Fastlane
         Fastlane::Actions.sh "security delete-keychain #{params[:name].shellescape}", log: false
       end
 
+      def self.details
+        "Keychains can be deleted after being creating with `create_keychain`"
+      end
+
       def self.description
         "Delete keychains and remove them from the search list"
       end
@@ -22,6 +26,16 @@ module Fastlane
         ]
       end
 
+      def self.example_code
+        [
+          'delete_keychain(name: "KeychainName")'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.authors
         ["gin0606"]
       end

data/lib/fastlane/actions/deliver.rb

@@ -25,6 +25,18 @@ module Fastlane
         "Uses deliver to upload new app metadata and builds to iTunes Connect"
       end
 
+      def self.details
+        [
+          "Using _deliver_ after _gym_ and _snapshot_ will automatically upload the",
+          "latest ipa and screenshots with no other configuration",
+          "",
+          "If you don't want a PDF report for App Store builds, use the `:force` option.",
+          "This is useful when running _fastlane_ on your Continuous Integration server: `deliver(force: true)`",
+          "If your account is on multiple teams and you need to tell the `iTMSTransporter`",
+          "which 'provider' to use, you can set the `itc_provider` option to pass this info."
+        ].join("\n")
+      end
+
       def self.available_options
         require "deliver"
         require "deliver/options"
@@ -38,6 +50,20 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include?(platform)
       end
+
+      def self.example_code
+        [
+          'deliver(
+            force: true, # Set to true to skip PDF verification
+            itc_provider: "abcde12345" # pass a specific value to the iTMSTransporter -itc_provider option
+
+          )'
+        ]
+      end
+
+      def self.category
+        :production
+      end
     end
   end
 end

data/lib/fastlane/actions/deploygate.rb

@@ -84,7 +84,14 @@ module Fastlane
       private_class_method :help_message
 
       def self.description
-        "Upload a new build to DeployGate"
+        "Upload a new build to [DeployGate](https://deploygate.com/)"
+      end
+
+      def self.details
+        [
+          "You can retrieve your username and API token on [your settings page](https://deploygate.com/settings)",
+          "More information about the available options can be found in the [DeployGate Push API document](https://deploygate.com/docs/api)."
+        ].join("\n")
       end
 
       def self.available_options
@@ -103,7 +110,7 @@ module Fastlane
                                        end),
           FastlaneCore::ConfigItem.new(key: :ipa,
                                        env_name: "DEPLOYGATE_IPA_PATH",
-                                       description: "Path to your IPA file. Optional if you use the `gym` or `xcodebuild` action",
+                                       description: "Path to your IPA file. Optional if you use the _gym_ or _xcodebuild_ action",
                                        default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH],
                                        verify_block: proc do |value|
                                          UI.user_error!("Couldn't find ipa file at path '#{value}'") unless File.exist?(value)
@@ -131,6 +138,22 @@ module Fastlane
         ]
       end
 
+      def self.example_code
+        [
+          'deploygate(
+            api_token: "...",
+            user: "target username or organization name",
+            ipa: "./ipa_file.ipa",
+            message: "Build #{lane_context[SharedValues::BUILD_NUMBER]}",
+            distribution_key: "(Optional) Target Distribution Key"
+          )'
+        ]
+      end
+
+      def self.category
+        :beta
+      end
+
       def self.author
         "tnj"
       end

data/lib/fastlane/actions/dotgpg_environment.rb

@@ -37,6 +37,16 @@ module Fastlane
         ["simonlevy5"]
       end
 
+      def self.example_code
+        [
+          "dotgpg_environment(dotgpg_file: './path/to/gpgfile')"
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.is_supported?(platform)
         true
       end

data/lib/fastlane/actions/download.rb

@@ -54,6 +54,16 @@ module Fastlane
         ]
       end
 
+      def self.example_code
+        [
+          'data = download(url: "https://host.com/api.json")'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.authors
         ["KrauseFx"]
       end

data/lib/fastlane/actions/download_dsyms.rb

@@ -87,8 +87,15 @@ module Fastlane
       def self.details
         [
           "This action downloads dSYM files from Apple iTunes Connect after",
-          "the ipa got re-compiled by Apple. Useful if you have Bitcode enabled"
-        ].join(" ")
+          "the ipa got re-compiled by Apple. Useful if you have Bitcode enabled",
+          "```ruby",
+          "lane :refresh_dsyms do",
+          "  download_dsyms                  # Download dSYM files from iTC",
+          "  upload_symbols_to_crashlytics   # Upload them to Crashlytics",
+          "  clean_build_artifacts           # Delete the local dSYM files",
+          "end",
+          "```"
+        ].join("\n")
       end
 
       def self.available_options
@@ -161,6 +168,17 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'download_dsyms',
+          'download_dsyms(version: "1.0.0", build_number: "345")'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/dsym_zip.rb

@@ -38,6 +38,10 @@ module Fastlane
         'Creates a zipped dSYM in the project root from the .xcarchive'
       end
 
+      def self.details
+        "You can manually specify the path to the xcarchive (not needed if you use `xcodebuild`/`xcarchive` to build your archive)"
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :archive_path,
@@ -70,6 +74,19 @@ module Fastlane
       def self.author
         'lmirosevic'
       end
+
+      def self.example_code
+        [
+          'dsym_zip',
+          'dsym_zip(
+            archive_path: "MyApp.xcarchive"
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/ensure_git_branch.rb

@@ -23,6 +23,14 @@ module Fastlane
         "Raises an exception if not on a specific git branch"
       end
 
+      def self.details
+        [
+          'This action will check if your git repo is checked out to a specific branch.',
+          'You may only want to make releases from a specific branch, so `ensure_git_branch`',
+          'will stop a lane if it was accidentally executed on an incorrect branch.'
+        ].join("\n")
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :branch,
@@ -41,6 +49,19 @@ module Fastlane
         ['dbachrach', 'Liquidsoul']
       end
 
+      def self.example_code
+        [
+          "ensure_git_branch # defaults to `master` branch",
+          "ensure_git_branch(
+            branch: 'develop'
+          )"
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+
       def self.is_supported?(platform)
         true
       end