fastlane 1.104.0 → 1.105.0

data/lib/fastlane/actions/git_branch.rb

@@ -37,6 +37,16 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'git_branch'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/git_commit.rb

@@ -58,6 +58,19 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'git_commit(path: "./version.txt",
+                      message: "Version Bump")',
+          'git_commit(path: ["./version.txt", "./changelog.txt"],
+                      message: "Version Bump")'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/git_pull.rb

@@ -37,6 +37,17 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'git_pull',
+          'git_pull(only_tags: true) # only the tags, no commits'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/git_tag_exists.rb

@@ -41,6 +41,18 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'if git_tag_exists(tag: "1.1.0")
+            UI.message("Found it 🚀")
+          end'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/gradle.rb

@@ -163,6 +163,51 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :android || platform == :ios
       end
+
+      def self.example_code
+        [
+          'gradle(
+            task: "assemble",
+            flavor: "WorldDomination",
+            build_type: "Release"
+          )',
+          'gradle(
+            # ...
+
+            properties: {
+              "versionCode" => 100,
+              "versionName" => "1.0.0",
+              # ...
+            }
+          )',
+          '# If you need to pass sensitive information through the `gradle` action, and don"t want the generated command to be printed before it is run, you can suppress that:
+          gradle(
+            # ...
+            print_command: false
+          )
+          ```
+
+          You can also suppress printing the output generated by running the generated Gradle command:
+          ```ruby
+          gradle(
+            # ...
+            print_command_output: false
+          )
+          ```
+
+          To pass any other CLI flags to gradle use:
+          ```ruby
+          gradle(
+            # ...
+
+            flags: "--exitcode --xml file.xml"
+          )'
+        ]
+      end
+
+      def self.category
+        :building
+      end
     end
   end
 end

data/lib/fastlane/actions/gym.rb

@@ -12,7 +12,9 @@ module Fastlane
         begin
           FastlaneCore::UpdateChecker.start_looking_for_update('gym') unless Helper.is_test?
 
-          if values[:provisioning_profile_path].to_s.length == 0
+          should_use_legacy_api = values[:use_legacy_build_api] || Gym::Xcode.pre_7?
+
+          if values[:provisioning_profile_path].to_s.length.zero? && should_use_legacy_api
             sigh_path = Actions.lane_context[Actions::SharedValues::SIGH_PROFILE_PATH] || ENV["SIGH_PROFILE_PATH"]
             values[:provisioning_profile_path] = File.expand_path(sigh_path) if sigh_path
           end
@@ -40,11 +42,11 @@ module Fastlane
       end
 
       def self.description
-        "Easily build and sign your app using `gym`"
+        "Easily build and sign your app using _gym_"
       end
 
       def self.details
-        "More information: https://github.com/fastlane/fastlane/tree/master/gym"
+        "More information: https://fastlane.tools/gym"
       end
 
       def self.return_value
@@ -63,6 +65,26 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'gym(scheme: "MyApp", workspace: "MyApp.xcworkspace")',
+          'gym(
+            workspace: "MyApp.xcworkspace",
+            configuration: "Debug",
+            scheme: "MyApp",
+            silent: true,
+            clean: true,
+            output_directory: "path/to/dir", # Destination directory. Defaults to current directory.
+            output_name: "my-app.ipa",       # specify the name of the .ipa file to generate (including file extension)
+            sdk: "10.0"                      # use SDK as the name or path of the base SDK when building the project.
+          )'
+        ]
+      end
+
+      def self.category
+        :building
+      end
     end
   end
 end

data/lib/fastlane/actions/hg_add_tag.rb

@@ -33,6 +33,16 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'hg_add_tag(tag: "1.3")'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/hg_commit_version_bump.rb

@@ -151,6 +151,32 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.details
+        [
+          "The mercurial equivalent of the [`commit_version_bump`](#commit_version_bump) git action. Like the git version, it is useful in conjunction with [`increment_build_number`](#increment_build_number).",
+          "It checks the repo to make sure that only the relevant files have changed, these are the files that `increment_build_number` (`agvtool`) touches:",
+          "- All .plist files",
+          "- The `.xcodeproj/project.pbxproj` file",
+          "Then commits those files to the repo.",
+          "Customise the message with the `:message` option, defaults to 'Version Bump'",
+          "If you have other uncommitted changes in your repo, this action will fail. If you started off in a clean repo, and used the _ipa_ and or _sigh_ actions, then you can use the [`clean_build_artifacts`](#clean_build_artifacts) action to clean those temporary files up before running this action."
+        ].join("\n")
+      end
+
+      def self.example_code
+        [
+          'hg_commit_version_bump',
+          'hg_commit_version_bump(
+            message: "Version Bump",                 # create a commit with a custom message
+            xcodeproj: "./path/MyProject.xcodeproj", # optional, if you have multiple Xcode project files, you must specify your main project here
+          )'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/hg_ensure_clean_status.rb

@@ -20,6 +20,10 @@ module Fastlane
         "Raises an exception if there are uncommited hg changes"
       end
 
+      def self.details
+        "Along the same lines as the [`ensure_git_status_clean`](#ensure_git_status_clean) action, this is a sanity check to ensure the working mercurial repo is clean. Especially useful to put at the beginning of your Fastfile in the `before_all` block."
+      end
+
       def self.output
         [
           ['HG_REPO_WAS_CLEAN_ON_START', 'Stores the fact that the hg repo was clean at some point']
@@ -34,6 +38,16 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'hg_ensure_clean_status'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/hg_push.rb

@@ -18,6 +18,10 @@ module Fastlane
         "This will push changes to the remote hg repository"
       end
 
+      def self.details
+        "The mercurial equivalent of [`push_to_git_remote`](#push_to_git_remote) — pushes your local commits to a remote mercurial repo. Useful when local changes such as adding a version bump commit or adding a tag are part of your lane’s actions."
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :force,
@@ -41,6 +45,20 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'hg_push',
+          'hg_push(
+            destination: "ssh://hg@repohost.com/owner/repo",
+            force: true
+          )'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/hipchat.rb

@@ -172,6 +172,25 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.details
+        "Send a message to **room** (by default) or a direct message to **@username** with success (green) or failure (red) status."
+      end
+
+      def self.example_code
+        [
+          'hipchat(
+            message: "App successfully released!",
+            message_format: "html", # or "text", defaults to "html"
+            channel: "Room or @username",
+            success: true
+          )'
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
     end
   end
 end

data/lib/fastlane/actions/hockey.rb

@@ -100,7 +100,7 @@ module Fastlane
                                        end),
           FastlaneCore::ConfigItem.new(key: :ipa,
                                        env_name: "FL_HOCKEY_IPA",
-                                       description: "Path to your IPA file. Optional if you use the `gym` or `xcodebuild` action. For Mac zip the .app. For Android provide path to .apk file",
+                                       description: "Path to your IPA file. Optional if you use the _gym_ or _xcodebuild_ action. For Mac zip the .app. For Android provide path to .apk file",
                                        default_value: Actions.lane_context[SharedValues::IPA_OUTPUT_PATH],
                                        optional: true,
                                        verify_block: proc do |value|
@@ -203,6 +203,27 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac, :android].include? platform
       end
+
+      def self.details
+        [
+          "Symbols will also be uploaded automatically if a `app.dSYM.zip` file is found next to `app.ipa`. In case it is located in a different place you can specify the path explicitly in `:dsym` parameter.",
+          "More information about the available options can be found in the [HockeyApp Docs](http://support.hockeyapp.net/kb/api/api-versions#upload-version)."
+        ].join("\n")
+      end
+
+      def self.example_code
+        [
+          'hockey(
+            api_token: "...",
+            ipa: "./app.ipa",
+            notes: "Changelog"
+          )'
+        ]
+      end
+
+      def self.category
+        :beta
+      end
     end
   end
 end

data/lib/fastlane/actions/ifttt.rb

@@ -31,6 +31,10 @@ module Fastlane
         "Connect to the IFTTT Maker Channel. https://ifttt.com/maker"
       end
 
+      def self.details
+        "Connect to the IFTTT [Maker Channel](https://ifttt.com/maker). An IFTTT Recipe has two components: a Trigger and an Action. In this case, the Trigger will fire every time the Maker Channel receives a web request (made by this _fastlane_ action) to notify it of an event. The Action can be anything that IFTTT supports: email, SMS, etc."
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :api_key,
@@ -70,6 +74,22 @@ module Fastlane
       def self.authors
         ["vpolouchkine"]
       end
+
+      def self.example_code
+        [
+          'ifttt(
+            api_key: "...",
+            event_name: "...",
+            value1: "foo",
+            value2: "bar",
+            value3: "baz"
+          )'
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
     end
   end
 end

data/lib/fastlane/actions/import.rb

@@ -34,6 +34,16 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'import "./path/to/other/Fastfile"'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/import_certificate.rb

@@ -30,6 +30,7 @@ module Fastlane
                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :log_output,
                                        description: "If output should be logged to the console",
+                                       type: TrueClass,
                                        default_value: false,
                                        optional: true)
         ]
@@ -42,6 +43,24 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.details
+        "Import certificates into the current default keychain. Use `create_keychain` to create a new keychain."
+      end
+
+      def self.example_code
+        [
+          'import_certificate(certificate_path: "certs/AppleWWDRCA.cer")',
+          'import_certificate(
+            certificate_path: "certs/dist.p12",
+            certificate_password: ENV["CERTIFICATE_PASSWORD"] || "default"
+          )'
+        ]
+      end
+
+      def self.category
+        :code_signing
+      end
     end
   end
 end

data/lib/fastlane/actions/import_from_git.rb

@@ -43,6 +43,20 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'import_from_git(
+            url: "git@github.com:fastlane/fastlane.git", # The url of the repository to import the Fastfile from.
+            branch: "HEAD", # The branch to checkout on the repository. Defaults to `HEAD`.
+            path: "fastlane/Fastfile" # The path of the Fastfile in the repository. Defaults to `fastlane/Fastfile`.
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end