Class: Match::Options
- Inherits:
-
Object
- Object
- Match::Options
- Defined in:
- match/lib/match/options.rb
Overview
rubocop:disable Metrics/ClassLength
Class Method Summary collapse
-
.append_option(option) ⇒ Object
This is match specific, as users can append storage specific options.
- .available_options ⇒ Object
- .default_platform ⇒ Object
Class Method Details
.append_option(option) ⇒ Object
This is match specific, as users can append storage specific options
10 11 12 13 |
# File 'match/lib/match/options.rb', line 10 def self.append_option(option) self. # to ensure we created the initial `@available_options` array @available_options << option end |
.available_options ⇒ Object
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 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 |
# File 'match/lib/match/options.rb', line 24 def self. user = CredentialsManager::AppfileConfig.try_fetch_value(:apple_dev_portal_id) user ||= CredentialsManager::AppfileConfig.try_fetch_value(:apple_id) [ # main FastlaneCore::ConfigItem.new(key: :type, env_name: "MATCH_TYPE", description: "Define the profile type, can be #{Match.environments.join(', ')}", short_option: "-y", default_value: 'development', verify_block: proc do |value| unless Match.environments.include?(value) UI.user_error!("Unsupported environment #{value}, must be in #{Match.environments.join(', ')}") end end), FastlaneCore::ConfigItem.new(key: :additional_cert_types, env_name: "MATCH_ADDITIONAL_CERT_TYPES", description: "Create additional cert types needed for macOS installers (valid values: mac_installer_distribution, developer_id_installer)", optional: true, type: Array, verify_block: proc do |values| types = %w(mac_installer_distribution developer_id_installer) UI.user_error!("Unsupported types, must be: #{types}") unless (values - types).empty? end), FastlaneCore::ConfigItem.new(key: :readonly, env_name: "MATCH_READONLY", description: "Only fetch existing certificates and profiles, don't generate new ones", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :generate_apple_certs, env_name: "MATCH_GENERATE_APPLE_CERTS", description: "Create a certificate type for Xcode 11 and later (Apple Development or Apple Distribution)", type: Boolean, default_value: FastlaneCore::Helper.mac? && FastlaneCore::Helper.xcode_at_least?('11'), default_value_dynamic: true), FastlaneCore::ConfigItem.new(key: :skip_provisioning_profiles, env_name: "MATCH_SKIP_PROVISIONING_PROFILES", description: "Skip syncing provisioning profiles", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :app_identifier, short_option: "-a", env_name: "MATCH_APP_IDENTIFIER", description: "The bundle identifier(s) of your app (comma-separated string or array of strings)", type: Array, # we actually allow String and Array here skip_type_validation: true, code_gen_sensitive: true, default_value: CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier), default_value_dynamic: true), # App Store Connect API FastlaneCore::ConfigItem.new(key: :api_key_path, env_names: ["SIGH_API_KEY_PATH", "APP_STORE_CONNECT_API_KEY_PATH"], description: "Path to your App Store Connect API Key JSON file (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-json-file)", optional: true, conflicting_options: [:api_key], verify_block: proc do |value| UI.user_error!("Couldn't find API key JSON file at path '#{value}'") unless File.exist?(value) end), FastlaneCore::ConfigItem.new(key: :api_key, env_names: ["SIGH_API_KEY", "APP_STORE_CONNECT_API_KEY"], description: "Your App Store Connect API Key information (https://docs.fastlane.tools/app-store-connect-api/#using-fastlane-api-key-hash-option)", type: Hash, optional: true, sensitive: true, conflicting_options: [:api_key_path]), # Apple ID FastlaneCore::ConfigItem.new(key: :username, short_option: "-u", env_name: "MATCH_USERNAME", description: "Your Apple ID Username", optional: true, default_value: user, default_value_dynamic: true), FastlaneCore::ConfigItem.new(key: :team_id, short_option: "-b", env_name: "FASTLANE_TEAM_ID", description: "The ID of your Developer Portal team if you're in multiple teams", optional: true, code_gen_sensitive: true, default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_id), default_value_dynamic: true), FastlaneCore::ConfigItem.new(key: :team_name, short_option: "-l", env_name: "FASTLANE_TEAM_NAME", description: "The name of your Developer Portal team if you're in multiple teams", optional: true, code_gen_sensitive: true, default_value: CredentialsManager::AppfileConfig.try_fetch_value(:team_name), default_value_dynamic: true), # Storage FastlaneCore::ConfigItem.new(key: :storage_mode, env_name: "MATCH_STORAGE_MODE", description: "Define where you want to store your certificates", short_option: "-q", default_value: 'git', verify_block: proc do |value| unless Match.storage_modes.include?(value) UI.user_error!("Unsupported storage_mode #{value}, must be in #{Match.storage_modes.join(', ')}") end end), # Storage: Git FastlaneCore::ConfigItem.new(key: :git_url, env_name: "MATCH_GIT_URL", description: "URL to the git repo containing all the certificates", optional: false, short_option: "-r"), FastlaneCore::ConfigItem.new(key: :git_branch, env_name: "MATCH_GIT_BRANCH", description: "Specific git branch to use", default_value: 'master'), FastlaneCore::ConfigItem.new(key: :git_full_name, env_name: "MATCH_GIT_FULL_NAME", description: "git user full name to commit", optional: true, default_value: nil), FastlaneCore::ConfigItem.new(key: :git_user_email, env_name: "MATCH_GIT_USER_EMAIL", description: "git user email to commit", optional: true, default_value: nil), FastlaneCore::ConfigItem.new(key: :shallow_clone, env_name: "MATCH_SHALLOW_CLONE", description: "Make a shallow clone of the repository (truncate the history to 1 revision)", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :clone_branch_directly, env_name: "MATCH_CLONE_BRANCH_DIRECTLY", description: "Clone just the branch specified, instead of the whole repo. This requires that the branch already exists. Otherwise the command will fail", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :git_basic_authorization, env_name: "MATCH_GIT_BASIC_AUTHORIZATION", sensitive: true, description: "Use a basic authorization header to access the git repo (e.g.: access via HTTPS, GitHub Actions, etc), usually a string in Base64", conflicting_options: [:git_bearer_authorization, :git_private_key], optional: true, default_value: nil), FastlaneCore::ConfigItem.new(key: :git_bearer_authorization, env_name: "MATCH_GIT_BEARER_AUTHORIZATION", sensitive: true, description: "Use a bearer authorization header to access the git repo (e.g.: access to an Azure DevOps repository), usually a string in Base64", conflicting_options: [:git_basic_authorization, :git_private_key], optional: true, default_value: nil), FastlaneCore::ConfigItem.new(key: :git_private_key, env_name: "MATCH_GIT_PRIVATE_KEY", sensitive: true, description: "Use a private key to access the git repo (e.g.: access to GitHub repository via Deploy keys), usually a id_rsa named file or the contents hereof", conflicting_options: [:git_basic_authorization, :git_bearer_authorization], optional: true, default_value: nil), # Storage: Google Cloud FastlaneCore::ConfigItem.new(key: :google_cloud_bucket_name, env_name: "MATCH_GOOGLE_CLOUD_BUCKET_NAME", description: "Name of the Google Cloud Storage bucket to use", optional: true), FastlaneCore::ConfigItem.new(key: :google_cloud_keys_file, env_name: "MATCH_GOOGLE_CLOUD_KEYS_FILE", description: "Path to the gc_keys.json file", optional: true, verify_block: proc do |value| UI.user_error!("Could not find keys file at path '#{File.(value)}'") unless File.exist?(value) end), FastlaneCore::ConfigItem.new(key: :google_cloud_project_id, env_name: "MATCH_GOOGLE_CLOUD_PROJECT_ID", description: "ID of the Google Cloud project to use for authentication", optional: true), FastlaneCore::ConfigItem.new(key: :skip_google_cloud_account_confirmation, env_name: "MATCH_SKIP_GOOGLE_CLOUD_ACCOUNT_CONFIRMATION", description: "Skips confirming to use the system google account", type: Boolean, default_value: false), # Storage: S3 FastlaneCore::ConfigItem.new(key: :s3_region, env_name: "MATCH_S3_REGION", description: "Name of the S3 region", optional: true), FastlaneCore::ConfigItem.new(key: :s3_access_key, env_name: "MATCH_S3_ACCESS_KEY", description: "S3 access key", optional: true), FastlaneCore::ConfigItem.new(key: :s3_secret_access_key, env_name: "MATCH_S3_SECRET_ACCESS_KEY", description: "S3 secret access key", sensitive: true, optional: true), FastlaneCore::ConfigItem.new(key: :s3_bucket, env_name: "MATCH_S3_BUCKET", description: "Name of the S3 bucket", optional: true), FastlaneCore::ConfigItem.new(key: :s3_object_prefix, env_name: "MATCH_S3_OBJECT_PREFIX", description: "Prefix to be used on all objects uploaded to S3", optional: true), FastlaneCore::ConfigItem.new(key: :s3_skip_encryption, env_name: "MATCH_S3_SKIP_ENCRYPTION", description: "Skip encryption of all objects uploaded to S3. WARNING: only enable this on S3 buckets with sufficiently restricted permissions and server-side encryption enabled. See https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingEncryption.html", type: Boolean, default_value: false), # Storage: GitLab Secure Files FastlaneCore::ConfigItem.new(key: :gitlab_project, env_name: "MATCH_GITLAB_PROJECT", description: "GitLab Project Path (i.e. 'gitlab-org/gitlab')", optional: true), FastlaneCore::ConfigItem.new(key: :gitlab_host, env_name: "MATCH_GITLAB_HOST", default_value: 'https://gitlab.com', description: "GitLab Host (i.e. 'https://gitlab.com')", optional: true), FastlaneCore::ConfigItem.new(key: :job_token, env_name: "CI_JOB_TOKEN", description: "GitLab CI_JOB_TOKEN", optional: true), FastlaneCore::ConfigItem.new(key: :private_token, env_name: "PRIVATE_TOKEN", description: "GitLab Access Token", optional: true), # Keychain FastlaneCore::ConfigItem.new(key: :keychain_name, short_option: "-s", env_name: "MATCH_KEYCHAIN_NAME", description: "Keychain the items should be imported to", default_value: "login.keychain"), FastlaneCore::ConfigItem.new(key: :keychain_password, short_option: "-p", env_name: "MATCH_KEYCHAIN_PASSWORD", sensitive: true, description: "This might be required the first time you access certificates on a new mac. For the login/default keychain this is your macOS account password", optional: true), # settings FastlaneCore::ConfigItem.new(key: :force, env_name: "MATCH_FORCE", description: "Renew the provisioning profiles every time you run match", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :force_for_new_devices, env_name: "MATCH_FORCE_FOR_NEW_DEVICES", description: "Renew the provisioning profiles if the device count on the developer portal has changed. Ignored for profile types 'appstore' and 'developer_id'", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :include_mac_in_profiles, env_name: "MATCH_INCLUDE_MAC_IN_PROFILES", description: "Include Apple Silicon Mac devices in provisioning profiles for iOS/iPadOS apps", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :include_all_certificates, env_name: "MATCH_INCLUDE_ALL_CERTIFICATES", description: "Include all matching certificates in the provisioning profile. Works only for the 'development' provisioning profile type", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :certificate_id, env_name: "MATCH_CERTIFICATE_ID", description: "Select certificate by id. Useful if multiple certificates are stored in one place", type: String, optional: true), FastlaneCore::ConfigItem.new(key: :force_for_new_certificates, env_name: "MATCH_FORCE_FOR_NEW_CERTIFICATES", description: "Renew the provisioning profiles if the certificate count on the developer portal has changed. Works only for the 'development' provisioning profile type. Requires 'include_all_certificates' option to be 'true'", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :skip_confirmation, env_name: "MATCH_SKIP_CONFIRMATION", description: "Disables confirmation prompts during nuke, answering them with yes", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :safe_remove_certs, env_name: "MATCH_SAFE_REMOVE_CERTS", description: "Remove certs from repository during nuke without revoking them on the developer portal", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :skip_docs, env_name: "MATCH_SKIP_DOCS", description: "Skip generation of a README.md for the created git repository", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :platform, short_option: '-o', env_name: "MATCH_PLATFORM", description: "Set the provisioning profile's platform to work with (i.e. ios, tvos, macos, catalyst)", default_value: default_platform, default_value_dynamic: true, verify_block: proc do |value| value = value.to_s pt = %w(tvos ios macos catalyst) UI.user_error!("Unsupported platform, must be: #{pt}") unless pt.include?(value) end), FastlaneCore::ConfigItem.new(key: :derive_catalyst_app_identifier, env_name: "MATCH_DERIVE_CATALYST_APP_IDENTIFIER", description: "Enable this if you have the Mac Catalyst capability enabled and your project was created with Xcode 11.3 or earlier. Prepends 'maccatalyst.' to the app identifier for the provisioning profile mapping", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :template_name, env_name: "MATCH_PROVISIONING_PROFILE_TEMPLATE_NAME", description: "The name of provisioning profile template. If the developer account has provisioning profile templates (aka: custom entitlements), the template name can be found by inspecting the Entitlements drop-down while creating/editing a provisioning profile (e.g. \"Apple Pay Pass Suppression Development\")", optional: true, default_value: nil), FastlaneCore::ConfigItem.new(key: :profile_name, env_name: "MATCH_PROVISIONING_PROFILE_NAME", description: "A custom name for the provisioning profile. This will replace the default provisioning profile name if specified", optional: true, default_value: nil), FastlaneCore::ConfigItem.new(key: :fail_on_name_taken, env_name: "MATCH_FAIL_ON_NAME_TAKEN", description: "Should the command fail if it was about to create a duplicate of an existing provisioning profile. It can happen due to issues on Apple Developer Portal, when profile to be recreated was not properly deleted first", optional: true, type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :skip_certificate_matching, env_name: "MATCH_SKIP_CERTIFICATE_MATCHING", description: "Set to true if there is no access to Apple developer portal but there are certificates, keys and profiles provided. Only works with match import action", optional: true, type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :output_path, env_name: "MATCH_OUTPUT_PATH", description: "Path in which to export certificates, key and profile", optional: true), FastlaneCore::ConfigItem.new(key: :skip_set_partition_list, short_option: "-P", env_name: "MATCH_SKIP_SET_PARTITION_LIST", description: "Skips setting the partition list (which can sometimes take a long time). Setting the partition list is usually needed to prevent Xcode from prompting to allow a cert to be used for signing", type: Boolean, default_value: false), FastlaneCore::ConfigItem.new(key: :force_legacy_encryption, env_name: "MATCH_FORCE_LEGACY_ENCRYPTION", description: "Force encryption to use legacy cbc algorithm for backwards compatibility with older match versions", type: Boolean, default_value: false), # other FastlaneCore::ConfigItem.new(key: :verbose, env_name: "MATCH_VERBOSE", description: "Print out extra information and all commands", type: Boolean, default_value: false, verify_block: proc do |value| FastlaneCore::Globals.verbose = true if value end) ] end |
.default_platform ⇒ Object
15 16 17 18 19 20 21 22 |
# File 'match/lib/match/options.rb', line 15 def self.default_platform case Fastlane::Helper::LaneHelper.current_platform.to_s when "mac" "macos" else "ios" end end |