Class: Fastlane::Actions::XccleanAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/xcodebuild.rb

Constant Summary

Constants inherited from Fastlane::Action

Fastlane::Action::AVAILABLE_CATEGORIES, Fastlane::Action::RETURN_TYPES

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, deprecated_notes, details, lane_context, method_missing, other_action, output, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.author ⇒ Object 



518
519
520
 
# File 'fastlane/lib/fastlane/actions/xcodebuild.rb', line 518

def self.author
  "dtrenz"
end

.available_options ⇒ Object 



526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
 
# File 'fastlane/lib/fastlane/actions/xcodebuild.rb', line 526

def self.available_options
  [
    ['archive', 'Set to true to build archive'],
    ['archive_path', 'The path to archive the to. Must contain `.xcarchive`'],
    ['workspace', 'The workspace to use'],
    ['scheme', 'The scheme to build'],
    ['build_settings', 'Hash of additional build information'],
    ['xcargs', 'Pass additional xcodebuild options'],
    ['output_style', 'Set the output format to one of: :standard (Colored UTF8 output, default), :basic (black & white ASCII output)'],
    ['xcodebuild_architecture', 'Allows to set the architecture that `xcodebuild` is run with, for example to force it to run under Rosetta on an Apple Silicon mac'],
    ['buildlog_path', 'The path where the xcodebuild.log will be created, by default it is created in ~/Library/Logs/fastlane/xcbuild'],
    ['raw_buildlog', 'Set to true to see xcodebuild raw output. Default value is false'],
    ['xcpretty_output', 'specifies the output type for xcpretty. eg. \'test\', or \'simple\''],
    ['xcpretty_utf', 'Specifies xcpretty should use utf8 when reporting builds. This has no effect when raw_buildlog is specified.']
  ]
end

.category ⇒ Object 



514
515
516
 
# File 'fastlane/lib/fastlane/actions/xcodebuild.rb', line 514

def self.category
  :building
end

.description ⇒ Object 



504
505
506
 
# File 'fastlane/lib/fastlane/actions/xcodebuild.rb', line 504

def self.description
  "Cleans the project using `xcodebuild`"
end

.example_code ⇒ Object 



508
509
510
511
512
 
# File 'fastlane/lib/fastlane/actions/xcodebuild.rb', line 508

def self.example_code
  [
    'xcclean'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



522
523
524
 
# File 'fastlane/lib/fastlane/actions/xcodebuild.rb', line 522

def self.is_supported?(platform)
  [:ios, :mac].include? platform
end

.run(params) ⇒ Object 



498
499
500
501
502
 
# File 'fastlane/lib/fastlane/actions/xcodebuild.rb', line 498

def self.run(params)
  params_hash = params || {}
  params_hash[:clean] = true
  XcodebuildAction.run(params_hash)
end