fastlane 2.179.0 → 2.180.0

data/fastlane/lib/fastlane/actions/sourcedocs.rb

@@ -0,0 +1,164 @@
+module Fastlane
+  module Actions
+    class SourcedocsAction < Action
+      def self.run(params)
+        UI.user_error!("You have to install sourcedocs using `brew install sourcedocs`") if `which sourcedocs`.to_s.length == 0 && !Helper.test?
+
+        command =  "sourcedocs generate"
+        command << " --all-modules" if params[:all_modules]
+        command << " --spm-module #{params[:spm_module]}" unless params[:spm_module].nil?
+        command << " --module-name #{params[:module_name]}" unless params[:module_name].nil?
+        command << " --link-beginning #{params[:link_beginning]}" unless params[:link_beginning].nil?
+        command << " --link-ending #{params[:link_ending]}" unless params[:link_ending].nil?
+        command << " --output-folder #{params[:output_folder]}" unless params[:output_folder].nil?
+        command << " --min-acl #{params[:min_acl]}" unless params[:min_acl].nil?
+        command << " --module-name-path" if params[:module_name_path]
+        command << " --clean" if params[:clean]
+        command << " --collapsible" if params[:collapsible]
+        command << " --table-of-contents" if params[:table_of_contents]
+        command << " --reproducible-docs" if params[:reproducible]
+        unless params[:scheme].nil?
+          command << " -- -scheme #{params[:scheme]}"
+          command << " -sdk #{params[:sdk_platform]}" unless params[:sdk_platform].nil?
+        end
+        Actions.sh(command)
+      end
+
+      #####################################################
+      # @!group Documentation
+      #####################################################
+
+      def self.description
+        "Generate docs using SourceDocs"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(
+            key: :all_modules,
+            env_name: 'FL_SOURCEDOCS_OUTPUT_ALL_MODULES',
+            description: 'Generate documentation for all modules in a Swift package',
+            type: Boolean,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :spm_module,
+            env_name: 'FL_SOURCEDOCS_SPM_MODULE',
+            description: 'Generate documentation for Swift Package Manager module',
+            type: String,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :module_name,
+            env_name: 'FL_SOURCEDOCS_MODULE_NAME',
+            description: 'Generate documentation for a Swift module',
+            type: String,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :link_beginning,
+            env_name: 'FL_SOURCEDOCS_LINK_BEGINNING',
+            description: 'The text to begin links with',
+            type: String,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :link_ending,
+            env_name: 'FL_SOURCEDOCS_LINK_ENDING',
+            description: 'The text to end links with (default: .md)',
+            type: String,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :output_folder,
+            env_name: 'FL_SOURCEDOCS_OUTPUT_FOLDER',
+            description: 'Output directory to clean (default: Documentation/Reference)',
+            type: String,
+            optional: false
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :min_acl,
+            env_name: 'FL_SOURCEDOCS_MIN_ACL',
+            description: 'Access level to include in documentation [private, fileprivate, internal, public, open] (default: public)',
+            type: String,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :module_name_path,
+            env_name: 'FL_SOURCEDOCS_MODULE_NAME_PATH',
+            description: 'Include the module name as part of the output folder path',
+            type: Boolean,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :clean,
+            env_name: 'FL_SOURCEDOCS_CLEAN',
+            description: 'Delete output folder before generating documentation',
+            type: Boolean,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :collapsible,
+            env_name: 'FL_SOURCEDOCS_COLLAPSIBLE',
+            description: 'Put methods, properties and enum cases inside collapsible blocks',
+            type: Boolean,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :table_of_contents,
+            env_name: 'FL_SOURCEDOCS_TABLE_OF_CONTENT',
+            description: 'Generate a table of contents with properties and methods for each type',
+            type: Boolean,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :reproducible,
+            env_name: 'FL_SOURCEDOCS_REPRODUCIBLE',
+            description: 'Generate documentation that is reproducible: only depends on the sources',
+            type: Boolean,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :scheme,
+            env_name: 'FL_SOURCEDOCS_SCHEME',
+            description: 'Create documentation for specific scheme',
+            type: String,
+            optional: true
+          ),
+          FastlaneCore::ConfigItem.new(
+            key: :sdk_platform,
+            env_name: 'FL_SOURCEDOCS_SDK_PlATFORM',
+            description: 'Create documentation for specific sdk platform',
+            type: String,
+            optional: true
+          )
+        ]
+      end
+
+      def self.output
+      end
+
+      def self.return_value
+      end
+
+      def self.authors
+        ["Kukurijek"]
+      end
+
+      def self.is_supported?(platform)
+        [:ios, :mac].include?(platform)
+      end
+
+      def self.example_code
+        [
+          "sourcedocs(output_folder: 'docs')",
+          "sourcedocs(output_folder: 'docs', clean: true, reproducible: true, scheme: 'MyApp')"
+        ]
+      end
+
+      def self.category
+        :documentation
+      end
+    end
+  end
+end

data/fastlane/lib/fastlane/setup/setup.rb

@@ -35,6 +35,10 @@ module Fastlane
     # rubocop:disable Metrics/BlockNesting
     def self.start(user: nil, is_swift_fastfile: false)
       if FastlaneCore::FastlaneFolder.setup? && !Helper.test?
+
+        # If Fastfile.swift exists, but the swift sources folder does not, rebuild it
+        setup_swift_support if is_swift_fastfile
+
         require 'fastlane/lane_list'
         Fastlane::LaneList.output(FastlaneCore::FastlaneFolder.fastfile_path)
         UI.important("------------------")
@@ -127,6 +131,24 @@ module Fastlane
     end
     # rubocop:enable Metrics/BlockNesting
 
+    def self.setup_swift_support
+      runner_source_resources = "#{Fastlane::ROOT}/swift/."
+      destination_path = File.expand_path('swift', FastlaneCore::FastlaneFolder.path)
+
+      # Return eearly if already setup
+      return if File.exist?(destination_path)
+
+      # Show message if Fastfile.swift exists but missing Swift classes and Xcode project
+      if FastlaneCore::FastlaneFolder.swift?
+        UI.important("Restoring Swift classes and FastlaneSwiftRunner.xcodeproj...")
+      end
+
+      FileUtils.cp_r(runner_source_resources, destination_path)
+      UI.success("Copied Swift fastlane runner project to '#{destination_path}'.")
+
+      Fastlane::SwiftLaneManager.first_time_setup
+    end
+
     def initialize(is_swift_fastfile: nil, user: nil, project_path: nil, had_multiple_projects_to_choose_from: nil, preferred_setup_method: nil)
       self.is_swift_fastfile = is_swift_fastfile
       self.user = user
@@ -260,21 +282,12 @@ module Fastlane
 
     def finish_up
       write_fastfile!
-      setup_swift_support if is_swift_fastfile
+      self.class.setup_swift_support if is_swift_fastfile
       show_analytics_note
       explain_concepts
       suggest_next_steps
     end
 
-    def setup_swift_support
-      runner_source_resources = "#{Fastlane::ROOT}/swift/."
-      destination_path = File.expand_path('swift', FastlaneCore::FastlaneFolder.path)
-      FileUtils.cp_r(runner_source_resources, destination_path)
-      UI.success("Copied Swift fastlane runner project to '#{destination_path}'.")
-
-      Fastlane::SwiftLaneManager.first_time_setup
-    end
-
     def fastfile_template_content
       if self.is_swift_fastfile
         path = "#{Fastlane::ROOT}/lib/assets/DefaultFastfileTemplate.swift"

data/fastlane/lib/fastlane/swift_runner_upgrader.rb

@@ -29,6 +29,8 @@ module Fastlane
       @source_swift_code_file_folder_path = File.expand_path(File.join(Fastlane::ROOT, "/swift"))
       @target_swift_code_file_folder_path = FastlaneCore::FastlaneFolder.swift_folder_path
 
+      Fastlane::Setup.setup_swift_support
+
       manifest_file = File.join(@source_swift_code_file_folder_path, "/upgrade_manifest.json")
       UI.success("loading manifest: #{manifest_file}")
       @manifest_hash = JSON.parse(File.read(manifest_file))

data/fastlane/lib/fastlane/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
-  VERSION = '2.179.0'.freeze
+  VERSION = '2.180.0'.freeze
   DESCRIPTION = "The easiest way to automate beta deployments and releases for your iOS and Android apps".freeze
   MINIMUM_XCODE_RELEASE = "7.0".freeze
   RUBOCOP_REQUIREMENT = '0.49.1'.freeze

data/fastlane/swift/Deliverfile.swift

@@ -17,4 +17,4 @@ public class Deliverfile: DeliverfileProtocol {
     // during the `init` process, and you won't see this message
 }
 
-// Generated with fastlane 2.179.0
+// Generated with fastlane 2.180.0

data/fastlane/swift/DeliverfileProtocol.swift

@@ -256,4 +256,4 @@ public extension DeliverfileProtocol {
 
 // Please don't remove the lines below
 // They are used to detect outdated files
-// FastlaneRunnerAPIVersion [0.9.62]
+// FastlaneRunnerAPIVersion [0.9.63]

data/fastlane/swift/Fastlane.swift

@@ -4705,30 +4705,36 @@ public func jazzy(config: String? = nil,
 }
 
 /**
- Leave a comment on JIRA tickets
+  Leave a comment on a Jira ticket
 
- - parameters:
-   - url: URL for Jira instance
-   - contextPath: Appends to the url (ex: "/jira")
-   - username: Username for JIRA instance
-   - password: Password for Jira
-   - ticketId: Ticket ID for Jira, i.e. IOS-123
-   - commentText: Text to add to the ticket as a comment
- */
-public func jira(url: String,
-                 contextPath: String = "",
-                 username: String,
-                 password: String,
-                 ticketId: String,
-                 commentText: String)
+  - parameters:
+    - url: URL for Jira instance
+    - contextPath: Appends to the url (ex: "/jira")
+    - username: Username for Jira instance
+    - password: Password or API token for Jira
+    - ticketId: Ticket ID for Jira, i.e. IOS-123
+    - commentText: Text to add to the ticket as a comment
+    - failOnError: Should an error adding the Jira comment cause a failure?
+
+  - returns: A hash containing all relevant information of the Jira comment
+ Access Jira comment 'id', 'author', 'body', and more
+ */
+@discardableResult public func jira(url: String,
+                                    contextPath: String = "",
+                                    username: String,
+                                    password: String,
+                                    ticketId: String,
+                                    commentText: String,
+                                    failOnError: Bool = true) -> [String: Any]
 {
     let command = RubyCommand(commandID: "", methodName: "jira", className: nil, args: [RubyCommand.Argument(name: "url", value: url),
                                                                                         RubyCommand.Argument(name: "context_path", value: contextPath),
                                                                                         RubyCommand.Argument(name: "username", value: username),
                                                                                         RubyCommand.Argument(name: "password", value: password),
                                                                                         RubyCommand.Argument(name: "ticket_id", value: ticketId),
-                                                                                        RubyCommand.Argument(name: "comment_text", value: commentText)])
-    _ = runner.executeCommand(command)
+                                                                                        RubyCommand.Argument(name: "comment_text", value: commentText),
+                                                                                        RubyCommand.Argument(name: "fail_on_error", value: failOnError)])
+    return parseDictionary(fromString: runner.executeCommand(command))
 }
 
 /**
@@ -5302,14 +5308,16 @@ public func nexusUpload(file: String,
    - ascProvider: Provider short name for accounts associated with multiple providers
    - printLog: Whether to print notarization log file, listing issues on failure and warnings on success
    - verbose: Whether to log requests
+   - apiKeyPath: Path to AppStore Connect API key
  */
 public func notarize(package: String,
                      tryEarlyStapling: Bool = false,
                      bundleId: String? = nil,
-                     username: String,
+                     username: String? = nil,
                      ascProvider: String? = nil,
                      printLog: Bool = false,
-                     verbose: Bool = false)
+                     verbose: Bool = false,
+                     apiKeyPath: String? = nil)
 {
     let command = RubyCommand(commandID: "", methodName: "notarize", className: nil, args: [RubyCommand.Argument(name: "package", value: package),
                                                                                             RubyCommand.Argument(name: "try_early_stapling", value: tryEarlyStapling),
@@ -5317,7 +5325,8 @@ public func notarize(package: String,
                                                                                             RubyCommand.Argument(name: "username", value: username),
                                                                                             RubyCommand.Argument(name: "asc_provider", value: ascProvider),
                                                                                             RubyCommand.Argument(name: "print_log", value: printLog),
-                                                                                            RubyCommand.Argument(name: "verbose", value: verbose)])
+                                                                                            RubyCommand.Argument(name: "verbose", value: verbose),
+                                                                                            RubyCommand.Argument(name: "api_key_path", value: apiKeyPath)])
     _ = runner.executeCommand(command)
 }
 
@@ -6411,6 +6420,7 @@ public func rubyVersion() {
    - skipPackageDependenciesResolution: Skips resolution of Swift Package Manager dependencies
    - disablePackageAutomaticUpdates: Prevents packages from automatically being resolved to versions other than those recorded in the `Package.resolved` file
    - useSystemScm: Lets xcodebuild use system's scm configuration
+   - numberOfRetries: The number of times a test can fail before scan should stop retrying
    - failBuild: Should this step stop the build if the tests fail? Set this to false if you're using trainer
 
  More information: https://docs.fastlane.tools/actions/scan/
@@ -6484,6 +6494,7 @@ public func runTests(workspace: String? = nil,
                      skipPackageDependenciesResolution: Bool = false,
                      disablePackageAutomaticUpdates: Bool = false,
                      useSystemScm: Bool = false,
+                     numberOfRetries: Int = 0,
                      failBuild: Bool = true)
 {
     let command = RubyCommand(commandID: "", methodName: "run_tests", className: nil, args: [RubyCommand.Argument(name: "workspace", value: workspace),
@@ -6555,6 +6566,7 @@ public func runTests(workspace: String? = nil,
                                                                                              RubyCommand.Argument(name: "skip_package_dependencies_resolution", value: skipPackageDependenciesResolution),
                                                                                              RubyCommand.Argument(name: "disable_package_automatic_updates", value: disablePackageAutomaticUpdates),
                                                                                              RubyCommand.Argument(name: "use_system_scm", value: useSystemScm),
+                                                                                             RubyCommand.Argument(name: "number_of_retries", value: numberOfRetries),
                                                                                              RubyCommand.Argument(name: "fail_build", value: failBuild)])
     _ = runner.executeCommand(command)
 }
@@ -6708,6 +6720,7 @@ public func say(text: Any,
    - skipPackageDependenciesResolution: Skips resolution of Swift Package Manager dependencies
    - disablePackageAutomaticUpdates: Prevents packages from automatically being resolved to versions other than those recorded in the `Package.resolved` file
    - useSystemScm: Lets xcodebuild use system's scm configuration
+   - numberOfRetries: The number of times a test can fail before scan should stop retrying
    - failBuild: Should this step stop the build if the tests fail? Set this to false if you're using trainer
 
  More information: https://docs.fastlane.tools/actions/scan/
@@ -6781,6 +6794,7 @@ public func scan(workspace: Any? = scanfile.workspace,
                  skipPackageDependenciesResolution: Bool = scanfile.skipPackageDependenciesResolution,
                  disablePackageAutomaticUpdates: Bool = scanfile.disablePackageAutomaticUpdates,
                  useSystemScm: Bool = scanfile.useSystemScm,
+                 numberOfRetries: Int = scanfile.numberOfRetries,
                  failBuild: Bool = scanfile.failBuild)
 {
     let command = RubyCommand(commandID: "", methodName: "scan", className: nil, args: [RubyCommand.Argument(name: "workspace", value: workspace),
@@ -6852,6 +6866,7 @@ public func scan(workspace: Any? = scanfile.workspace,
                                                                                         RubyCommand.Argument(name: "skip_package_dependencies_resolution", value: skipPackageDependenciesResolution),
                                                                                         RubyCommand.Argument(name: "disable_package_automatic_updates", value: disablePackageAutomaticUpdates),
                                                                                         RubyCommand.Argument(name: "use_system_scm", value: useSystemScm),
+                                                                                        RubyCommand.Argument(name: "number_of_retries", value: numberOfRetries),
                                                                                         RubyCommand.Argument(name: "fail_build", value: failBuild)])
     _ = runner.executeCommand(command)
 }
@@ -7740,6 +7755,57 @@ public func sonar(projectConfigurationPath: String? = nil,
     _ = runner.executeCommand(command)
 }
 
+/**
+ Generate docs using SourceDocs
+
+ - parameters:
+   - allModules: Generate documentation for all modules in a Swift package
+   - spmModule: Generate documentation for Swift Package Manager module
+   - moduleName: Generate documentation for a Swift module
+   - linkBeginning: The text to begin links with
+   - linkEnding: The text to end links with (default: .md)
+   - outputFolder: Output directory to clean (default: Documentation/Reference)
+   - minAcl: Access level to include in documentation [private, fileprivate, internal, public, open] (default: public)
+   - moduleNamePath: Include the module name as part of the output folder path
+   - clean: Delete output folder before generating documentation
+   - collapsible: Put methods, properties and enum cases inside collapsible blocks
+   - tableOfContents: Generate a table of contents with properties and methods for each type
+   - reproducible: Generate documentation that is reproducible: only depends on the sources
+   - scheme: Create documentation for specific scheme
+   - sdkPlatform: Create documentation for specific sdk platform
+ */
+public func sourcedocs(allModules: Bool? = nil,
+                       spmModule: String? = nil,
+                       moduleName: String? = nil,
+                       linkBeginning: String? = nil,
+                       linkEnding: String? = nil,
+                       outputFolder: String,
+                       minAcl: String? = nil,
+                       moduleNamePath: Bool? = nil,
+                       clean: Bool? = nil,
+                       collapsible: Bool? = nil,
+                       tableOfContents: Bool? = nil,
+                       reproducible: Bool? = nil,
+                       scheme: String? = nil,
+                       sdkPlatform: String? = nil)
+{
+    let command = RubyCommand(commandID: "", methodName: "sourcedocs", className: nil, args: [RubyCommand.Argument(name: "all_modules", value: allModules),
+                                                                                              RubyCommand.Argument(name: "spm_module", value: spmModule),
+                                                                                              RubyCommand.Argument(name: "module_name", value: moduleName),
+                                                                                              RubyCommand.Argument(name: "link_beginning", value: linkBeginning),
+                                                                                              RubyCommand.Argument(name: "link_ending", value: linkEnding),
+                                                                                              RubyCommand.Argument(name: "output_folder", value: outputFolder),
+                                                                                              RubyCommand.Argument(name: "min_acl", value: minAcl),
+                                                                                              RubyCommand.Argument(name: "module_name_path", value: moduleNamePath),
+                                                                                              RubyCommand.Argument(name: "clean", value: clean),
+                                                                                              RubyCommand.Argument(name: "collapsible", value: collapsible),
+                                                                                              RubyCommand.Argument(name: "table_of_contents", value: tableOfContents),
+                                                                                              RubyCommand.Argument(name: "reproducible", value: reproducible),
+                                                                                              RubyCommand.Argument(name: "scheme", value: scheme),
+                                                                                              RubyCommand.Argument(name: "sdk_platform", value: sdkPlatform)])
+    _ = runner.executeCommand(command)
+}
+
 /**
  Find, print, and copy Spaceship logs
 
@@ -9821,4 +9887,4 @@ public let snapshotfile = Snapshotfile()
 
 // Please don't remove the lines below
 // They are used to detect outdated files
-// FastlaneRunnerAPIVersion [0.9.115]
+// FastlaneRunnerAPIVersion [0.9.116]

data/fastlane/swift/Gymfile.swift

@@ -17,4 +17,4 @@ public class Gymfile: GymfileProtocol {
     // during the `init` process, and you won't see this message
 }
 
-// Generated with fastlane 2.179.0
+// Generated with fastlane 2.180.0