fastlane 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca27eb7ad9f33fb5ecebf462c2f680a670fba2bf
-  data.tar.gz: 176e24d93d53ce3fd806296312b530fcf8139500
+  metadata.gz: 2ff79546ed862f892ac91759a464aeac53b73a43
+  data.tar.gz: 4bace796f713dc757e98bd5714307d63e93275ff
 SHA512:
-  metadata.gz: ec9868e6a357517716199df3a2828d7e7baced61ce4f5ff4affb76a962819e14963be65eb0f7f2f4547d4b555143e014eb55bd324bef39e7faee1ce27924da4a
-  data.tar.gz: fc8cc42bb987398e041a96f3883aa372a57b0669e16827a99421fc0fbfa287f6e7dadb5c7634628cef4d4f54292c412d4b74cdecf27d8bab448c6b307fb562fc
+  metadata.gz: b0999de10e1695a008598338aff6226ca942ae5571cbf111d034bf804a4898c8533c77581fbac4b5c1e223b242591984429a7f4262a75d80f182b0ba2fe8ad62
+  data.tar.gz: 114466acfb84ca09bca715e5982fd9147c73e50d5e65cd2d2bf69fe46194d09126c2a11d78eb6a44ec887f4e7611f0d3c22432da776ef4a96e7f15ed85168a5b

data/README.md

@@ -114,6 +114,20 @@ The setup assistant will create all the necessary files for you, using the exist
 
 For more details, please follow the [fastlane guide](https://github.com/KrauseFx/fastlane/blob/master/docs/Guide.md) or [documentation](https://github.com/KrauseFx/fastlane/blob/master/docs).
 
+## Available commands
+
+Usually you'll use fastlane by triggering individual lanes:
+
+    fastlane [lane_name]
+
+#### Other commands
+
+- `fastlane lanes`: Lists all available lanes
+- `fastlane docs`: Generates a markdown based documentation of all your lanes
+- `fastlane actions`: List all available `fastlane` actions
+- `fastlane action [action_name]`: Shows a more detailed description of an action with its available parameters
+- `fastlane new_action`: Create a new action (integration) for fastlane  
+
 ## [`fastlane`](https://fastlane.tools) Toolchain
 
 `fastlane` is designed to make your life easier by bringing together the `fastlane` suite of tools under one roof. 

data/bin/fastlane

@@ -69,6 +69,24 @@ class FastlaneApplication
       end
     end
 
+    command :docs do |c|
+      c.syntax = 'fastlane docs'
+      c.description = 'Generate a markdown based documentation based on the Fastfile'
+      c.option '-f', '--force', 'Overwrite the existing README.md in the ./fastlane folder'
+
+      c.action do |_args, _options|
+        path = File.join(Fastlane::FastlaneFolder.path, 'README.md')
+        if File.exists?path and not _options.force
+          return unless agree('Found existing ./fastlane/README.md. Do you want to overwrite it? (y/n)', true)
+        end
+
+        ff = Fastlane::FastFile.new(File.join(Fastlane::FastlaneFolder.path, 'Fastfile'))
+
+        require 'fastlane/docs_generator'
+        Fastlane::DocsGenerator.run(path, ff)
+      end
+    end
+
     command :actions do |c|
       c.syntax = 'fastlane actions'
       c.description = 'Lists all available fastlane actions'

data/lib/assets/FastfileTemplate

@@ -27,17 +27,23 @@ before_all do
   xctool
 end
 
+desc "Runs all the tests"
 lane :test do
   snapshot
 end
 
+desc "Submit a new Beta Build to Apple TestFlight"
+desc "This will also make sure the profile is up to date"
 lane :beta do
   snapshot
   sigh
   deliver :skip_deploy, :beta
   # sh "your_script.sh"
+  # You can use other beta testing services here
 end
 
+desc "Deploy a new version to the App Store"
+desc "** Full Markdown** Support: `code`"
 lane :deploy do
   snapshot
   sigh
@@ -45,6 +51,7 @@ lane :deploy do
   # frameit
 end
 
+desc "In House Beta Enterprise Distribution"
 lane :inhouse do
   # insert your code here
 end

data/lib/fastlane/actions/deliver.rb

@@ -41,6 +41,7 @@ module Fastlane
           ['force', 'Set to true to skip PDF verification'],
           ['beta', 'Upload a new version to TestFlight'],
           ['skip_deploy', 'Skip the submission of the app - it will only be uploaded'],
+          ['', 'Specify a path to the directory containing the Deliverfile', 'DELIVERFILE_PATH']
         ]
       end
 

data/lib/fastlane/actions/increment_build_number.rb

@@ -22,6 +22,9 @@ module Fastlane
           when Fixnum
             custom_number = first_param
             folder = '.'
+          when String
+            custom_number = first_param
+            folder = '.'
           when Hash
             custom_number = first_param[:build_number]
             folder = first_param[:xcodeproj] ? File.join('.', first_param[:xcodeproj], '..') : '.'

data/lib/fastlane/actions/ipa.rb

@@ -31,7 +31,6 @@ module Fastlane
       identity: '-i',
       sdk: '--sdk',
       ipa: '--ipa',
-      verbose: '--verbose',
       xcargs: '--xcargs',
     }
 
@@ -72,7 +71,7 @@ module Fastlane
         # Joins args into space delimited string
         build_args = build_args.join(' ')
 
-        command = "ipa build #{build_args}"
+        command = "set -o pipefail && ipa build #{build_args} --verbose | xcpretty"
         Helper.log.debug command
         Actions.sh command
 
@@ -88,8 +87,8 @@ module Fastlane
       end
 
       def self.params_to_build_args(params)
-        # Remove nil value params unless :clean or :archive or :verbose
-        params = params.delete_if { |k, v| (k != :clean && k != :archive && k != :verbose) && v.nil? }
+        # Remove nil value params unless :clean or :archive
+        params = params.delete_if { |k, v| (k != :clean && k != :archive) && v.nil? }
 
         params = fill_in_default_values(params)
 
@@ -134,21 +133,20 @@ module Fastlane
       end
 
       def self.available_options
-        [
-          ['workspace', 'Workspace (.xcworkspace) file to use to build app (automatically detected in current directory)'],
-          ['project', 'Project (.xcodeproj) file to use to build app (automatically detected in current directory'],
-          ['configuration', 'Configuration used to build'],
-          ['scheme', 'Scheme used to build app'],
-          ['clean', 'use an extra XCCONFIG file to build the app'],
-          ['archive', 'pass additional arguments to xcodebuild when building the app. Be sure to quote multiple args.'],
-          ['destination', 'Clean project before building'],
-          ['embed', 'Archive project after building'],
-          ['identity', 'Destination. Defaults to current directory'],
-          ['sdk', 'Sign .ipa file with .mobileprovision'],
-          ['ipa', 'Identity to be used along with --embed'],
-          ['verbose', 'use SDK as the name or path of the base SDK when building the project'],
-          ['xcargs', 'specify the name of the .ipa file to generate (including file extension)']
-        ]
+        # [
+          # ['workspace', 'Workspace (.xcworkspace) file to use to build app (automatically detected in current directory)'],
+          # ['project', 'Project (.xcodeproj) file to use to build app (automatically detected in current directory'],
+          # ['configuration', 'Configuration used to build'],
+          # ['scheme', 'Scheme used to build app'],
+          # ['clean', 'use an extra XCCONFIG file to build the app'],
+          # ['archive', 'pass additional arguments to xcodebuild when building the app. Be sure to quote multiple args.'],
+          # ['destination', 'Clean project before building'],
+          # ['embed', 'Archive project after building'],
+          # ['identity', 'Destination. Defaults to current directory'],
+          # ['sdk', 'Sign .ipa file with .mobileprovision'],
+          # ['ipa', 'Identity to be used along with --embed'],
+          # ['xcargs', 'specify the name of the .ipa file to generate (including file extension)']
+        # ]
       end
 
       def self.output

data/lib/fastlane/actions/slack.rb

@@ -16,6 +16,16 @@ module Fastlane
         nil
       end
 
+      # As there is a text limit in the notifications, we are 
+      # usually interested in the last part of the message
+      # e.g. for tests
+      def self.trim_message(message)
+        # We want the last 7000 characters, instead of the first 7000, as the error is at the bottom
+        start_index = [message.length - 7000, 0].max
+        message = message[start_index..-1]
+        message
+      end
+
       def self.run(params)
         options = { message: '',
                     success: true,
@@ -26,7 +36,7 @@ module Fastlane
         require 'slack-notifier'
 
         color = (options[:success] ? 'good' : 'danger')
-        options[:message] = options[:message].to_s
+        options[:message] = self.trim_message(options[:message].to_s || '')
 
         options[:message] = Slack::Notifier::LinkFormatter.format(options[:message])
 

data/lib/fastlane/docs_generator.rb

@@ -0,0 +1,19 @@
+module Fastlane
+  class DocsGenerator
+    def self.run(output_path, ff)
+      output = "fastlane actions\n"
+      output += "================\n"
+      
+      ff.runner.description_blocks.each do |lane, description|
+        output += "## #{lane}\n\n"
+        output += "```\n"
+        output += "fastlane #{lane}\n"
+        output += "```\n\n"
+        output += description + "\n"
+      end
+      
+      File.write(output_path, output)
+      Helper.log.info "Successfully generated documentation to path '#{File.expand_path(output_path)}'".green
+    end
+  end
+end

data/lib/fastlane/fast_file.rb

@@ -16,6 +16,10 @@ module Fastlane
       @collector ||= ActionCollector.new
     end
 
+    def desc_collection
+      @desc_collection ||= []
+    end
+
     def parse(data)
       @runner = Runner.new
 
@@ -27,7 +31,9 @@ module Fastlane
     end
 
     def lane(key, &block)
-      @runner.set_block(key, block)
+      desc = desc_collection.join("\n\n")
+      @runner.set_block(key, block, desc)
+      @desc_collection = nil # reset again
     end
 
     def before_all(&block)
@@ -69,6 +75,10 @@ module Fastlane
       collector.did_finish
     end
 
+    def desc(string)
+      desc_collection << string
+    end
+
     def method_missing(method_sym, *arguments, &_block)
       # First, check if there is a predefined method in the actions folder
 

data/lib/fastlane/runner.rb

@@ -51,15 +51,21 @@ module Fastlane
       @error = block
     end
 
-    def set_block(key, block)
+    # @param key: The name of the lane
+    # @param block: The block of the lane
+    # @param desc: Description of this action
+    def set_block(key, block, desc = nil)
       raise "Lane '#{key}' was defined multiple times!".red if blocks[key]
       blocks[key] = block
+      description_blocks[key] = desc
     end
 
-    private
-
     def blocks
       @blocks ||= {}
     end
+
+    def description_blocks
+      @description_blocks ||= {}
+    end
   end
 end

data/lib/fastlane/version.rb

@@ -1,3 +1,3 @@
 module Fastlane
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fastlane
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Felix Krause
@@ -218,14 +218,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.4.8
+        version: 0.4.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.4.8
+        version: 0.4.9
 - !ruby/object:Gem::Dependency
   name: produce
   requirement: !ruby/object:Gem::Requirement
@@ -428,6 +428,7 @@ files:
 - lib/fastlane/actions_list.rb
 - lib/fastlane/core_ext/string.rb
 - lib/fastlane/dependency_checker.rb
+- lib/fastlane/docs_generator.rb
 - lib/fastlane/fast_file.rb
 - lib/fastlane/fastlane_folder.rb
 - lib/fastlane/junit_generator.rb