From bc33dbf0f8b288e1950483c5711eebc1c910f8ac Mon Sep 17 00:00:00 2001 From: Ruben Sousa Date: Wed, 2 Oct 2024 00:41:56 +0200 Subject: [PATCH] Update docs and changelog --- docs/android-allure-plugin.md | 7 +------ docs/changelog/android-allure.md | 14 ++++++++++++-- docs/test-reports-android.md | 28 +++++++++++++++++++++++++++- gradle/libs.versions.toml | 2 +- mkdocs.yml | 2 +- 5 files changed, 42 insertions(+), 11 deletions(-) diff --git a/docs/android-allure-plugin.md b/docs/android-allure-plugin.md index ebbf26d7..8e0684c0 100644 --- a/docs/android-allure-plugin.md +++ b/docs/android-allure-plugin.md @@ -42,15 +42,10 @@ To customize the plugin use the following: ```kotlin allureReport { - /** - * The name of the test task that will be invoked - * to generate the report on `connectedAllureReport` - */ - testTask = "connectedDebugAndroidTest" /** * By default, logcat files are not included if the test passes */ - keepLogcatOnSuccess = false + attachLogcatOnSuccess = false /** * The report output path. * Can be used to merge reports of multiple modules by using the same directory diff --git a/docs/changelog/android-allure.md b/docs/changelog/android-allure.md index b61d47f7..fd50bd0c 100644 --- a/docs/changelog/android-allure.md +++ b/docs/changelog/android-allure.md @@ -4,6 +4,14 @@ Plugin id: `com.rubensousa.carioca.report.allure` ## Version 1.0.0 +### 1.0.0-alpha05 + +2024-10-02 + +#### Improvements + +- Added support for report generation of product flavor tests [#73](https://github.com/rubensousa/Carioca/pull/73) + ### 1.0.0-alpha04 2024-09-28 @@ -18,8 +26,10 @@ Plugin id: `com.rubensousa.carioca.report.allure` #### Improvements -- Added support for multi-module report aggregation with `outputDir` option [#44](https://github.com/rubensousa/Carioca/pull/44) -- Do not delete original reports by default since they can be used by other plugins [#51](https://github.com/rubensousa/Carioca/pull/51) +- Added support for multi-module report aggregation with `outputDir` + option [#44](https://github.com/rubensousa/Carioca/pull/44) +- Do not delete original reports by default since they can be used by other + plugins [#51](https://github.com/rubensousa/Carioca/pull/51) ### 1.0.0-alpha02 diff --git a/docs/test-reports-android.md b/docs/test-reports-android.md index 41672132..f2dcc843 100644 --- a/docs/test-reports-android.md +++ b/docs/test-reports-android.md @@ -289,4 +289,30 @@ Node #1 at (left=0.0, top=0.0, right=1920.0, bottom=1080.0)px |-Node #10 at (left=1782.0, top=972.0, right=1834.0, bottom=1012.0)px Text = '[FAB]' Actions = [SetTextSubstitution, ShowTextSubstitution, ClearTextSubstitution, GetTextLayoutResult] -``` \ No newline at end of file +``` + +## Tracking ignored tests + +To include ignored tests in the reports, you need to attach the library's instrumentation listener: + +```groovy +android { + defaultConfig { + testInstrumentationRunnerArguments listener: 'com.rubensousa.carioca.report.android.CariocaInstrumentedListener' + } +} +``` + +Or in kotlin DSL: + +```kotlin +android { + defaultConfig { + testInstrumentationRunnerArguments["listener"] = + "com.rubensousa.carioca.report.android.CariocaInstrumentedListener" + } +} +``` + +!!! note + If you use other listeners, just separate them with a comma in the same string \ No newline at end of file diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index ad9dfdcc..568522c5 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -29,7 +29,7 @@ kover = "0.9.0-RC" ksp = "2.0.20-1.0.24" # Publishing -cariocaReport = "1.0.0-alpha02" +cariocaReport = "1.0.0-alpha04" uiTestJunit4 = "1.7.2" uiTooling = "1.7.2" diff --git a/mkdocs.yml b/mkdocs.yml index 632abd2b..8dd344ed 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,7 +28,7 @@ extra: junit4_rules: version: '1.0.0-beta01' allure_plugin: - version: '1.0.0-alpha04' + version: '1.0.0-alpha05' hilt: version: '1.0.0' social: