fastlane 1.104.0 → 1.105.0

data/lib/fastlane/actions/increment_build_number.rb

@@ -38,14 +38,14 @@ module Fastlane
         ].join(' ')
 
         if Helper.test?
-          Actions.lane_context[SharedValues::BUILD_NUMBER] = command
+          return Actions.lane_context[SharedValues::BUILD_NUMBER] = command
         else
           Actions.sh command
 
           # Store the new number in the shared hash
           build_number = `#{command_prefix} agvtool what-version`.split("\n").last.strip
 
-          Actions.lane_context[SharedValues::BUILD_NUMBER] = build_number
+          return Actions.lane_context[SharedValues::BUILD_NUMBER] = build_number
         end
       rescue => ex
         UI.error('Make sure to follow the steps to setup your Xcode project: https://developer.apple.com/library/ios/qa/qa1827/_index.html')
@@ -80,9 +80,31 @@ module Fastlane
         ]
       end
 
+      def self.return_value
+        "The new build number"
+      end
+
       def self.author
         "KrauseFx"
       end
+
+      def self.example_code
+        [
+          'increment_build_number # automatically increment by one',
+          'increment_build_number(
+            build_number: "75" # set a specific number
+          )',
+          'increment_build_number(
+            build_number: 75, # specify specific build number (optional, omitting it increments by one)
+            xcodeproj: "./path/to/MyApp.xcodeproj" # (optional, you must specify the path to your main Xcode project if it is not in the project root directory)
+          )',
+          'build_number = increment_build_number'
+        ]
+      end
+
+      def self.category
+        :project
+      end
     end
   end
 end

data/lib/fastlane/actions/increment_version_number.rb

@@ -116,9 +116,40 @@ module Fastlane
         ]
       end
 
+      def self.return_value
+        "The new version number"
+      end
+
       def self.author
         "serluca"
       end
+
+      def self.example_code
+        [
+          'increment_version_number # Automatically increment patch version number',
+          'increment_version_number(
+            bump_type: "patch" # Automatically increment patch version number
+          )',
+          'increment_version_number(
+            bump_type: "minor" # Automatically increment minor version number
+          )',
+          'increment_version_number(
+            bump_type: "major" # Automatically increment major version number
+          )',
+          'increment_version_number(
+            version_number: "2.1.1" # Set a specific version number
+          )',
+          'increment_version_number(
+            version_number: "2.1.1",                # specify specific version number (optional, omitting it increments patch version number)
+            xcodeproj: "./path/to/MyApp.xcodeproj"  # (optional, you must specify the path to your main Xcode project if it is not in the project root directory)
+          )',
+          'version = increment_version_number'
+        ]
+      end
+
+      def self.category
+        :project
+      end
     end
   end
 end

data/lib/fastlane/actions/install_on_device.rb

@@ -68,9 +68,26 @@ module Fastlane
         ["hjanuschka"]
       end
 
+      def self.details
+        "Installs the ipa on the device, if no id is given, the first found iOS device will be used, works via USB or Wi-Fi. This requires `ios-deploy` to be installed please have a look at [ios-deploy](https://github.com/phonegap/ios-deploy). to quickly install it, use `npm -g i ios-deploy`"
+      end
+
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'install_on_device(
+            device_id: "a3be6c9ff7e5c3c6028597513243b0f933b876d4",
+            ipa: "./app.ipa"
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/install_xcode_plugin.rb

@@ -80,6 +80,17 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac, :tvos, :watchos, :caros].include?(platform)
       end
+
+      def self.example_code
+        [
+          'install_xcode_plugin(url: "https://example.com/clubmate/plugin.zip")',
+          'install_xcode_plugin(github: "https://github.com/contentful/ContentfulXcodePlugin")'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/installr.rb

@@ -73,7 +73,7 @@ module Fastlane
                                      end),
           FastlaneCore::ConfigItem.new(key: :ipa,
                                      env_name: "INSTALLR_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 build file at path '#{value}'") unless File.exist?(value)
@@ -109,6 +109,22 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios].include?(platform)
       end
+
+      def self.example_code
+        [
+          'installr(
+            api_token: "...",
+            ipa: "test.ipa",
+            notes: "The next great version of the app!",
+            notify: "dev,qa",
+            add: "exec,ops"
+          )'
+        ]
+      end
+
+      def self.category
+        :beta
+      end
     end
   end
 end

data/lib/fastlane/actions/ipa.rb

@@ -136,8 +136,9 @@ module Fastlane
 
       def self.details
         [
+          "**Note**: This action is deprecated, use _gym_ instead",
           "More information on the shenzhen project page: https://github.com/nomad/shenzhen",
-          "To make code signing work, it is recommended to set a the provisioning profile in the project settings."
+          "To make code signing work, follow https://docs.fastlane.tools/codesigning/xcode-project/#"
         ].join(' ')
       end
 
@@ -210,6 +211,29 @@ module Fastlane
       def self.author
         "joshdholtz"
       end
+
+      def self.example_code
+        [
+          'ipa(
+            workspace: "MyApp.xcworkspace",
+            configuration: "Debug",
+            scheme: "MyApp",
+            # (optionals)
+            clean: true,                     # This means "Do Clean". Cleans project before building (the default if not specified).
+            destination: "path/to/dir",      # Destination directory. Defaults to current directory.
+            ipa: "my-app.ipa",               # specify the name of the .ipa file to generate (including file extension)
+            xcargs: "MY_ADHOC=0",            # pass additional arguments to xcodebuild when building the app.
+            embed: "my.mobileprovision",     # Sign .ipa file with .mobileprovision
+            identity: "MyIdentity",          # Identity to be used along with --embed
+            sdk: "10.0",                     # use SDK as the name or path of the base SDK when building the project.
+            archive: true                    # this means "Do Archive". Archive project after building (the default if not specified).
+          )'
+        ]
+      end
+
+      def self.category
+        :building
+      end
     end
   end
 end

data/lib/fastlane/actions/is_ci.rb

@@ -25,13 +25,26 @@ module Fastlane
       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)
         true
       end
+
+      def self.example_code
+        [
+          'if is_ci?
+            puts "I\'m a computer"
+          else
+            say "Hi Human!"
+          end'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/jazzy.rb

@@ -44,6 +44,16 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include?(platform)
       end
+
+      def self.example_code
+        [
+          'jazzy'
+        ]
+      end
+
+      def self.category
+        :documentation
+      end
     end
   end
 end

data/lib/fastlane/actions/jira.rb

@@ -70,9 +70,6 @@ module Fastlane
         ]
       end
 
-      def self.output
-      end
-
       def self.return_value
       end
 
@@ -83,6 +80,22 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'jira(
+            url: "https://bugs.yourdomain.com",
+            username: "Your username",
+            password: "Your password",
+            ticket_id: "Ticket ID, i.e. IOS-123",
+            comment_text: "Text to post as a comment"
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/lane_context.rb

@@ -33,6 +33,14 @@ module Fastlane
       def self.step_text
         nil
       end
+
+      def self.example_code
+        []
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/last_git_commit.rb

@@ -24,6 +24,29 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'commit = last_git_commit
+          crashlytics(notes: commit[:message]) # message of commit
+          author = commit[:author] # author of the commit
+          hash = commit[:commit_hash] # long sha of commit
+          short_hash = commit[:abbreviated_commit_hash] # short sha of commit'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
+
+      def self.sample_return_value
+        {
+          message: "message",
+          author: "author",
+          commit_hash: "commit_hash",
+          abbreviated_commit_hash: "short_hash"
+        }
+      end
     end
   end
 end

data/lib/fastlane/actions/last_git_tag.rb

@@ -28,6 +28,20 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.details
+        "If you are using this action on a **shallow clone**, *the default with some CI systems like Bamboo*, you need to ensure that you have also have pulled all the git tags appropriately.  Assuming your git repo has the correct remote set you can issue `sh('git fetch --tags')`"
+      end
+
+      def self.example_code
+        [
+          'last_git_tag'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/latest_testflight_build_number.rb

@@ -56,7 +56,10 @@ module Fastlane
       end
 
       def self.details
-        "Provides a way to have increment_build_number be based on the latest build you uploaded to iTC."
+        [
+          "Provides a way to have increment_build_number be based on the latest build you uploaded to iTC.",
+          "Fetches most recent build number from TestFlight based on the version number. Provides a way to have `increment_build_number` be based on the latest build you uploaded to iTC."
+        ].join("\n")
       end
 
       def self.available_options
@@ -108,6 +111,23 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'latest_testflight_build_number(version: "1.3")',
+          'increment_build_number({
+            build_number: latest_testflight_build_number + 1
+          })'
+        ]
+      end
+
+      def self.sample_return_value
+        2
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/lcov.rb

@@ -83,6 +83,20 @@ module Fastlane
       def self.exclude_dirs
         ["/Applications/*", "/Frameworks/*"]
       end
+
+      def self.example_code
+        [
+          'lcov(
+            project_name: "ProjectName",
+            scheme: "yourScheme",
+            output_dir: "cov_reports" # This value is optional. Default is coverage_reports
+          )'
+        ]
+      end
+
+      def self.category
+        :testing
+      end
     end
   end
 end

data/lib/fastlane/actions/mailgun.rb

@@ -128,6 +128,31 @@ module Fastlane
         end
         eth.render(html_template, hash)
       end
+
+      def self.example_code
+        [
+          'mailgun(
+            to: "fastlane@krausefx.com",
+            success: true,
+            message: "This is the mail\'s content"
+          )',
+          'mailgun(
+            postmaster: "MY_POSTMASTER",
+            apikey: "MY_API_KEY",
+            to: "DESTINATION_EMAIL",
+            from: "EMAIL_FROM_NAME",
+            success: true,
+            message: "Mail Body",
+            app_link: "http://www.myapplink.com",
+            ci_build_link: "http://www.mycibuildlink.com",
+            template_path: "HTML_TEMPLATE_PATH"
+          )'
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
     end
   end
 end