Class: Fastlane::Actions::UpdateKeychainAccessGroupsAction

Inherits:
Fastlane::Action show all
Defined in:
fastlane/lib/fastlane/actions/update_keychain_access_groups.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, return_type, return_value, sample_return_value, shell_out_should_use_bundle_exec?, step_text

Class Method Details

.authorsObject


72
73
74
# File 'fastlane/lib/fastlane/actions/update_keychain_access_groups.rb', line 72

def self.authors
  ["yutae"]
end

.available_optionsObject


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'fastlane/lib/fastlane/actions/update_keychain_access_groups.rb', line 47

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :entitlements_file,
                                 env_name: "FL_UPDATE_KEYCHAIN_ACCESS_GROUPS_ENTITLEMENTS_FILE_PATH", # The name of the environment variable
                                 description: "The path to the entitlement file which contains the keychain access groups", # a short description of this parameter
                                 verify_block: proc do |value|
                                   UI.user_error!("Please pass a path to an entitlements file. ") unless value.include?(".entitlements")
                                   UI.user_error!("Could not find entitlements file") if !File.exist?(value) && !Helper.test?
                                 end),
    FastlaneCore::ConfigItem.new(key: :identifiers,
                                 env_name: "FL_UPDATE_KEYCHAIN_ACCESS_GROUPS_IDENTIFIERS",
                                 description: "An Array of unique identifiers for the keychain access groups. Eg. ['your.keychain.access.groups.identifiers']",
                                 is_string: false,
                                 verify_block: proc do |value|
                                   UI.user_error!("The parameter identifiers need to be an Array.") unless value.kind_of?(Array)
                                 end)
  ]
end

.categoryObject


89
90
91
# File 'fastlane/lib/fastlane/actions/update_keychain_access_groups.rb', line 89

def self.category
  :project
end

.descriptionObject


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

def self.description
  "This action changes the keychain access groups in the entitlements file"
end

.detailsObject


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

def self.details
  "Updates the Keychain Group Access Groups in the given Entitlements file, so you can have keychain access groups for the app store build and keychain access groups for an enterprise build."
end

.example_codeObject


80
81
82
83
84
85
86
87
# File 'fastlane/lib/fastlane/actions/update_keychain_access_groups.rb', line 80

def self.example_code
  [
    'update_keychain_access_groups(
      entitlements_file: "/path/to/entitlements_file.entitlements",
      identifiers: ["your.keychain.access.groups.identifiers"]
    )'
  ]
end

.is_supported?(platform) ⇒ Boolean

Returns:


76
77
78
# File 'fastlane/lib/fastlane/actions/update_keychain_access_groups.rb', line 76

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

.outputObject


66
67
68
69
70
# File 'fastlane/lib/fastlane/actions/update_keychain_access_groups.rb', line 66

def self.output
  [
    ['KEYCHAIN_ACCESS_GROUPS', 'The new Keychain Access Groups']
  ]
end

.run(params) ⇒ Object


10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# File 'fastlane/lib/fastlane/actions/update_keychain_access_groups.rb', line 10

def self.run(params)
  UI.message("Entitlements File: #{params[:entitlements_file]}")
  UI.message("New keychain access groups: #{params[:identifiers]}")

  entitlements_file = params[:entitlements_file]
  UI.user_error!("Could not find entitlements file at path '#{entitlements_file}'") unless File.exist?(entitlements_file)

  # parse entitlements
  result = Plist.parse_xml(entitlements_file)
  UI.user_error!("Entitlements file at '#{entitlements_file}' cannot be parsed.") unless result

  # keychain access groups key
  keychain_access_groups_key = 'keychain-access-groups'

  # get keychain access groups
  keychain_access_groups_field = result[keychain_access_groups_key]
  UI.user_error!("No existing keychain access groups field specified. Please specify an keychain access groups in the entitlements file.") unless keychain_access_groups_field

  # set new keychain access groups
  UI.message("Old keychain access groups: #{keychain_access_groups_field}")
  result[keychain_access_groups_key] = params[:identifiers]

  # save entitlements file
  result.save_plist(entitlements_file)
  UI.message("New keychain access groups: #{result[keychain_access_groups_key]}")

  Actions.lane_context[SharedValues::KEYCHAIN_ACCESS_GROUPS] = result[keychain_access_groups_key]
end