From e710da5d3834c00e7f27e7f8f14a86310d65c859 Mon Sep 17 00:00:00 2001 From: Szabolcs Toth <54896607+tothszabi@users.noreply.github.com> Date: Tue, 13 Feb 2024 09:02:26 +0000 Subject: [PATCH] [CI-2375] Update step description with HTML report support (#195) * Update step description with HTML report support * Update readme --- README.md | 9 ++++++--- step.yml | 7 +++++-- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b57c2b4b..73f6810a 100644 --- a/README.md +++ b/README.md @@ -3,8 +3,8 @@ [![Step changelog](https://shields.io/github/v/release/bitrise-steplib/steps-deploy-to-bitrise-io?include_prereleases&label=changelog&color=blueviolet)](https://github.com/bitrise-steplib/steps-deploy-to-bitrise-io/releases) Deploys build artifacts to make them available for the user on the build's **Artifacts** tab. -Sends test results to the Test Reports add-on (build's **Tests** tab), -and uploads Pipeline intermediate files to make them available in subsequent Stages. +Sends test results to the Test Reports add-on (build's **Tests** tab). +Uploads Pipeline intermediate files to make them available in subsequent Stages and also uploads Bitrise and user generated html reports.
Description @@ -13,6 +13,7 @@ The Step accesses artifacts from a directory specified as the `$BITRISE_DEPLOY_D These artifacts are then uploaded on the **Artifacts** tab of any given build. For installable artifacts, such as IPAs or APKs, the Step can create a public install page that allows testers to install the app on their devices. You can also use the Step to notify users about the build. If you wish to use the Test Reports add-on, you must add this Step in your Workflow since the Step converts test results to the right format and sends them to the add-on. The Step can also share Pipeline intermediate files. These files are build artifacts generated by Workflows in a Pipeline intended to be shared with subsequent Stages. +Also it collects and uploads all of the html reports located in the `BITRISE_HTML_REPORT_DIR` folder. ### Configuring the Build Artifact Deployment section of the Step @@ -35,6 +36,7 @@ Provide a language template description using [https://golang.org/pkg/text/templ The next Steps will use this input to generate the related output in the specified format. The output contains multiple permanent URLs for multiple artifacts. Provide a language template description using [https://golang.org/pkg/text/template](https://golang.org/pkg/text/template) so that the **Deploy to Bitrise.io** Step can build the required custom output. 8. The **Test API's base URL** and the **API Token** input fields are automatically populated for you. +9. The html report upload does not have any specific settings because it will happen automatically. ### Configuring the Pipeline Intermediate File Sharing section of the Step @@ -64,6 +66,7 @@ Bundletool generates an APK from an Android App Bundle so that you can test the - [Deployment on Bitrise](https://devcenter.bitrise.io/deploy/deployment-index/) - [Watching an app](https://devcenter.bitrise.io/builds/configuring-notifications/#watching-an-app) - [Using artifacts from different Stages](https://devcenter.bitrise.io/en/builds/build-pipelines/configuring-a-bitrise-pipeline.html#using-artifacts-from-different-stages) +- [Viewing HTML reports](https://devcenter.bitrise.io/en/builds/build-data-and-troubleshooting/viewing-html-reports) ### Related Steps @@ -129,7 +132,7 @@ This metadata will be saved with the individual files and restored by the [Pull | `notify_user_groups` | Your App's user roles you want to notify. Separate the role names with commas. Possible role names: * none * testers * developers * admins * owner * everyone An example to notify your developers and testers: `testers, developers` If you want to notify everyone in the app's team, just specify `everyone`. If you don't want to notify anyone, set this to `none`. | | `everyone` | | `notify_email_list` | Email addresses to notify. Separate them with commas. You can specify any email address, the recipients don't have to be in your team. Please note that if the email address is associated with a Bitrise account, the user must be [watching](https://devcenter.bitrise.io/builds/configuring-notifications/#watching-an-app) the app. | sensitive | | | `is_enable_public_page` | If this option is enabled, a public install page will be available with a long and random URL which can be shared with others who are not registered on Bitrise. If you disable this option, the **Notify: Emails** option will be ignored and the **Notify: User Roles** users will receive the build's URL instead of the public page's URL! | required | `true` | -| `bundletool_version` | If you need a specific [bundletool version]((https://github.com/google/bundletool/releases) other than the default version, you can modify the value of the **Bundletool version** required input. | required | `1.8.1` | +| `bundletool_version` | If you need a specific [bundletool version]((https://github.com/google/bundletool/releases) other than the default version, you can modify the value of the **Bundletool version** required input. | required | `1.15.0` | | `build_url` | Unique build URL of this build on Bitrise.io | required | `$BITRISE_BUILD_URL` | | `build_api_token` | The build's API Token for the build on Bitrise.io | required, sensitive | `$BITRISE_BUILD_API_TOKEN` | | `pipeline_intermediate_files` | A newline (`\n`) separated list of file path - env key pairs (`{path}:{env_key}`). The input uses a `{path}:{env_key}` syntax. The colon character (`:`) is the delimiter between the file path and the environment variable key. A shorthand syntax of `ENV_VAR` can be used for `$ENV_VAR:ENV_VAR` when the name of the env var in the current workflow will become the shared env_key. The file path can be specified with environment variables or direct paths, and can point to both a local file or directory: ``` $BITRISE_IPA_PATH:BITRISE_IPA_PATH BITRISE_IPA_PATH $BITRISE_APK_PATH:DEVELOPMENT_APK_PATH ./path/to/test_reports:TEST_REPORTS_DIR $BITRISE_SOURCE_DIR/deploy_dir:DEPLOY_DIR ``` | | | diff --git a/step.yml b/step.yml index 2aec3957..5beb1f90 100644 --- a/step.yml +++ b/step.yml @@ -1,13 +1,14 @@ title: "Deploy to Bitrise.io - Build Artifacts, Test Reports, and Pipeline intermediate files" summary: |- Deploys build artifacts to make them available for the user on the build's **Artifacts** tab. - Sends test results to the Test Reports add-on (build's **Tests** tab), - and uploads Pipeline intermediate files to make them available in subsequent Stages. + Sends test results to the Test Reports add-on (build's **Tests** tab). + Uploads Pipeline intermediate files to make them available in subsequent Stages and also uploads Bitrise and user generated html reports. description: |- The Step accesses artifacts from a directory specified as the `$BITRISE_DEPLOY_DIR` where artifacts generated by previous Steps gets stored. These artifacts are then uploaded on the **Artifacts** tab of any given build. For installable artifacts, such as IPAs or APKs, the Step can create a public install page that allows testers to install the app on their devices. You can also use the Step to notify users about the build. If you wish to use the Test Reports add-on, you must add this Step in your Workflow since the Step converts test results to the right format and sends them to the add-on. The Step can also share Pipeline intermediate files. These files are build artifacts generated by Workflows in a Pipeline intended to be shared with subsequent Stages. + Also it collects and uploads all of the html reports located in the `BITRISE_HTML_REPORT_DIR` folder. ### Configuring the Build Artifact Deployment section of the Step @@ -30,6 +31,7 @@ description: |- The next Steps will use this input to generate the related output in the specified format. The output contains multiple permanent URLs for multiple artifacts. Provide a language template description using [https://golang.org/pkg/text/template](https://golang.org/pkg/text/template) so that the **Deploy to Bitrise.io** Step can build the required custom output. 8. The **Test API's base URL** and the **API Token** input fields are automatically populated for you. + 9. The html report upload does not have any specific settings because it will happen automatically. ### Configuring the Pipeline Intermediate File Sharing section of the Step @@ -59,6 +61,7 @@ description: |- - [Deployment on Bitrise](https://devcenter.bitrise.io/deploy/deployment-index/) - [Watching an app](https://devcenter.bitrise.io/builds/configuring-notifications/#watching-an-app) - [Using artifacts from different Stages](https://devcenter.bitrise.io/en/builds/build-pipelines/configuring-a-bitrise-pipeline.html#using-artifacts-from-different-stages) + - [Viewing HTML reports](https://devcenter.bitrise.io/en/builds/build-data-and-troubleshooting/viewing-html-reports) ### Related Steps