fastlane 1.104.0 → 1.105.0

data/lib/fastlane/actions/splunkmint.rb

@@ -134,6 +134,20 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'splunkmint(
+            dsym: "My.app.dSYM.zip",
+            api_key: "43564d3a",
+            api_token: "e05456234c4869fb7e0b61"
+          )'
+        ]
+      end
+
+      def self.category
+        :beta
+      end
     end
   end
 end

data/lib/fastlane/actions/ssh.rb

@@ -80,7 +80,7 @@ module Fastlane
       end
 
       def self.details
-        "Lets you execute remote commands via ssh using username/password or ssh-agent"
+        "Lets you execute remote commands via ssh using username/password or ssh-agent. If one of the commands in command-array returns non 0 - it fails."
       end
 
       def self.available_options
@@ -139,6 +139,23 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'ssh(
+            host: "dev.januschka.com",
+            username: "root",
+            commands: [
+              "date",
+              "echo 1 > /tmp/file1"
+            ]
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/supply.rb

@@ -45,17 +45,25 @@ module Fastlane
       end
 
       def self.return_value
-        # If you method provides a return value, you can describe here what it does
       end
 
       def self.authors
-        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
         ["KrauseFx"]
       end
 
       def self.is_supported?(platform)
         platform == :android
       end
+
+      def self.example_code
+        [
+          'supply'
+        ]
+      end
+
+      def self.category
+        :production
+      end
     end
   end
 end

data/lib/fastlane/actions/swiftlint.rb

@@ -90,6 +90,25 @@ module Fastlane
         [:ios, :mac].include?(platform)
       end
 
+      def self.example_code
+        [
+          'swiftlint(
+            mode: :lint,                          # SwiftLint mode: :lint (default) or :autocorrect
+            output_file: "swiftlint.result.json", # The path of the output file (optional)
+            config_file: ".swiftlint-ci.yml",     # The path of the configuration file (optional)
+            files: [                              # List of files to process (optional)
+              "AppDelegate.swift",
+              "path/to/project/Model.swift"
+            ],
+            ignore_exit_status: true              # Allow fastlane to continue even if SwiftLint returns a non-zero exit status
+          )'
+        ]
+      end
+
+      def self.category
+        :testing
+      end
+
       def self.handle_swiftlint_error(ignore_exit_status, exit_status)
         if ignore_exit_status
           failure_suffix = 'which would normally fail the build.'

data/lib/fastlane/actions/team_id.rb

@@ -27,6 +27,16 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'team_id "Q2CBPK58CA"'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/team_name.rb

@@ -27,6 +27,16 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'team_name "Felix Krause"'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/testfairy.rb

@@ -102,6 +102,10 @@ module Fastlane
         'Upload a new build to TestFairy'
       end
 
+      def self.details
+        "You can retrieve your API key on [your settings page](https://free.testfairy.com/settings/)"
+      end
+
       def self.available_options
         [
           # required
@@ -113,7 +117,7 @@ module Fastlane
                                        end),
           FastlaneCore::ConfigItem.new(key: :ipa,
                                        env_name: 'TESTFAIRY_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)
@@ -174,6 +178,20 @@ module Fastlane
         ]
       end
 
+      def self.example_code
+        [
+          'testfairy(
+            api_key: "...",
+            ipa: "./ipa_file.ipa",
+            comment: "Build #{lane_context[SharedValues::BUILD_NUMBER]}",
+          )'
+        ]
+      end
+
+      def self.category
+        :beta
+      end
+
       def self.output
         [
           ['TESTFAIRY_BUILD_URL', 'URL of the newly uploaded build']

data/lib/fastlane/actions/testflight.rb

@@ -27,6 +27,14 @@ module Fastlane
         'KrauseFx'
       end
 
+      def self.example_code
+        Actions::PilotAction.example_code
+      end
+
+      def self.category
+        Actions::PilotAction.category
+      end
+
       def self.is_supported?(platform)
         Actions::PilotAction.is_supported?(platform)
       end

data/lib/fastlane/actions/tryouts.rb

@@ -61,6 +61,10 @@ module Fastlane
         "Upload a new build to Tryouts"
       end
 
+      def self.details
+        "More information http://tryouts.readthedocs.org/en/latest/releases.html#create-release"
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :app_id,
@@ -77,7 +81,7 @@ module Fastlane
                                      end),
           FastlaneCore::ConfigItem.new(key: :build_file,
                                      env_name: "TRYOUTS_BUILD_FILE",
-                                     description: "Path to your IPA or APK file. Optional if you use the `gym` or `xcodebuild` action",
+                                     description: "Path to your IPA or APK 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 build file at path '#{value}'") unless File.exist?(value)
@@ -111,6 +115,20 @@ module Fastlane
         ]
       end
 
+      def self.example_code
+        [
+          'tryouts(
+            api_token: "...",
+            app_id: "application-id",
+            build_file: "test.ipa",
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.output
         [
           ['TRYOUTS_BUILD_INFORMATION', 'Contains release info like :application_name, :download_url. See http://tryouts.readthedocs.org/en/latest/releases.html#create-release']

data/lib/fastlane/actions/twitter.rb

@@ -19,10 +19,11 @@ module Fastlane
       #####################################################
 
       def self.description
-        "Post on twitter"
+        "Post a tweet on Twitter.com"
       end
 
       def self.details
+        "Post a tweet on twitter. Requires you to setup an app on twitter.com and obtain consumer and access_token."
       end
 
       def self.available_options
@@ -63,6 +64,22 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'twitter(
+            access_token: "XXXX",
+            access_token_secret: "xxx",
+            consumer_key: "xxx",
+            consumer_secret: "xxx",
+            message: "You rock!"
+          )'
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
     end
   end
 end

data/lib/fastlane/actions/typetalk.rb

@@ -72,6 +72,22 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'typetalk(
+            message: "App successfully released!",
+            note_path: "ChangeLog.md",
+            topicId: 1,
+            success: true,
+            typetalk_token: "Your Typetalk Token"
+          )'
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
     end
   end
 end

data/lib/fastlane/actions/unlock_keychain.rb

@@ -110,6 +110,33 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'unlock_keychain( # Unlock an existing keychain and add it to the keychain search list
+            path: "/path/to/KeychainName.keychain",
+            password: "mysecret"
+          )',
+          'unlock_keychain( # By default the keychain is added to the existing. To replace them with the selected keychain you may use `:replace`
+            path: "/path/to/KeychainName.keychain",
+            password: "mysecret",
+            add_to_search_list: :replace # To only add a keychain use `true` or `:add`.
+          )',
+          'unlock_keychain( # In addition, the keychain can be selected as a default keychain
+            path: "/path/to/KeychainName.keychain",
+            password: "mysecret",
+            set_default: true
+          )',
+          'unlock_keychain( # If the keychain file is located in the standard location `~/Library/Keychains`, then it is sufficient to provide the keychain file name, or file name with its suffix.
+            path: "KeychainName",
+            password: "mysecret"
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/update_app_group_identifiers.rb

@@ -37,6 +37,10 @@ module Fastlane
         "This action changes the app group identifiers in the entitlements file"
       end
 
+      def self.details
+        "Updates the App Group Identifiers in the given Entitlements file, so you can have app groups for the app store build and app groups for an enterprise build."
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :entitlements_file,
@@ -67,6 +71,19 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'update_app_group_identifiers(
+            entitlements_file: "/path/to/entitlements_file.entitlements",
+            app_group_identifiers: ["group.your.app.group.identifier"]
+          )'
+        ]
+      end
+
+      def self.category
+        :project
+      end
     end
   end
 end

data/lib/fastlane/actions/update_app_identifier.rb

@@ -59,6 +59,10 @@ module Fastlane
         "Update the project's bundle identifier"
       end
 
+      def self.details
+        "Update an app identifier by either setting `CFBundleIdentifier` or `PRODUCT_BUNDLE_IDENTIFIER`, depending on which is already in use."
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :xcodeproj,
@@ -85,6 +89,20 @@ module Fastlane
       def self.authors
         ['squarefrog', 'tobiasstrebitzer']
       end
+
+      def self.example_code
+        [
+          'update_app_identifier(
+            xcodeproj: "Example.xcodeproj", # Optional path to xcodeproj, will use the first .xcodeproj if not set
+            plist_path: "Example/Info.plist", # Path to info plist file, relative to xcodeproj
+            app_identifier: "com.test.example" # The App Identifier
+          )'
+        ]
+      end
+
+      def self.category
+        :project
+      end
     end
   end
 end

data/lib/fastlane/actions/update_fastlane.rb

@@ -111,6 +111,20 @@ module Fastlane
         "Makes sure fastlane-tools are up-to-date when running fastlane"
       end
 
+      def self.details
+        [
+          "This action will look at all installed fastlane tools and update them to the next available minor version - major version updates will not be performed automatically, as they might include breaking changes. If an update was performed, fastlane will be restarted before the run continues.",
+          "If you are using rbenv or rvm, everything should be good to go. However, if you are using the system's default ruby, some additional setup is needed for this action to work correctly. In short, fastlane needs to be able to access your gem library without running in `sudo` mode.",
+          "The simplest possible fix for this is putting the following lines into your `~/.bashrc` or `~/.zshrc` file:",
+          "```bash",
+          "export GEM_HOME=~/.gems",
+          "export PATH=$PATH:~/.gems/bin",
+          "```",
+          "After the above changes, restart your terminal, then run `mkdir $GEM_HOME` to create the new gem directory. After this, you're good to go!",
+          "Recommended usage of the `update_fastlane` action is at the top of the `before_all` block, before running any other action"
+        ].join("\n\n")
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :tools,
@@ -132,6 +146,19 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'before_all do
+            update_fastlane
+            # ...
+          end'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/update_icloud_container_identifiers.rb

@@ -45,6 +45,10 @@ module Fastlane
         "This action changes the iCloud container identifiers in the entitlements file"
       end
 
+      def self.details
+        "Updates the iCloud Container Identifiers in the given Entitlements file, so you can use different iCloud containers for different builds like Adhoc, App Store, etc."
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :entitlements_file,
@@ -75,6 +79,19 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'update_icloud_container_identifiers(
+            entitlements_file: "/path/to/entitlements_file.entitlements",
+            icloud_container_identifiers: ["iCloud.com.companyname.appname"]
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end