/
step.yml
299 lines (267 loc) · 9.93 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
title: Xcode Archive for iOS
summary: |-
Run Xcode Archive command and export an iOS IPA
description: |-
Run Xcode Archive command and export an iOS IPA.
You can share it, upload it, deploy it and catch them
all! Well, maybe not the last one.
website: https://github.com/bitrise-io/steps-xcode-archive
source_code_url: https://github.com/bitrise-io/steps-xcode-archive
support_url: https://github.com/bitrise-io/steps-xcode-archive/issues
host_os_tags:
- "osx-10.10"
project_type_tags:
- ios
type_tags:
- build
- xcode
is_requires_admin_user: false
is_always_run: false
is_skippable: false
deps:
check_only:
- name: xcode
brew:
- name: go
toolkit:
go:
package_name: github.com/bitrise-io/steps-xcode-archive
inputs:
- export_method: "auto-detect"
opts:
title: "Select method for export"
summary: ""
description: |-
__Export option:__
Describes how Xcode should export the archive.
If you select `auto-detect` step will figure out proper export method
based on provisioning profile embedded into generated xcodearchive.
value_options:
- "auto-detect"
- "app-store"
- "ad-hoc"
- "enterprise"
- "development"
- upload_bitcode: "yes"
opts:
title: "Include bitcode"
summary: ""
description: |-
__Export option:__
For __App Store__ exports, should the package include bitcode?
value_options:
- "yes"
- "no"
- compile_bitcode: "yes"
opts:
title: "Rebuild from bitcode"
summary: ""
description: |-
__Export option:__
For __non-App Store__ exports, should Xcode re-compile the app from bitcode?
value_options:
- "yes"
- "no"
- team_id:
opts:
title: "The Developer Portal team to use for this export"
summary: ""
description: |-
__Export option:__
The Developer Portal team to use for this export.
Format example:
- `1MZX23ABCD4`
- workdir: $BITRISE_SOURCE_DIR
opts:
title: "Working directory"
summary: ""
description: |-
Working directory of the step.
You can leave it empty to don't change it.
- project_path: $BITRISE_PROJECT_PATH
opts:
title: "Project (or Workspace) path"
summary: ""
description: |-
A `.xcodeproj` or `.xcworkspace` path.
is_required: true
- scheme: $BITRISE_SCHEME
opts:
title: "Scheme name"
summary: ""
description: |-
The Scheme to use.
is_required: true
- configuration:
opts:
title: "Configuration name"
summary: ""
description: |-
(optional) The configuration to use. By default your Scheme
defines which configuration (Debug, Release, ...) should be used,
but you can overwrite it with this option.
**Make sure that the Configuration you specify actually exists
in your Xcode Project**. If it does not, if you have a typo
in the value of this input Xcode will simply use the Configuration
specified by the Scheme and will silently ignore this parameter!
- output_dir: $BITRISE_DEPLOY_DIR
opts:
title: "Output directory path"
summary: ""
description: |-
This directory will contain the generated .ipa and .dSYM.zip files.
is_required: true
- force_team_id:
opts:
title: "Force Developer Portal team to use during archive"
description: |-
Used for Xcode version 8 and above.
Force xcodebuild to use specified Developer Portal team during archive.
Format example:
- `1MZX23ABCD4`
- force_code_sign_identity:
opts:
title: "Force code signing with Identity"
description: |-
Force xcodebuild to use specified Code Sign Identity.
Specify code sign identity as full ID (e.g. `iPhone Developer: Bitrise Bot (VV2J4SV8V4)`)
or specify code sign group ( `iPhone Developer` or `iPhone Distribution` ).
You also have to **specify the Identity in the format it's stored in Xcode project settings**,
and **not how it's presented in the Xcode.app GUI**!
This means that instead of `iOS` (`iOS Distribution/Development`) you have to use
`iPhone` (`iPhone Distribution` or `iPhone Development`).
**Capitalization also matters**, `iPhone Distribution` works but `iphone distribution` does not!
- force_provisioning_profile_specifier:
opts:
title: "Force code signing with Provisioning Profile Specifier"
description: |-
Used for Xcode version 8 and above.
Force xcodebuild to use specified Provisioning Profile.
How to get your Provisioning Profile Specifier:
- In Xcode make sure you disabled `Automatically manage signing` on your project's `General` tab
- Now you can select your Provisioning Profile Specifier's name as `Provisioning Profile` input value on your project's `General` tab
- `force_provisioning_profile_specifier` input value build up by the Team ID and the Provisioning Profile Specifier name, separated with slash character ('/'): `TEAM_ID/PROFILE_SPECIFIER_NAME`
Format example:
- `1MZX23ABCD4/My Provisioning Profile`
- force_provisioning_profile:
opts:
title: "Force code signing with Provisioning Profile"
description: |-
Force xcodebuild to use specified Provisioning Profile.
Use Provisioning Profile's UUID, profile's name is not acceptable by xcodebuild.
How to get your UUID:
- In xcode select your project -> Build Settings -> Code Signing
- Select the desired Provisioning Profile, then scroll down in profile list and click on Other...
- The popup will show your profile's UUID.
Format example:
- `c5be4123-1234-4f9d-9843-0d9be985a068`
- is_clean_build: "no"
opts:
title: "Do a clean Xcode build before the archive?"
value_options:
- "yes"
- "no"
is_required: true
- output_tool: xcpretty
opts:
title: Output tool
description: |-
If output_tool is set to xcpretty, the xcodebuild output will be prettified by xcpretty.
If output_tool is set to xcodebuild, the raw xcodebuild output will be printed.
value_options:
- xcpretty
- xcodebuild
is_required: true
is_expand: false
- xcodebuild_options: ""
opts:
title: Additional options for xcodebuild call
description: |-
Options added to the end of the xcodebuild call.
You can use multiple options, separated by a space
character. Example: `-xcconfig PATH -verbose`
- is_export_xcarchive_zip: "no"
opts:
title: Export the generated archive?
description: |-
If this input is set to `yes`, the generated .xcarchive will be zipped and moved to `output_dir`.
value_options:
- "yes"
- "no"
is_required: true
- use_deprecated_export: "no"
opts:
title: Use deprecated ipa export method?
description: |-
If this input is set to `yes`, step will use deprecated ipa export method.
value_options:
- "yes"
- "no"
is_required: true
- export_all_dsyms: "yes"
opts:
title: Export all dsyms
description: |-
If this input is set to `yes` step will collect every dsym (.app dsym and framwork dsyms) in a directory, zip it and export the zipped directory path.
Otherwise only .app dsym will be zipped and the zip path exported.
value_options:
- "yes"
- "no"
is_required: true
- custom_export_options_plist_content:
opts:
title: "Custom export options plist content"
description: |-
Used for Xcode version 7 and above.
Specifies a custom export options plist content that configures archive exporting.
If empty, step generates these options based on provisioning profile,
with default values.
Auto generated export options available for export methods:
- app-store
- ad-hoc
- enterprise
- development
If step doesn't find export method based on provisioning profile, development will be use.
Call `xcodebuild -help` for available export options.
- artifact_name: ${scheme}
opts:
title: "Generated Artifact Name"
description: |-
This name will be used as basename for the generated .xcarchive, .ipa and .dSYM.zip files.
outputs:
- BITRISE_IPA_PATH:
opts:
title: The created .ipa file's path
- BITRISE_APP_DIR_PATH:
opts:
title: The generated .app directory
- BITRISE_DSYM_DIR_PATH:
opts:
title: The created .dSYM dir's path
description: |-
If `export_all_dsyms` is set to `"yes"`, step will collect every dsym (.app dsym and framwork dsyms) in a directory and export the directory path.
Otherwise this environment points to the .app.DSYM directory path.
- BITRISE_DSYM_PATH:
opts:
title: The created .dSYM.zip file's path
description: |-
If `export_all_dsyms` is set to `"yes"`, step will collect every dsym (.app dsym and framwork dsyms) in a directory, zip it and export the zipped directory path.
Otherwise this environment points to the zipped .app.DSYM directory path.
- BITRISE_XCARCHIVE_PATH:
opts:
title: The created .xcarchive file's path
- BITRISE_XCARCHIVE_ZIP_PATH:
opts:
title: The created .xcarchive.zip file's path
description: |-
The created .xcarchive.zip file's path.
This environment will be exported only if, is_export_xcarchive_zip="yes"
- BITRISE_XCODE_ARCHIVE_RAW_RESULT_TEXT_PATH:
opts:
title: The full, raw archive output file path
description: |-
This is the path of the raw archive results log file.
If `output_tool=xcpretty` and the archive fails this log will contain the archive output.
- BITRISE_IDEDISTRIBUTION_LOGS_PATH:
opts:
title: Path to the xcdistributionlogs