Skip to content

Commit 71b18f3

Browse files
authored
Update step.yml (#181)
* Update step.yml * Update README * Fix go lint issue * Update wear sample * Update wear os test branch
1 parent fe37a30 commit 71b18f3

File tree

3 files changed

+13
-12
lines changed

3 files changed

+13
-12
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ If the Step fails, check the following:
5858

5959
## 🧩 Get started
6060

61-
Add this step directly to your workflow in the [Bitrise Workflow Editor](https://devcenter.bitrise.io/steps-and-workflows/steps-and-workflows-index/).
61+
Add this step directly to your workflow in the [Bitrise Workflow Editor](https://docs.bitrise.io/en/bitrise-ci/workflows-and-pipelines/steps/adding-steps-to-a-workflow.html).
6262

6363
You can also run this step directly with [Bitrise CLI](https://github.com/bitrise-io/bitrise).
6464

@@ -101,30 +101,29 @@ steps:
101101
| `release_name` | The name of the release. By default Play Store generates the name from the APK's `versionName` value. | | |
102102
| `update_priority` | This allows your app to decide how strongly to recommend an update to the user. Accepts values between 0 and 5 with 0 being the lowest priority and 5 being the highest priority. By default this value is 0. For more information see here: https://developer.android.com/guide/playcore/in-app-updates#check-priority. | | `0` |
103103
| `whatsnews_dir` | Use this input to specify localized 'what's new' files directory. This directory should contain 'whatsnew' files postfixed with the locale. what's new file name pattern: `whatsnew-LOCALE` Example: ``` + - [PATH/TO/WHATSNEW] \| + - whatsnew-en-US \| + - whatsnew-de-DE ``` Format examples: - "./" # what's new files are in the repo root directory - "./whatsnew" # what's new files are in the whatsnew directory | | |
104-
| `mapping_file` | The `mapping.txt` file provides a translation between the original and obfuscated class, method, and field names. Uploading a mapping file is not required when deploying an AAB as the app bundle contains the mapping file itself. In case of deploying [multiple artifacts](https://developer.android.com/google/play/publishing/multiple-apks.html), you can specify multiple mapping.txt files as a newline (`\n`) or pipe (`\|`) separated list. The order of mapping files should match the list of APK or AAB files in the `app_path` input. | | `$BITRISE_MAPPING_PATH` |
104+
| `mapping_file` | The `mapping.txt` file provides a translation between the original and obfuscated class, method, and field names. Uploading a mapping file is not required when deploying an AAB as the app bundle contains the mapping file itself. In case of deploying [multiple artifacts](https://developer.android.com/google/play/publishing/multiple-apks.html), you can specify multiple mapping.txt files as a newline (`\n`) or pipe (`\|`) separated list. The order of mapping files should match the list of APK or AAB files in the `app_path` input. | | `$BITRISE_MAPPING_PATH` |
105105
| `retry_without_sending_to_review` | If set to `true` and the initial change request fails, the changes will not be reviewed until they are manually sent for review from the Google Play Console UI. If set to `false`, the step fails if the changes can't be automatically sent to review. | required | `false` |
106106
| `ack_bundle_installation_warning` | Must be set to `true` if the App Bundle installation may trigger a warning on user devices (for example, if installation size may be over a threshold, typically 100 MB). | required | `false` |
107-
| `dry_run` | If set to `true` then the changes will not be committed to create a real release in the Play Console. Use this flag to validate your configuration without triggering a new review. See the [API reference](https://developers.google.com/android-publisher/api-ref/rest/v3/edits/validate). | | `false` |
107+
| `dry_run` | If set to `true` then the changes will not be committed to create a real release in the Play Console. Use this flag to validate your configuration without triggering a new review. | | `false` |
108+
| `verbose_log` | If this input is set, the Step will print additional logs for debugging. | required | `false` |
108109
</details>
109110

110111
<details>
111112
<summary>Outputs</summary>
112113

113-
| Key | Description |
114-
|------------------|----------------------------------------------------|
115-
| `FAILURE_REASON` | Reason the upload to Google Play failed, if it did |
116-
114+
| Environment Variable | Description |
115+
| --- | --- |
116+
| `FAILURE_REASON` | Response given from Google about why aab/apk was not uploaded |
117117
</details>
118118

119119
## 🙋 Contributing
120120

121121
We welcome [pull requests](https://github.com/bitrise-io/steps-google-play-deploy/pulls) and [issues](https://github.com/bitrise-io/steps-google-play-deploy/issues) against this repository.
122122

123-
For pull requests, work on your changes in a forked repository and use the Bitrise CLI to [run step tests locally](https://devcenter.bitrise.io/bitrise-cli/run-your-first-build/).
123+
For pull requests, work on your changes in a forked repository and use the Bitrise CLI to [run step tests locally](https://docs.bitrise.io/en/bitrise-ci/bitrise-cli/running-your-first-local-build-with-the-cli.html).
124124

125125
**Note:** this step's end-to-end tests (defined in `e2e/bitrise.yml`) are working with secrets which are intentionally not stored in this repo. External contributors won't be able to run those tests. Don't worry, if you open a PR with your contribution, we will help with running tests and make sure that they pass.
126126

127127
Learn more about developing steps:
128128

129-
- [Create your own step](https://devcenter.bitrise.io/contributors/create-your-own-step/)
130-
- [Testing your Step](https://devcenter.bitrise.io/contributors/testing-and-versioning-your-steps/)
129+
- [Create your own step](https://docs.bitrise.io/en/bitrise-ci/workflows-and-pipelines/developing-your-own-bitrise-step/developing-a-new-step.html)

publish.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package main
22

33
import (
4+
"errors"
45
"fmt"
56
"os"
67
"path/filepath"
@@ -109,7 +110,7 @@ func uploadAppBundle(service *androidpublisher.Service, packageName string, appE
109110
if strings.Contains(err.Error(), bundleInstallationWarning) {
110111
msg = fmt.Sprintf("%s\nTo acknowledge this warning, set the Acknowledge Bundle Installation Warning (ack_bundle_installation_warning) input to true.", msg)
111112
}
112-
return nil, fmt.Errorf(msg)
113+
return nil, errors.New(msg)
113114
}
114115
log.Infof("Uploaded app bundle version: %d", bundle.VersionCode)
115116
return bundle, nil

step.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,10 @@ support_url: https://github.com/bitrise-io/steps-google-play-deploy/issues
5555
project_type_tags:
5656
- android
5757
- cordova
58+
- flutter
5859
- ionic
60+
- kotlin-multiplatform
5961
- react-native
60-
- flutter
6162
type_tags:
6263
- deploy
6364
is_requires_admin_user: false

0 commit comments

Comments
 (0)