-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathstep.yml
executable file
·315 lines (270 loc) · 15.2 KB
/
step.yml
1
2
3
4
5
6
7
8
9
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
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
title: Export iOS and tvOS Xcode archive
summary: Export iOS and tvOS IPA from an existing Xcode archive
description: |-
Exports an IPA from an existing iOS and tvOS `.xcarchive` file. You can add multiple **Export iOS and tvOS Xcode archive** Steps to your Workflows to create multiple different signed .ipa files.
The Step also logs you into your Apple Developer account based on the [Apple service connection you provide on Bitrise](https://devcenter.bitrise.io/en/accounts/connecting-to-services/apple-services-connection.html) and downloads any provisioning profiles needed for your project based on the **Distribution method**.
### Configuring the Step
Before you start:
- Make sure you have connected your [Apple Service account to Bitrise](https://devcenter.bitrise.io/en/accounts/connecting-to-services/apple-services-connection.html).
Alternatively, you can upload certificates and profiles to Bitrise manually, then use the Certificate and Profile installer step before Xcode Archive
- Make sure certificates are uploaded to Bitrise's **Code Signing** tab. The right provisioning profiles are automatically downloaded from Apple as part of the automatic code signing process.
To configure the Step:
1. **Archive Path**: Specifies the archive that should be exported. The input value sets xcodebuild's `-archivePath` option.
2. **Select a product to distribute**: Decide if an App or an App Clip IPA should be exported.
3. **Distribution method**: Describes how Xcode should export the archive: development, app-store, ad-hoc, or enterprise.
Under **Automatic code signing**:
1. **Automatic code signing method**: Select the Apple service connection you want to use for code signing. Available options: `off` if you don't do automatic code signing, `api-key` [if you use API key authorization](https://devcenter.bitrise.io/en/accounts/connecting-to-services/connecting-to-an-apple-service-with-api-key.html), and `apple-id` [if you use Apple ID authorization](https://devcenter.bitrise.io/en/accounts/connecting-to-services/connecting-to-an-apple-service-with-apple-id.html).
2. **Register test devices on the Apple Developer Portal**: If this input is set, the Step will register the known test devices on Bitrise from team members with the Apple Developer Portal. Note that setting this to `yes` may cause devices to be registered against your limited quantity of test devices in the Apple Developer Portal, which can only be removed once annually during your renewal window.
3. **The minimum days the Provisioning Profile should be valid**: If this input is set to >0, the managed Provisioning Profile will be renewed if it expires within the configured number of days. Otherwise the Step renews the managed Provisioning Profile if it is expired.
4. The **Code signing certificate URL**, the **Code signing certificate passphrase**, the **Keychain path**, and the **Keychain password** inputs are automatically populated if certificates are uploaded to Bitrise's **Code Signing** tab. If you store your files in a private repo, you can manually edit these fields.
If you want to set the Apple service connection credentials on the step-level (instead of using the one configured in the App Settings), use the Step inputs in the **App Store Connect connection override** category. Note that this only works if **Automatic code signing method** is set to `api-key`.
Under **IPA export configuration**:
1. **Developer Portal team**: Add the Developer Portal team's name to use for this export. This input defaults to the team used to build the archive.
2. **Rebuild from bitcode**: For non-App Store exports, should Xcode re-compile the app from bitcode?
3. **Include bitcode**: For App Store exports, should the package include bitcode?
4. **iCloud container environment**: If the app is using CloudKit, this input configures the `com.apple.developer.icloud-container-environment` entitlement. Available options vary depending on the type of provisioning profile used, but may include: `Development` and `Production`.
5. **Export options plist content**: Specifies a `plist` file content that configures archive exporting. If not specified, the Step will auto-generate it.
Under Debugging:
1. **Verbose logging***: You can set this input to `yes` to produce more informative logs.
website: https://github.com/bitrise-steplib/steps-export-xcarchive
source_code_url: https://github.com/bitrise-steplib/steps-export-xcarchive
support_url: https://github.com/bitrise-steplib/steps-export-xcarchive/issues
project_type_tags:
- ios
- cordova
- ionic
- react-native
- flutter
- xamarin
type_tags:
- utility
is_always_run: false
is_skippable: false
toolkit:
go:
package_name: github.com/bitrise-steplib/steps-export-xcarchive
inputs:
- archive_path: $BITRISE_XCARCHIVE_PATH
opts:
title: Archive path
summary: Specifies the archive that should be exported.
description: |-
Specifies the archive that should be exported.
The input value sets xcodebuild's `-archivePath` option.
is_required: true
- product: app
opts:
title: Select a product to distribute
summary: Describes which product to export.
value_options:
- app
- app-clip
is_required: true
- distribution_method: development
opts:
title: Distribution method
summary: Describes how Xcode should export the archive.
value_options:
- development
- app-store
- ad-hoc
- enterprise
is_required: true
# Automatic code signing
- automatic_code_signing: "off"
opts:
category: Automatic code signing
title: Automatic code signing method
summary: This input determines which Bitrise Apple service connection should be used for automatic code signing.
description: |-
This input determines which Bitrise Apple service connection should be used for automatic code signing.
Available values:
- `off`: Do not do any auto code signing.
- `api-key`: [Bitrise Apple Service connection with API Key](https://devcenter.bitrise.io/getting-started/connecting-to-services/setting-up-connection-to-an-apple-service-with-api-key/).
- `apple-id`: [Bitrise Apple Service connection with Apple ID](https://devcenter.bitrise.io/getting-started/connecting-to-services/connecting-to-an-apple-service-with-apple-id/).
value_options:
- "off"
- api-key
- apple-id
is_required: true
- register_test_devices: "no"
opts:
category: Automatic code signing
title: Register test devices on the Apple Developer Portal
summary: If this input is set, the Step will register the known test devices on Bitrise from team members with the Apple Developer Portal.
description: |-
If this input is set, the Step will register the known test devices on Bitrise from team members with the Apple Developer Portal.
Note that setting this to yes may cause devices to be registered against your limited quantity of test devices in the Apple Developer Portal, which can only be removed once annually during your renewal window.
value_options:
- "yes"
- "no"
is_required: true
- test_device_list_path:
opts:
category: Automatic code signing
title: Path of file containing the devices to be registered
summary: If this input is set, the Step will register the listed devices from this file with the Apple Developer Portal.
description: |-
If this input is set, the Step will register the listed devices from this file with the Apple Developer Portal.
The format of the file is a comma separated list of the identifiers. For example:
`00000000–0000000000000001,00000000–0000000000000002,00000000–0000000000000003`
And in the above example the registered devices appear with the name of `Device 1`, `Device 2` and `Device 3` in the Apple Developer Portal.
Note that setting this will have a higher priority than the Bitrise provided devices list.
- min_profile_validity: "0"
opts:
category: Automatic code signing
title: The minimum days the Provisioning Profile should be valid
summary: If this input is set to >0, the managed Provisioning Profile will be renewed if it expires within the configured number of days.
description: |-
If this input is set to >0, the managed Provisioning Profile will be renewed if it expires within the configured number of days.
Otherwise the Step renews the managed Provisioning Profile if it is expired.
is_required: true
- certificate_url_list: $BITRISE_CERTIFICATE_URL
opts:
category: Automatic code signing
title: Code signing certificate URL
summary: URL of the code signing certificate to download.
description: |-
URL of the code signing certificate to download.
Multiple URLs can be specified, separated by a pipe (`|`) character.
Local file path can be specified, using the `file://` URL scheme.
is_required: true
is_sensitive: true
- passphrase_list: $BITRISE_CERTIFICATE_PASSPHRASE
opts:
category: Automatic code signing
title: Code signing certificate passphrase
summary: Passphrases for the provided code signing certificates.
description: |-
Passphrases for the provided code signing certificates.
Specify as many passphrases as many Code signing certificate URL provided, separated by a pipe (`|`) character.
Certificates without a passphrase: for using a single certificate, leave this step input empty. For multiple certificates, use the separator as if there was a passphrase (examples: `pass|`, `|pass|`, `|`)
is_required: false # A single cert with an empty passphrase is allowed too
is_sensitive: true
- keychain_path: $HOME/Library/Keychains/login.keychain
opts:
category: Automatic code signing
title: Keychain path
summary: Path to the Keychain where the code signing certificates will be installed.
is_required: true
is_dont_change_value: true
- keychain_password: $BITRISE_KEYCHAIN_PASSWORD
opts:
category: Automatic code signing
title: Keychain password
summary: Password for the provided Keychain.
is_required: true
is_sensitive: true
is_dont_change_value: true
# IPA export configuration
- export_development_team:
opts:
category: IPA export configuration
title: Developer Portal team
summary: The Developer Portal team to use for this export.
description: |-
The Developer Portal team to use for this export.
Defaults to the team used to build the archive.
Defining this is also required when Automatic Code Signing is set to `apple-id` and the connected account belongs to multiple teams.
- compile_bitcode: "yes"
opts:
category: IPA export configuration
title: Rebuild from bitcode
summary: For __non-App Store__ exports, should Xcode re-compile the app from bitcode?
value_options:
- "yes"
- "no"
is_required: true
- upload_bitcode: "yes"
opts:
category: IPA export configuration
title: Include bitcode
summary: For __App Store__ exports, should the package include bitcode?
value_options:
- "yes"
- "no"
is_required: true
- manage_version_and_build_number: "no"
opts:
category: IPA export configuration
title: Xcode manage version and build number (App Store Connect)
summary: Should Xcode manage the app's build number when uploading to App Store Connect. This will change the version and build numbers of all content in your app only if the is an invalid number (like one that was used previously or precedes your current build number). The input will not work if `export options plist content` input has been set. Default set to No.
value_options:
- "yes"
- "no"
is_required: true
- export_options_plist_content:
opts:
category: IPA export configuration
title: Export options plist content
summary: Specifies a plist file content that configures archive exporting.
description: |-
Specifies a plist file content that configures archive exporting.
If not specified, the Step will auto-generate it.
# App Store Connect connection override
- api_key_path:
opts:
category: App Store Connect connection override
title: App Store Connect API private key
summary: Local path or remote URL to the private key (p8 file). This overrides the Bitrise-managed API connection.
description: |-
Local path or remote URL to the private key (p8 file) for App Store Connect API.
This overrides the Bitrise-managed API connection, only set this input if you want to control the API connection
on a step-level. Most of the time it's easier to set up the connection on the App Settings page on Bitrise.
The input value can be a file path (eg. `$TMPDIR/private_key.p8`) or an HTTPS URL.
This input only takes effect if the other two connection override inputs are set too (`api_key_id`, `api_key_issuer_id`).
- api_key_id:
opts:
category: App Store Connect connection override
title: App Store Connect API key ID
summary: Private key ID used for App Store Connect authentication. This overrides the Bitrise-managed API connection.
description: |-
Private key ID used for App Store Connect authentication.
This overrides the Bitrise-managed API connection, only set this input if you want to control the API connection
on a step-level. Most of the time it's easier to set up the connection on the App Settings page on Bitrise.
This input only takes effect if the other two connection override inputs are set too (`api_key_path`, `api_key_issuer_id`).
- api_key_issuer_id:
opts:
category: App Store Connect connection override
title: App Store Connect API issuer ID
summary: Private key issuer ID used for App Store Connect authentication. This overrides the Bitrise-managed API connection.
description: |-
Private key issuer ID used for App Store Connect authentication.
This overrides the Bitrise-managed API connection, only set this input if you want to control the API connection
on a step-level. Most of the time it's easier to set up the connection on the App Settings page on Bitrise.
This input only takes effect if the other two connection override inputs are set too (`api_key_path`, `api_key_id`).
- api_key_enterprise_account: "no"
opts:
category: App Store Connect connection override
title: App Store Connect API enterprise account
summary: Indicates if the account is an enterprise type. This overrides the Bitrise-managed API connection.
description: |-
Indicates if the account is an enterprise type.
This overrides the Bitrise-managed API connection, only set this input if you know you have an enterprise account.
value_options:
- "yes"
- "no"
is_required: true
# Debugging
- verbose_log: "no"
opts:
category: Debugging
title: Enable verbose logging
summary: If this input is set, the Step will print additional logs for debugging.
is_required: true
value_options:
- "yes"
- "no"
outputs:
- BITRISE_IPA_PATH:
opts:
title: iOS or tvOS IPA
summary: The created iOS or tvOS .ipa file's path.
- BITRISE_DSYM_PATH:
opts:
title: The created iOS or tvOS .dSYM zip file's path.
summary: Step will collect every dsym (app dsym and framwork dsyms) in a directory, zip it and export the zipped directory path.
- BITRISE_IDEDISTRIBUTION_LOGS_PATH:
opts:
title: xcdistributionlogs
summary: Path to the xcdistributionlogs zip