-
Notifications
You must be signed in to change notification settings - Fork 0
/
step.yml
277 lines (270 loc) · 9.81 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
title: |-
Nitro for Android
summary: |
Build your React Native app faster than ever with Nitro
description: |
This step builds your React Native app for Android using [Nitro](https://nitro.build). Get your **API key** on our [website](https://nitro.build).
website: https://github.com/nitro-build/bitrise-step-nitro-android
source_code_url: https://github.com/nitro-build/bitrise-step-nitro-android
support_url: https://github.com/nitro-build/bitrise-step-nitro-android/issues
host_os_tags:
- ubuntu-16.04
project_type_tags:
- android
- react-native
type_tags:
- build
is_requires_admin_user: true
is_always_run: false
is_skippable: false
run_if: ""
deps:
apt_get:
- name: pigz
- name: file
- name: jq
brew:
- name: pigz
- name: gnu-sed
- name: jq
toolkit:
bash:
entry_file: step.sh
inputs:
# Basic configuration
- api_key:
opts:
title: "Nitro API key"
summary: "The API key required by Nitro. It is recommended to set a $NITRO_API_KEY as a Bitrise secret."
is_expand: true
is_sensitive: true
- root_directory: "./"
opts:
title: "Root directory"
summary: "The directory within your project, in which your code is located. Leave this field empty if your code is not located in a subdirectory"
is_expand: true
- flavor:
opts:
title: "Flavor"
summary: "Set product flavor for Gradle build variant"
is_expand: true
# App Versioning
- version_name:
opts:
category: "App Versioning"
title: "Version name"
summary: "The version name for the app"
is_expand: true
- version_code:
opts:
category: "App Versioning"
title: "Version code"
summary: "The version code for the app"
is_expand: true
- disable_version_name_from_package_json: "no"
opts:
category: "App Versioning"
title: "Disable automatic version name configuration"
summary: "By default will get the 'version' field from package.json and set the version name"
is_expand: true
value_options:
- "yes"
- "no"
- disable_version_code_auto_generation: "no"
opts:
category: "App Versioning"
title: "Disable automatic version code generation"
summary: "By default will generate a timestamp based number and set the version code"
is_expand: true
value_options:
- "yes"
- "no"
# App Signing
- keystore_url:
opts:
category: "App Signing"
title: "Keystore url"
summary: "Keystore url (defaults to $BITRISEIO_ANDROID_KEYSTORE_URL if present)"
is_expand: true
- keystore_password:
opts:
category: "App Signing"
title: "Keystore password"
summary: "Keystore password (defaults to $BITRISEIO_ANDROID_KEYSTORE_PASSWORD if present)"
is_expand: true
is_sensitive: true
- keystore_key_alias:
opts:
category: "App Signing"
title: "Keystore alias"
summary: "Keystore alias (defaults to $BITRISEIO_ANDROID_KEYSTORE_ALIAS if present)"
is_expand: true
- keystore_key_password:
opts:
category: "App Signing"
title: "Keystore key password"
summary: "Keystore key password (defaults to $BITRISEIO_ANDROID_KEYSTORE_PRIVATE_KEY_PASSWORD if present)"
is_expand: true
is_sensitive: true
# Caching
- cache_provider: "s3"
opts:
category: "Caching"
title: "Cache provider"
summary: "Choose the provider where cache artifacts will be persisted"
description: |-
Choose the provider where cache artifacts will be persisted:
- `fs`: File system
- `s3`: Amazon - Simple Storage Service
is_expand: true
value_options:
- "fs"
- "s3"
- disable_cache:
opts:
category: "Caching"
title: "Disable builds caching"
summary: "When setting this option to `yes` build cache optimizations won't be performed. (defaults to $NITRO_DISABLE_CACHE if present)"
description: "When setting this option to `yes` build cache optimizations won't be performed. (defaults to $NITRO_DISABLE_CACHE if present)"
is_expand: true
- cache_env_var_lookup_keys:
opts:
category: "Caching"
title: "List of env var keys for lookup to determine cache fingerprint"
summary: "A list of `|` separated values with env variable keys to lookup to determine whether the build should be cached or not"
description: "A list of `|` separated values with env variable keys to lookup to determine whether the build should be cached or not"
is_expand: true
- cache_file_lookup_paths:
opts:
category: "Caching"
title: "List of files for lookup to determine cache fingerprint"
summary: "A list of `|` separated value paths (relative to the root of the repo or absolute) to lookup in order to determine whether the build should be cached or not"
description: "A list of `|` separated value paths (relative to the root of the repo or absolute) to lookup in order to determine whether the build should be cached or not"
is_expand: true
- disable_metro_cache:
opts:
category: "Caching"
title: "Disable Metro bundler cache"
summary: "Setting this field to `yes` will disable the React Native Metro cache feature. (defaults to $NITRO_DISABLE_METRO_CACHE if present)"
description: "Setting this field to yes will disable the React Native Metro cache feature. (defaults to $NITRO_DISABLE_METRO_CACHE if present)"
is_expand: true
- aws_s3_access_key_id:
opts:
category: "Caching"
title: "AWS S3 access key ID"
summary: "AWS access key ID for S3 bucket build caching. (defaults to $NITRO_AWS_S3_ACCESS_KEY_ID if present)"
is_expand: true
- aws_s3_secret_access_key:
opts:
category: "Caching"
title: "AWS S3 secret access key"
summary: "AWS secret access key for S3 bucket build caching. (defaults to $NITRO_AWS_S3_SECRET_ACCESS_KEY if present)"
is_expand: true
- aws_s3_region:
opts:
category: "Caching"
title: "AWS S3 region"
summary: "AWS region where S3 bucket for build caching is located. (defaults to $NITRO_AWS_S3_REGION if present)"
is_expand: true
- aws_s3_bucket:
opts:
category: "Caching"
title: "AWS S3 bucket name"
summary: "AWS bucket name for S3 bucket build caching. (defaults to $NITRO_AWS_S3_BUCKET if present)"
is_expand: true
# Hooks
- pre_install_command:
opts:
category: "Hooks"
title: "Pre install command"
summary: "Run command prior to install project dependencies (e.g. `rm -rf ./some-folder`)"
description: "Run command prior to install project dependencies (e.g. `rm -rf ./some-folder`)"
is_expand: true
- pre_build_command:
opts:
category: "Hooks"
title: "Pre build command"
summary: "Run command prior to start building the app (e.g. `yarn tsc && yarn test`)"
description: "Run command prior to start building the app (e.g. `yarn tsc && yarn test`)"
is_expand: true
- post_build_command:
opts:
category: "Hooks"
title: "Post build command"
summary: "Run command once build successfully finished (e.g. `yarn publish`)"
description: "Run command once build successfully finished (e.g. `yarn publish`)"
is_expand: true
# Advanced
- detox_configuration:
opts:
category: "Advanced"
title: "Detox configuration"
summary: "Select a device configuration from your defined configurations."
is_expand: true
- output_directory:
opts:
category: "Advanced"
title: "Output directory"
summary: "The path to the directory where to place all of Nitro's output files. (defaults to $BITRISE_DEPLOY_DIR)"
is_expand: true
- entry_file:
opts:
category: "Advanced"
title: "The entry file for bundle generation"
summary: "The entry file for bundle generation. (defaults to $ENTRY_FILE if present)"
is_expand: true
- verbose: "no"
opts:
category: "Advanced"
title: "Verbose logs"
summary: "Enable verbose logs"
description: "Enable verbose logs"
value_options:
- "yes"
- "no"
- debug: "no"
opts:
category: "Advanced"
title: "Debug step"
summary: "Enable step debugging"
description: "Enable step debugging"
value_options:
- "yes"
- "no"
- fail_safe:
opts:
category: "Advanced"
title: "Fail-safe mode"
summary: "Runing the app in this mode allows you to prevent the build to fail but you can check the status in further steps. (defaults to $NITRO_FAIL_SAFE if present)"
is_expand: true
outputs:
- NITRO_BUILD_STATUS:
opts:
title: "Build status"
summary: "The status of the latest build (success / failed)"
description: "The status of the latest build (success / failed)"
- NITRO_OUTPUT_DIR:
opts:
title: "Output directory"
summary: "The path to the directory where to place all of Nitro's output files"
description: "The path to the directory where to place all of Nitro's output files"
- NITRO_LOGS_PATH:
opts:
title: "Build log location"
summary: "The full path to access the build log"
description: "The full path to access the build log"
- NITRO_SUMMARY_PATH:
opts:
title: "Summary location"
summary: "The full path to access the build summary report"
description: "The full path to access the build summary report"
- NITRO_APP_PATH:
opts:
title: "Build application package location"
summary: "The full path to access the Android package (.apk)"
description: "The full path to access the Android package (.apk)"
- NITRO_DEPLOY_PATH: # deprecated
opts:
title: "Build application package location"
summary: "The full path to access the Android package (.apk)"
description: "The full path to access the Android package (.apk)"