fastlane 1.104.0 → 1.105.0

data/lib/fastlane/actions/set_build_number_repository.rb

@@ -24,6 +24,14 @@ module Fastlane
         "Set the build number from the current repository"
       end
 
+      def self.details
+        [
+          "This action will set the **build number** according to what the SCM HEAD reports.",
+          "Currently supported SCMs are svn (uses root revision), git-svn (uses svn revision) and git (uses short hash) and mercurial (uses short hash or revision number).",
+          "There is an option, `:use_hg_revision_number`, which allows to use mercurial revision number instead of hash"
+        ].join("\n")
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :use_hg_revision_number,
@@ -35,13 +43,18 @@ module Fastlane
         ]
       end
 
-      def self.output
+      def self.authors
+        ["pbrooks", "armadsen"]
+      end
+
+      def self.example_code
         [
+          'set_build_number_repository'
         ]
       end
 
-      def self.authors
-        ["pbrooks", "armadsen"]
+      def self.category
+        :project
       end
     end
   end

data/lib/fastlane/actions/set_changelog.rb

@@ -70,7 +70,10 @@ module Fastlane
       end
 
       def self.details
-        "This is useful if you have only one changelog for all languages"
+        [
+          "This is useful if you have only one changelog for all languages.",
+          "You can store the changelog in `./fastlane/changelog.txt` and it will automatically get loaded from there. This integration is useful if you support e.g. 10 languages and want to use the same \"What's new\"-text for all languages."
+        ].join("\n")
       end
 
       def self.available_options
@@ -106,6 +109,16 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'set_changelog(app_identifier: "com.krausefx.app", version: "1.0", changelog: "All Languages")'
+        ]
+      end
+
+      def self.category
+        :beta
+      end
     end
   end
 end

data/lib/fastlane/actions/set_github_release.rb

@@ -255,6 +255,24 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'github_release = set_github_release(
+            repository_name: "fastlane/fastlane",
+            api_token: ENV["GITHUB_TOKEN"],
+            name: "Super New actions",
+            tag_name: "v1.22.0",
+            description: (File.read("changelog") rescue "No changelog provided"),
+            commitish: "master",
+            upload_assets: ["example_integration.ipa", "./pkg/built.gem"]
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/set_info_plist_value.rb

@@ -46,10 +46,6 @@ module Fastlane
         ]
       end
 
-      def self.output
-        []
-      end
-
       def self.authors
         ["kohtenko"]
       end
@@ -57,6 +53,16 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'set_info_plist_value(path: "./Info.plist", key: "CFBundleIdentifier", value: "com.krausefx.app.beta")'
+        ]
+      end
+
+      def self.category
+        :project
+      end
     end
   end
 end

data/lib/fastlane/actions/set_pod_key.rb

@@ -27,6 +27,10 @@ module Fastlane
         "Sets a value for a key with cocoapods-keys"
       end
 
+      def self.details
+        "Adds a key to [cocoapods-keys](https://github.com/orta/cocoapods-keys)"
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :use_bundle_exec,
@@ -55,6 +59,20 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'set_pod_key(
+            key: "APIToken",
+            value: "1234",
+            project: "MyProject"
+          )'
+        ]
+      end
+
+      def self.category
+        :project
+      end
     end
   end
 end

data/lib/fastlane/actions/setup_jenkins.rb

@@ -91,7 +91,11 @@ module Fastlane
           "- Sets code signing identity from Jenkins 'Keychains and Provisioning Profiles Plugin'",
           "- Sets output directory to './output' (gym, scan and backup_xcarchive).",
           "- Sets derived data path to './derivedData' (xcodebuild, gym, scan and clear_derived_data, carthage).",
-          "- Produce result bundle (gym and scan)."
+          "- Produce result bundle (gym and scan).",
+          "",
+          "This action helps with Jenkins integration. Creates own derived data for each job. All build results like IPA files and archives will be stored in the `./output` directory.",
+          "The action also works with [Keychains and Provisioning Profiles Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Keychains+and+Provisioning+Profiles+Plugin), selected keychain",
+          "will be automatically unlocked and the selected code signing identity will be used. By default this action will only work when fastlane is executed on a CI system."
         ].join("\n")
       end
 
@@ -169,6 +173,16 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include?(platform)
       end
+
+      def self.example_code
+        [
+          'setup_jenkins'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/sigh.rb

@@ -55,6 +55,10 @@ module Fastlane
         "The UDID of the profile sigh just fetched/generated"
       end
 
+      def self.details
+        "**Note**: It is recommended to use [match](https://github.com/fastlane/fastlane/tree/master/match) according to the [codesigning.guide](https://codesigning.guide) for generating and maintaining your provisioning profiles. Use _sigh_ directly only if you want full control over what's going on and know more about codesigning."
+      end
+
       def self.available_options
         require 'sigh'
         Sigh::Options.available_options
@@ -63,6 +67,21 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'sigh',
+          'sigh(
+            adhoc: true,
+            force: true,
+            filename: "myFile.mobileprovision"
+          )'
+        ]
+      end
+
+      def self.category
+        :code_signing
+      end
     end
   end
 end

data/lib/fastlane/actions/skip_docs.rb

@@ -26,6 +26,10 @@ module Fastlane
       def self.return_value
       end
 
+      def self.details
+        "Tell _fastlane_ to not automatically create a `fastlane/README.md` when running _fastlane_. You can always trigger the creation of this file manually by running `fastlane docs`"
+      end
+
       def self.authors
         ["KrauseFx"]
       end
@@ -33,6 +37,16 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'skip_docs'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/slack.rb

@@ -116,6 +116,40 @@ module Fastlane
         "KrauseFx"
       end
 
+      def self.example_code
+        [
+          'slack(message: "App successfully released!")',
+          'slack(
+            message: "App successfully released!",
+            channel: "#channel",  # Optional, by default will post to the default channel configured for the POST URL.
+            success: true,        # Optional, defaults to true.
+            payload: {            # Optional, lets you specify any number of your own Slack attachments.
+              "Build Date" => Time.new.to_s,
+              "Built by" => "Jenkins",
+            },
+            default_payloads: [:git_branch, :git_author], # Optional, lets you specify a whitelist of default payloads to include. Pass an empty array to suppress all the default payloads.
+                                                          # Don\'t add this key, or pass nil, if you want all the default payloads. The available default payloads are: `lane`, `test_result`, `git_branch`, `git_author`, `last_git_commit_message`.
+            attachment_properties: { # Optional, lets you specify any other properties available for attachments in the slack API (see https://api.slack.com/docs/attachments).
+                                     # This hash is deep merged with the existing properties set using the other properties above. This allows your own fields properties to be appended to the existing fields that were created using the `payload` property for instance.
+              thumb_url: "http://example.com/path/to/thumb.png",
+              fields: [{
+                title: "My Field",
+                value: "My Value",
+                short: true
+              }]
+            }
+          )'
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
+
+      def self.details
+        "Create an Incoming WebHook and export this as `SLACK_URL`. Can send a message to **#channel** (by default), a direct message to **@username** or a message to a private group **group** with success (green) or failure (red) status."
+      end
+
       #####################################################
       # @!group Helper
       #####################################################

data/lib/fastlane/actions/slather.rb

@@ -226,17 +226,30 @@ Slather is available at https://github.com/SlatherOrg/slather
       end
 
       def self.output
-        # Define the shared values you are going to provide
       end
 
       def self.authors
-        # So no one will ever forget your contribution to fastlane :) You are awesome btw!
         ["mattdelves"]
       end
 
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'slather(
+            build_directory: "foo",
+            input_format: "bah",
+            scheme: "MyScheme",
+            proj: "MyProject.xcodeproj"
+          )'
+        ]
+      end
+
+      def self.category
+        :testing
+      end
     end
   end
 end

data/lib/fastlane/actions/snapshot.rb

@@ -41,6 +41,20 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'snapshot',
+          'snapshot(
+            skip_open_summary: true,
+            clean: true
+          )'
+        ]
+      end
+
+      def self.category
+        :screenshots
+      end
     end
   end
 end

data/lib/fastlane/actions/sonar.rb

@@ -2,7 +2,7 @@ module Fastlane
   module Actions
     class SonarAction < Action
       def self.run(params)
-        verify_sonar_runner_binary
+        verify_sonar_scanner_binary
 
         command_prefix = [
           'cd',
@@ -10,27 +10,27 @@ module Fastlane
           '&&'
         ].join(' ')
 
-        sonar_runner_args = []
-        sonar_runner_args << "-Dproject.settings=\"#{params[:project_configuration_path]}\"" if params[:project_configuration_path]
-        sonar_runner_args << "-Dsonar.projectKey=\"#{params[:project_key]}\"" if params[:project_key]
-        sonar_runner_args << "-Dsonar.projectName=\"#{params[:project_name]}\"" if params[:project_name]
-        sonar_runner_args << "-Dsonar.projectVersion=\"#{params[:project_version]}\"" if params[:project_version]
-        sonar_runner_args << "-Dsonar.sources=\"#{params[:sources_path]}\"" if params[:sources_path]
-        sonar_runner_args << "-Dsonar.language=\"#{params[:project_language]}\"" if params[:project_language]
-        sonar_runner_args << "-Dsonar.sourceEncoding=\"#{params[:source_encoding]}\"" if params[:source_encoding]
-        sonar_runner_args << params[:sonar_runner_args] if params[:sonar_runner_args]
+        sonar_scanner_args = []
+        sonar_scanner_args << "-Dproject.settings=\"#{params[:project_configuration_path]}\"" if params[:project_configuration_path]
+        sonar_scanner_args << "-Dsonar.projectKey=\"#{params[:project_key]}\"" if params[:project_key]
+        sonar_scanner_args << "-Dsonar.projectName=\"#{params[:project_name]}\"" if params[:project_name]
+        sonar_scanner_args << "-Dsonar.projectVersion=\"#{params[:project_version]}\"" if params[:project_version]
+        sonar_scanner_args << "-Dsonar.sources=\"#{params[:sources_path]}\"" if params[:sources_path]
+        sonar_scanner_args << "-Dsonar.language=\"#{params[:project_language]}\"" if params[:project_language]
+        sonar_scanner_args << "-Dsonar.sourceEncoding=\"#{params[:source_encoding]}\"" if params[:source_encoding]
+        sonar_scanner_args << params[:sonar_runner_args] if params[:sonar_runner_args]
 
         command = [
           command_prefix,
-          'sonar-runner',
-          sonar_runner_args
+          'sonar-scanner',
+          sonar_scanner_args
         ].join(' ')
 
         Action.sh command
       end
 
-      def self.verify_sonar_runner_binary
-        UI.user_error!("You have to install sonar-runner using `brew install sonar-runner`") unless `which sonar-runner`.to_s.length > 0
+      def self.verify_sonar_scanner_binary
+        UI.user_error!("You have to install sonar-scanner using `brew install sonar-runner`") unless `which sonar-scanner`.to_s.length > 0
       end
 
       #####################################################
@@ -38,18 +38,21 @@ module Fastlane
       #####################################################
 
       def self.description
-        "Invokes sonar-runner to programmatically run SonarQube analysis"
+        "Invokes sonar-scanner to programmatically run SonarQube analysis"
       end
 
       def self.details
-        "See http://docs.sonarqube.org/display/SONAR/Analyzing+with+SonarQube+Scanner for details."
+        [
+          "See http://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner for details.",
+          "It can process unit test results if formatted as junit report as shown in [xctest](#xctest) action. It can also integrate coverage reports in Cobertura format, which can be transformed into by [slather](#slather) action."
+        ].join("\n")
       end
 
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :project_configuration_path,
                                         env_name: "FL_SONAR_RUNNER_PROPERTIES_PATH",
-                                        description: "The path to your sonar project configuration file; defaults to `sonar-project.properties`", # default is enforced by sonar-runner binary
+                                        description: "The path to your sonar project configuration file; defaults to `sonar-project.properties`", # default is enforced by sonar-scanner binary
                                         optional: true,
                                         verify_block: proc do |value|
                                           UI.user_error!("Couldn't find file at path '#{value}'") unless value.nil? or File.exist?(value)
@@ -80,13 +83,13 @@ module Fastlane
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :sonar_runner_args,
                                        env_name: "FL_SONAR_RUNNER_ARGS",
-                                       description: "Pass additional arguments to sonar-runner. Be sure to provide the arguments with a leading `-D` e.g. FL_SONAR_RUNNER_ARGS=\"-Dsonar.verbose=true\"",
+                                       description: "Pass additional arguments to sonar-scanner. Be sure to provide the arguments with a leading `-D` e.g. FL_SONAR_RUNNER_ARGS=\"-Dsonar.verbose=true\"",
                                        optional: true)
         ]
       end
 
       def self.return_value
-        "The exit code of the sonar-runner binary"
+        "The exit code of the sonar-scanner binary"
       end
 
       def self.authors
@@ -96,6 +99,21 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'sonar(
+            project_key: "name.gretzki.awesomeApp",
+            project_version: "1.0",
+            project_name: "iOS - AwesomeApp",
+            sources_path: File.expand_path("../AwesomeApp")
+          )'
+        ]
+      end
+
+      def self.category
+        :testing
+      end
     end
   end
 end