fastlane 1.104.0 → 1.105.0

data/lib/fastlane/actions/apteligent.rb

@@ -84,6 +84,19 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'apteligent(
+            app_id: "...",
+            api_key: "..."
+          )'
+        ]
+      end
+
+      def self.category
+        :beta
+      end
     end
   end
 end

data/lib/fastlane/actions/artifactory.rb

@@ -47,6 +47,23 @@ module Fastlane
         ["koglinjg"]
       end
 
+      def self.example_code
+        [
+          'artifactory(
+            username: "username",
+            password: "password",
+            endpoint: "https://artifactory.example.com/artifactory/",
+            file: "example.ipa",                                # File to upload
+            repo: "mobile_artifacts",                           # Artifactory repo
+            repo_path: "/ios/appname/example-major.minor.ipa"   # Path to place the artifact including its filename
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :file,

data/lib/fastlane/actions/backup_file.rb

@@ -26,6 +26,16 @@ module Fastlane
                                        optional: false)
         ]
       end
+
+      def self.example_code
+        [
+          'backup_file(path: "/path/to/file")'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/backup_xcarchive.rb

@@ -103,6 +103,21 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'backup_xcarchive(
+            xcarchive: "/path/to/file.xcarchive", # Optional if you use the `xcodebuild` action
+            destination: "/somewhere/else/file.xcarchive", # Where the backup should be created
+            zip: false, # Enable compression of the archive. Defaults to `true`.
+            versioned: true # Create a versioned (date and app version) subfolder where to put the archive. Default value `true`
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/badge.rb

@@ -31,10 +31,24 @@ module Fastlane
         [
           "This action will add a light/dark badge onto your app icon.",
           "You can also provide your custom badge/overlay or add an shield for more customization more info:",
-          "https://github.com/HazAT/badge"
+          "https://github.com/HazAT/badge",
+          "**Note** If you want to reset the badge back to default you can use `sh 'git checkout -- <path>/Assets.xcassets/'`"
         ].join("\n")
       end
 
+      def self.example_code
+        [
+          'badge(dark: true)',
+          'badge(alpha: true)',
+          'badge(custom: "/Users/xxx/Desktop/badge.png")',
+          'badge(shield: "Version-0.0.3-blue", no_badge: true)'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :dark,

data/lib/fastlane/actions/build_and_upload_to_appetize.rb

@@ -38,7 +38,10 @@ module Fastlane
       end
 
       def self.details
-        "This should be called from danger"
+        [
+          "This should be called from danger",
+          "More information in the [device_grid guide](https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/device_grid/README.md)"
+        ].join("\n")
       end
 
       def self.available_options
@@ -75,6 +78,16 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/bundle_install.rb

@@ -55,6 +55,15 @@ module Fastlane
         ["birmacher", "koglinjg"]
       end
 
+      def self.example_code
+        [
+        ]
+      end
+
+      def self.category
+        :misc
+      end
+
       def self.available_options
         [
           FastlaneCore::ConfigItem.new(key: :binstubs,

data/lib/fastlane/actions/carthage.rb

@@ -132,6 +132,29 @@ module Fastlane
         ]
       end
 
+      def self.example_code
+        [
+          'carthage',
+          'carthage(
+            command: "bootstrap",                           # One of: build, bootstrap, update, archive. (default: bootstrap)
+            dependencies: ["Alamofire", "Notice"],          # Specify which dependencies to update (only for the update command)
+            use_ssh: false,                                 # Use SSH for downloading GitHub repositories.
+            use_submodules: false,                          # Add dependencies as Git submodules.
+            use_binaries: true,                             # Check out dependency repositories even when prebuilt frameworks exist
+            no_build: false,                                # When bootstrapping Carthage do not build
+            no_skip_current: false,                         # Don\'t skip building the current project (only for frameworks)
+            verbose: false,                                 # Print xcodebuild output inline
+            platform: "all",                                # Define which platform to build for (one of ‘all’, ‘Mac’, ‘iOS’, ‘watchOS’, ‘tvOS‘, or comma-separated values of the formers except for ‘all’)
+            configuration: "Release",                       # Build configuration to use when building
+            toolchain: "com.apple.dt.toolchain.Swift_2_3"   # Specify the xcodebuild toolchain
+          )'
+        ]
+      end
+
+      def self.category
+        :building
+      end
+
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end

data/lib/fastlane/actions/cert.rb

@@ -34,6 +34,13 @@ module Fastlane
         "Fetch or generate the latest available code signing identity"
       end
 
+      def self.details
+        [
+          "**Important**: 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 certificates. Use _cert_ directly only if you want full control over what's going on and know more about codesigning.",
+          "Use this action to download the latest code signing identity"
+        ].join("\n")
+      end
+
       def self.available_options
         require 'cert'
         Cert::Options.available_options
@@ -46,6 +53,20 @@ module Fastlane
       def self.is_supported?(platform)
         platform == :ios
       end
+
+      def self.example_code
+        [
+          'cert',
+          'cert(
+            development: true,
+            username: "user@email.com"
+          )'
+        ]
+      end
+
+      def self.category
+        :code_signing
+      end
     end
   end
 end

data/lib/fastlane/actions/changelog_from_git_commits.rb

@@ -130,6 +130,22 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'changelog_from_git_commits',
+          'changelog_from_git_commits(
+            between: ["7b092b3", "HEAD"], # Optional, lets you specify a revision/tag range between which to collect commit info
+            pretty: "- (%ae) %s", # Optional, lets you provide a custom format to apply to each commit when generating the changelog text
+            match_lightweight_tag: false, # Optional, lets you ignore lightweight (non-annotated) tags when searching for the last tag
+            include_merges: true # Optional, lets you filter out merge commits
+          )'
+        ]
+      end
+
+      def self.category
+        :source_control
+      end
     end
   end
 end

data/lib/fastlane/actions/chatwork.rb

@@ -63,12 +63,31 @@ module Fastlane
       end
 
       def self.author
-        "ChatWork Inc."
+        "astronaughts"
       end
 
       def self.is_supported?(platform)
         true
       end
+
+      def self.details
+        "Information on how to obtain an API token: http://developer.chatwork.com/ja/authenticate.html"
+      end
+
+      def self.example_code
+        [
+          'chatwork(
+            message: "App successfully released!",
+            roomid: 12345,
+            success: true,
+            api_token: "Your Token"
+          )'
+        ]
+      end
+
+      def self.category
+        :notifications
+      end
     end
   end
 end

data/lib/fastlane/actions/clean_build_artifacts.rb

@@ -35,7 +35,15 @@ module Fastlane
       end
 
       def self.description
-        "Deletes files created as result of running ipa, cert, sigh or download_dsyms"
+        "Deletes files created as result of running gym, cert, sigh or download_dsyms"
+      end
+
+      def self.details
+        [
+          "This action deletes the files that get created in your repo as a result of running the _gym_ and _sigh_ commands. It doesn't delete the `fastlane/report.xml` though, this is probably more suited for the .gitignore.",
+          "",
+          "Useful if you quickly want to send out a test build by dropping down to the command line and typing something like `fastlane beta`, without leaving your repo in a messy state afterwards."
+        ].join("\n")
       end
 
       def self.author
@@ -45,6 +53,16 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'clean_build_artifacts'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/clean_cocoapods_cache.rb

@@ -36,6 +36,17 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'clean_cocoapods_cache',
+          'clean_cocoapods_cache(name: "CACHED_POD")'
+        ]
+      end
+
+      def self.category
+        :building
+      end
     end
   end
 end

data/lib/fastlane/actions/clear_derived_data.rb

@@ -39,6 +39,17 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include?(platform)
       end
+
+      def self.example_code
+        [
+          'clear_derived_data',
+          'clear_derived_data(derived_data_path: "/custom/")'
+        ]
+      end
+
+      def self.category
+        :building
+      end
     end
   end
 end

data/lib/fastlane/actions/clipboard.rb

@@ -30,6 +30,17 @@ module Fastlane
       def self.is_supported?(platform)
         true
       end
+
+      def self.example_code
+        [
+          'clipboard(value: "https://github.com/fastlane/fastlane/tree/master/fastlane")',
+          'clipboard(value: lane_context[SharedValues::HOCKEY_DOWNLOAD_LINK] || "")'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/cloc.rb

@@ -26,7 +26,10 @@ module Fastlane
       end
 
       def self.details
-        "This action will run cloc to generate a SLOC report that the Jenkins SLOCCount plugin can read.  See https://wiki.jenkins-ci.org/display/JENKINS/SLOCCount+Plugin for more information."
+        [
+          "This action will run cloc to generate a SLOC report that the Jenkins SLOCCount plugin can read.",
+          "See https://wiki.jenkins-ci.org/display/JENKINS/SLOCCount+Plugin and https://github.com/AlDanial/cloc for more information."
+        ].join("\n")
       end
 
       def self.available_options
@@ -67,6 +70,20 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include?(platform)
       end
+
+      def self.example_code
+        [
+          'cloc(
+             exclude_dir: "ThirdParty,Resources",
+             output_directory: "reports",
+             source_directory: "MyCoolApp"
+          )'
+        ]
+      end
+
+      def self.category
+        :misc
+      end
     end
   end
 end

data/lib/fastlane/actions/cocoapods.rb

@@ -86,6 +86,24 @@ module Fastlane
       def self.authors
         ["KrauseFx", "tadpol", "birmacher", "Liquidsoul"]
       end
+
+      def self.details
+        "If you use [CocoaPods](http://cocoapods.org) you can use the `cocoapods` integration to run `pod install` before building your app."
+      end
+
+      def self.example_code
+        [
+          'cocoapods',
+          'cocoapods(
+            clean: true,
+            podfile: "./CustomPodfile"
+          )'
+        ]
+      end
+
+      def self.category
+        :building
+      end
     end
   end
 end

data/lib/fastlane/actions/commit_version_bump.rb

@@ -155,6 +155,22 @@ module Fastlane
         ]
       end
 
+      def self.details
+        [
+          "This action will create a 'Version Bump' commit in your repo. Useful in conjunction with `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` action to clean those temporary files up before running this action."
+        ].join("\n")
+      end
+
       def self.author
         "lmirosevic"
       end
@@ -162,6 +178,20 @@ module Fastlane
       def self.is_supported?(platform)
         [:ios, :mac].include? platform
       end
+
+      def self.example_code
+        [
+          'commit_version_bump',
+          'commit_version_bump(
+            message: "Version Bump",                    # create a commit with a custom message
+            xcodeproj: "./path/to/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