Class: Fastlane::Actions::SetupCircleCiAction

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

Constant Summary

Constants inherited from Fastlane::Action

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

Documentation collapse

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, author, deprecated_notes, 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

.authorsObject


39
40
41
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 39

def self.authors
  ["dantoml"]
end

.available_optionsObject


29
30
31
32
33
34
35
36
37
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 29

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :force,
                                 env_name: "FL_SETUP_CIRCLECI_FORCE",
                                 description: "Force setup, even if not executed by CircleCI",
                                 is_string: false,
                                 default_value: false)
  ]
end

.categoryObject


53
54
55
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 53

def self.category
  :misc
end

.descriptionObject


12
13
14
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 12

def self.description
  "Setup the keychain and match to work with CircleCI"
end

.detailsObject


16
17
18
19
20
21
22
23
24
25
26
27
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 16

def self.details
  list = <<-LIST.markdown_list(true)
    Creates a new temporary keychain for use with match
    Switches match to `readonly` mode to not create new profiles/cert on CI
    Sets up log and test result paths to be easily collectible
  LIST

  [
    list,
    "This action helps with CircleCI integration. Add this to the top of your Fastfile if you use CircleCI."
  ].join("\n")
end

.example_codeObject


47
48
49
50
51
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 47

def self.example_code
  [
    'setup_circle_ci'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:


43
44
45
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 43

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

.run(params) ⇒ Object


4
5
6
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 4

def self.run(params)
  other_action.setup_ci(provider: "circleci", force: params[:force])
end