Class: Fastlane::Actions::BranchReportAction

Inherits:
Action
  • Object
show all
Defined in:
lib/fastlane/plugin/branch/actions/branch_report_action.rb

Class Method Summary collapse

Class Method Details

.authorsObject



21
22
23
24
25
26
# File 'lib/fastlane/plugin/branch/actions/branch_report_action.rb', line 21

def self.authors
  [
    "Branch <[email protected]>",
    "Jimmy Dee <[email protected]>"
  ]
end

.available_optionsObject



40
41
42
43
44
# File 'lib/fastlane/plugin/branch/actions/branch_report_action.rb', line 40

def self.available_options
  BranchIOCLI::Configuration::ReportConfiguration.available_options.map do |option|
    FastlaneCore::ConfigItem.from_branch_option(option)
  end
end

.categoryObject



50
51
52
# File 'lib/fastlane/plugin/branch/actions/branch_report_action.rb', line 50

def self.category
  :project
end

.descriptionObject



17
18
19
# File 'lib/fastlane/plugin/branch/actions/branch_report_action.rb', line 17

def self.description
  "Generate a brief summary or a full build report for your project."
end

.detailsObject



28
29
30
# File 'lib/fastlane/plugin/branch/actions/branch_report_action.rb', line 28

def self.details
  render :report_description
end

.example_codeObject



32
33
34
35
36
37
38
# File 'lib/fastlane/plugin/branch/actions/branch_report_action.rb', line 32

def self.example_code
  [
    "branch_report",
    "branch_report(header_only: true)",
    "branch_report(workspace: \"MyWorkspace.xcworkspace\")"
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean)


46
47
48
# File 'lib/fastlane/plugin/branch/actions/branch_report_action.rb', line 46

def self.is_supported?(platform)
  platform == :ios
end

.run(params) ⇒ Object



10
11
12
13
14
15
# File 'lib/fastlane/plugin/branch/actions/branch_report_action.rb', line 10

def self.run(params)
  config = BranchIOCLI::Configuration::ReportConfiguration.wrapper params, false
  BranchIOCLI::Command::ReportCommand.new(config).run!
rescue StandardError => e
  UI.user_error! "Error in BranchReportAction: #{e.message}\n#{e.backtrace}"
end