Class: Fastlane::Actions::ImportCertificateAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/import_certificate.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, 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 



50
51
52
 
# File 'fastlane/lib/fastlane/actions/import_certificate.rb', line 50

def self.authors
  ["gin0606"]
end

.available_options ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'fastlane/lib/fastlane/actions/import_certificate.rb', line 16

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :certificate_path,
                                 description: "Path to certificate",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :certificate_password,
                                 description: "Certificate password",
                                 sensitive: true,
                                 default_value: "",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :certificate_format,
                                 description: "Format of the certificate. Check the '-f' switch from 'security import --help' command",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :keychain_name,
                                 env_name: "KEYCHAIN_NAME",
                                 description: "Keychain the items should be imported to",
                                 optional: false),
    FastlaneCore::ConfigItem.new(key: :keychain_path,
                                 env_name: "KEYCHAIN_PATH",
                                 description: "Path to the Keychain file to which the items should be imported",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :keychain_password,
                                 env_name: "FL_IMPORT_CERT_KEYCHAIN_PASSWORD",
                                 description: "The password for the keychain. Note that for the login keychain this is your user's password",
                                 sensitive: true,
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :log_output,
                                 description: "If output should be logged to the console",
                                 type: Boolean,
                                 default_value: false,
                                 optional: true)
  ]
end

.category ⇒ Object 



80
81
82
 
# File 'fastlane/lib/fastlane/actions/import_certificate.rb', line 80

def self.category
  :code_signing
end

.description ⇒ Object 



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

def self.description
  "Import certificate from inputfile into a keychain"
end

.details ⇒ Object 



58
59
60
 
# File 'fastlane/lib/fastlane/actions/import_certificate.rb', line 58

def self.details
  "Import certificates (and private keys) into the current default keychain. Use the `create_keychain` action to create a new keychain."
end

.example_code ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'fastlane/lib/fastlane/actions/import_certificate.rb', line 62

def self.example_code
  [
    'import_certificate(certificate_path: "certs/AppleWWDRCA6.cer")',
    'import_certificate(
      certificate_path: "certs/dist.p12",
      certificate_password: ENV["CERTIFICATE_PASSWORD"] || "default"
    )',
    'import_certificate(
      certificate_path: "certs/development.cer"
    )',
    'import_certificate(
      certificate_path: "certs/dist.p12",
      certificate_password: ENV["CERTIFICATE_PASSWORD"] || "default",
      certificate_format: "pkcs12"
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:



54
55
56
 
# File 'fastlane/lib/fastlane/actions/import_certificate.rb', line 54

def self.is_supported?(platform)
  true
end

.run(params) ⇒ Object 



6
7
8
9
10
 
# File 'fastlane/lib/fastlane/actions/import_certificate.rb', line 6

def self.run(params)
  keychain_path = params[:keychain_path] || FastlaneCore::Helper.keychain_path(params[:keychain_name])

  FastlaneCore::KeychainImporter.import_file(params[:certificate_path], keychain_path, keychain_password: params[:keychain_password], certificate_password: params[:certificate_password], certificate_format: params[:certificate_format], output: params[:log_output])
end