This repository has been archived by the owner on Jan 24, 2022. It is now read-only.
forked from bitrise-steplib/steps-appcenter-deploy-android
-
Notifications
You must be signed in to change notification settings - Fork 0
/
step.yml
199 lines (175 loc) · 8.42 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
title: "AppCenter Android Deploy"
summary: |-
Distribute your Android app through [Microsoft App Center](https://appcenter.ms/).
description: |-
[This Step](https://github.com/bitrise-steplib/steps-appcenter-deploy-android) integrates with the [App Center](https://appcenter.ms/)'s Distribution service and enables you to distribute your apps seamlessly to different stores, for example, App Store, MS Intune, user groups or even individual testers.
### Configuring the Step
Before you start:
The Step requires an active MS App Center account.
1. Add the **APP path** which points to a binary file.
2. Add the **mapping.txt file path**.
3. Add the App Center **API token**.
4. Add the **Owner name**, which means the owner of the App Center app. For an app owned by a user, the URL in App Center can look like this https://appcenter.ms/users/JoshuaWeber/apps/APIExample where the {ownername} is JoshuaWeber. For an app owned by an organization, the URL can be, for example, https://appcenter.ms/orgs/Microsoft/apps/APIExample where the {ownername} is Microsoft.
5. Add the **App name** which is the name of the App Center app. For an app owned by a user, the URL in App Center might look like this: https://appcenter.ms/users/JoshuaWeber/apps/APIExample where the {app_name} is APIExample.
6. Add the **Distribution groups** which means the user groups you wish to distribute the app to. Please add one group name per line.
7. Add the **Distribution stores** where you wish to distribute the app to. Please add one store name per line.
8. Add the **Testers** who you wish to send the app to via email. Please add one email address per line.
9. Add any **Release notes for the deployed artifact**.
10. Send notification emails to testers and distribution groups with the **Notify Testers** input.
11. You can enforce the installation of a distribution version with the **Mandatory** input set to `yes`.
12. If you set the **Debug** input to `yes`, you can enable verbose logs.
### Useful links
- [About Android deployment with Bitrise](https://devcenter.bitrise.io/deploy/android-deploy/android-deployment-index/)
- [About Android code signing](https://devcenter.bitrise.io/code-signing/android-code-signing/android-code-signing-index/)
### Related Steps
- [Deploy to Huawei App Gallery](https://www.bitrise.io/integrations/steps/app-gallery-deploy)
- [Google Play Deploy](https://www.bitrise.io/integrations/steps/google-play-deploy)
website: https://github.com/bitrise-steplib/steps-appcenter-deploy-android
source_code_url: https://github.com/bitrise-steplib/steps-appcenter-deploy-android
support_url: https://github.com/bitrise-steplib/steps-appcenter-deploy-android/issues
project_type_tags:
- android
- xamarin
- cordova
- ionic
- react-native
- flutter
type_tags:
- deploy
is_always_run: false
is_skippable: false
toolkit:
go:
package_name: github.com/bitrise-steplib/steps-appcenter-deploy-android
inputs:
- app_path: "$BITRISE_APP_PATH"
opts:
title: APP path
summary: Path to binary file
description: |-
Path to binary file
For APKs, only single or universal APKs are supported: https://docs.microsoft.com/en-us/appcenter/build/react-native/android/#63-building-multiple-apks
is_required: true
- mapping_path:
opts:
title: mapping.txt file path
summary: Path to an Android mapping.txt file.
description: Path to an Android mapping.txt file.
- api_token:
opts:
title: API Token
summary: App Center API token
description: App Center API token
is_required: true
is_sensitive: true
- owner_name:
opts:
title: Owner name
summary: Owner of the App Center app
description: |-
Owner of the App Center app.
For an app owned by a user, the URL in App Center might look like https://appcenter.ms/users/JoshuaWeber/apps/APIExample.
Here, the {owner_name} is JoshuaWeber. For an app owned by an org, the URL might be
https://appcenter.ms/orgs/Microsoft/apps/APIExample and the {owner_name} would be Microsoft
is_required: true
- app_name:
opts:
title: App name
summary: The name of the App Center app
description: |-
The name of the App Center app.
For an app owned by a user, the URL in App Center might look like https://appcenter.ms/users/JoshuaWeber/apps/APIExample.
Here, the {app_name} is ApiExample.
is_required: true
- distribution_group:
opts:
title: Distribution groups
summary: User groups you wish to distribute the app. One group name per line.
description: |-
User groups you wish to distribute the app. One group name per line.
Distribution of AAB is supported only for Google Play store deployment: https://docs.microsoft.com/en-us/appcenter/distribution/uploading#android
- distribution_store:
opts:
title: Distribution stores
summary: Distribution stores you wish to distribute the app. One store name per line.
description: |-
Distribution stores you wish to distribute the app. One store name per line.
Distribution of AAB is supported only for Google Play store deployment: https://docs.microsoft.com/en-us/appcenter/distribution/uploading#android
- distribution_tester:
opts:
title: Testers
summary: List of individual testers. One email per line.
description: |-
List of individual testers. One email per line.
Distribution of AAB is supported only for Google Play store deployment: https://docs.microsoft.com/en-us/appcenter/distribution/uploading#android
- release_notes: "Release notes"
opts:
title: Release notes text
summary: Release notes text
description: |-
Additional notes for the deployed artifact.
- notify_testers: "yes"
opts:
title: Notify Testers
summary: Send notification email to testers and distribution groups.
description: Send notification email to testers and distribution groups.
value_options: ["yes", "no"]
is_required: true
- mandatory: "no"
opts:
title: Mandatory
summary: Enforce installation of distribution version. Requires SDK integration.
description: Enforce installation of distribution version. Requires SDK integration.
value_options: ["no", "yes"]
is_required: true
- debug: "no"
opts:
title: Debug
summary: Enable verbose logs
description: Enable verbose logs
value_options: ["no", "yes"]
is_required: true
- all_distribution_groups: "no"
opts:
title: All distribution groups
summary: Distribute the app to all user groups on that app.
description: |-
Distribute the app to all user groups on that app. Enabling this options makes it ignore distribution_group.
value_options: ["no", "yes"]
is_required: true
outputs:
- APPCENTER_DEPLOY_STATUS:
opts:
title: Deployment status
summary: "Deployment status: 'success' or 'failed'"
description: "Deployment status: 'success' or 'failed'"
- APPCENTER_DEPLOY_INSTALL_URL:
opts:
title: Install page URL
summary: Install page URL of the newly deployed version
description: Install page URL of the newly deployed version.
- APPCENTER_DEPLOY_DOWNLOAD_URL:
opts:
title: Download URL
summary: Download URL of the newly deployed version
description: Download URL of the newly deployed version.
- APPCENTER_DEPLOY_RELEASE_ID:
opts:
title: Release ID
summary: ID of the new release for later retrieval via App Center APIs.
description: ID of the new release for later retrieval via App Center APIs.
- APPCENTER_PUBLIC_INSTALL_PAGE_URL:
opts:
title: Public install page URL
summary: Public install page URL of the latest version
description: Public install page URL of the latest version.
- APPCENTER_PUBLIC_INSTALL_PAGE_URLS:
opts:
title: Comma-separated public install pages by groups
summary: Comma-separated list of the public install pages URL.
description: When a group is public the step will AppCenter provides and the step exports a public install page URL.
- APPCENTER_RELEASE_PAGE_URL:
opts:
title: Release Page URL
summary: URL to the release page containing release notes.
description: URL to the release page containing release notes, easily share with business partners and QA for testing.