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

.authors ⇒ Object 



86
87
88
 
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 86

def self.authors
  ["dantoml"]
end

.available_options ⇒ Object 



76
77
78
79
80
81
82
83
84
 
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 76

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

.category ⇒ Object 



100
101
102
 
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 100

def self.category
  :misc
end

.description ⇒ Object 



59
60
61
 
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 59

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

.details ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 63

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_code ⇒ Object 



94
95
96
97
98
 
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 94

def self.example_code
  [
    'setup_circle_ci'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



90
91
92
 
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 90

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

.run(params) ⇒ Object 



4
5
6
7
8
9
10
11
12
 
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 4

def self.run(params)
  unless should_run?(params)
    UI.message("Not running on CI, skipping `setup_circle_ci`")
    return
  end

  setup_keychain
  setup_output_paths(params)
end

.setup_keychain ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 27

def self.setup_keychain
  unless ENV["MATCH_KEYCHAIN_NAME"].nil?
    UI.message("Skipping Keychain setup as a keychain was already specified")
    return
  end

  keychain_name = "fastlane_tmp_keychain"
  ENV["MATCH_KEYCHAIN_NAME"] = keychain_name
  ENV["MATCH_KEYCHAIN_PASSWORD"] = ""

  UI.message("Creating temporary keychain: \"#{keychain_name}\".")
  Actions::CreateKeychainAction.run(
    name: keychain_name,
    default_keychain: true,
    unlock: true,
    timeout: 3600,
    lock_when_sleeps: true,
    password: ""
  )

  UI.message("Enabling match readonly mode.")
  ENV["MATCH_READONLY"] = true.to_s
end

.setup_output_paths(params) ⇒ Object 



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

def self.setup_output_paths(params)
  unless ENV["FL_OUTPUT_DIR"]
    UI.message("Skipping Log Path setup as FL_OUTPUT_DIR is unset")
    return
  end

  root = Pathname.new(ENV["FL_OUTPUT_DIR"])
  ENV["SCAN_OUTPUT_DIRECTORY"] = (root + "scan").to_s
  ENV["GYM_OUTPUT_DIRECTORY"] = (root + "gym").to_s
  ENV["FL_BUILDLOG_PATH"] = (root + "buildlogs").to_s
  ENV["SCAN_INCLUDE_SIMULATOR_LOGS"] = true.to_s
end

.should_run?(params) ⇒ Boolean

Returns:



51
52
53
 
# File 'fastlane/lib/fastlane/actions/setup_circle_ci.rb', line 51

def self.should_run?(params)
  Helper.ci? || params[:force]
end