chore: release notes for v20.08.2

Co-authored-by: piotradamczyk5 <[email protected]>

release_notes.md

@@ -1,3 +1,29 @@
+## v20.08.2
+### Features
+- [#1020](https://github.com/Flank/flank/pull/1020) Make release notes more organized ([piotradamczyk5](https://github.com/piotradamczyk5))
+- [#1013](https://github.com/Flank/flank/pull/1013) Generating docs before release ([piotradamczyk5](https://github.com/piotradamczyk5))
+- [#1012](https://github.com/Flank/flank/pull/1012) Add ip-blocks command to test-environment command ([pawelpasterz](https://github.com/pawelpasterz))
+- [#999](https://github.com/Flank/flank/pull/999) Implement ip-blocks list command ([pawelpasterz](https://github.com/pawelpasterz))
+- [#996](https://github.com/Flank/flank/pull/996) Auto generate release notes for next release ([piotradamczyk5](https://github.com/piotradamczyk5))
+- [#995](https://github.com/Flank/flank/pull/995) Implement command `models describe` for ios/android ([adamfilipow92](https://github.com/adamfilipow92))
+- [#991](https://github.com/Flank/flank/pull/991) Validate orientation and fail fast ([Sloox](https://github.com/Sloox))
+- [#969](https://github.com/Flank/flank/pull/969) Add locales description command for ios and android ([adamfilipow92](https://github.com/adamfilipow92))
+- [#992](https://github.com/Flank/flank/pull/992) Update google api ([jan-gogo](https://github.com/jan-gogo))
+- [#988](https://github.com/Flank/flank/pull/988) Add versions description command for ios and android ([adamfilipow92](https://github.com/adamfilipow92))
+### Refactor
+- [#1018](https://github.com/Flank/flank/pull/1018) Fetch artifacts async ([pawelpasterz](https://github.com/pawelpasterz))
+### Bug Fixes
+- [#919](https://github.com/Flank/flank/pull/919) Rate limit exceeded ([pawelpasterz](https://github.com/pawelpasterz), [jan-gogo](https://github.com/jan-gogo))
+- [#1005](https://github.com/Flank/flank/pull/1005) Generation of release notes ([piotradamczyk5](https://github.com/piotradamczyk5))
+- [#1007](https://github.com/Flank/flank/pull/1007) Failing tests ([piotradamczyk5](https://github.com/piotradamczyk5))
+- [#990](https://github.com/Flank/flank/pull/990) Exclusion of @Suppress test ([piotradamczyk5](https://github.com/piotradamczyk5))
+### CI Changes
+- [#1015](https://github.com/Flank/flank/pull/1015) Update mergify configuration ([piotradamczyk5](https://github.com/piotradamczyk5))
+- [#1011](https://github.com/Flank/flank/pull/1011) Generate release notes for Github release description ([piotradamczyk5](https://github.com/piotradamczyk5))
+- [#989](https://github.com/Flank/flank/pull/989) Check if valid title is used in PR ([piotradamczyk5](https://github.com/piotradamczyk5))
+### Documentation
+- [#987](https://github.com/Flank/flank/pull/987) Analytics addition to readme ([Sloox](https://github.com/Sloox))
+
 ## v20.08.1
 - [#978](https://github.com/Flank/flank/pull/978) Firebaseopensource.com addition ([sloox](https://github.com/Sloox))
 - [#937](https://github.com/Flank/flank/pull/968) Improve error message on iOS when test or xctestrun-file not found ([sloox](https://github.com/Sloox))

test_runner/docs/ascii/flank.jar_-android-locales.adoc

@@ -29,6 +29,9 @@ Information about available locales on device. For example prints list of availa
 *list*::
   Print current list of locales available to test against
 
+*describe*::
+  Describe a locales 
+
 // end::picocli-generated-man-section-commands[]
 
 // end::picocli-generated-full-manpage[]

test_runner/docs/ascii/flank.jar_-android-models.adoc

@@ -29,6 +29,9 @@ Information about available models. For example prints list of available models
 *list*::
   Print current list of devices available to test against
 
+*describe*::
+  Describe android model 
+
 // end::picocli-generated-man-section-commands[]
 
 // end::picocli-generated-full-manpage[]

test_runner/docs/ascii/flank.jar_-android-run.adoc

@@ -121,9 +121,6 @@ Configuration is read from flank.yml
 *--shard-time*=_<shardTime>_::
   The max amount of seconds each shard should run.
 
-*--project*=_<project>_::
-  The Google Cloud Platform project name to use for this invocation. If omitted, then the project from the service account credential is used
-
 *--num-test-runs*=_<repeatTests>_::
   The amount of times to run the test executions.
 
@@ -142,6 +139,9 @@ Configuration is read from flank.yml
 *--files-to-download*=_<filesToDownload>_[,_<filesToDownload>_...]::
   A list of paths that will be downloaded from the resulting bucket to the local results folder after the test is complete. These must be absolute paths (for example, --files-to-download /images/tempDir1,/data/local/tmp/tempDir2). Path names are restricted to the characters a-zA-Z0-9_-./+.
 
+*--project*=_<project>_::
+  The Google Cloud Platform project name to use for this invocation. If omitted, then the project from the service account credential is used
+
 *--local-result-dir*=_<localResultsDir>_::
   Saves test result to this local folder. Deleted before each run.
 
@@ -163,6 +163,9 @@ Configuration is read from flank.yml
 *--disable-results-upload*::
   Disables flank results upload on gcloud storage.
 
+*--app*=_<app>_::
+  The path to the application binary file. The path may be in the local filesystem or in Google Cloud Storage using gs:// notation.
+
 *--test*=_<test>_::
   The path to the binary file containing instrumentation tests. The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://.
 
@@ -175,9 +178,6 @@ Configuration is read from flank.yml
 *--no-auto-google-login*::
   Google account not logged in (default behavior). Use --auto-google-login to enable
 
-*--app*=_<app>_::
-  The path to the application binary file. The path may be in the local filesystem or in Google Cloud Storage using gs:// notation.
-
 *--use-orchestrator*::
   Whether each test runs in its own Instrumentation instance with the Android Test Orchestrator (default: Orchestrator is used. To disable, use --no-use-orchestrator). Orchestrator is only compatible with AndroidJUnitRunner v1.0 or higher. See https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator for more information about Android Test Orchestrator.
 
@@ -228,12 +228,12 @@ You can guide the Robo test to perform specific actions by recording a Robo Scri
 +
 Learn more at https://firebase.google.com/docs/test-lab/robo-ux-test#scripting. 
 
-*--additional-app-test-apks*=_<String=String>_[,_<String=String>_...]::
-  A list of app & test apks to include in the run. Useful for running multiple module tests within a single Flank run.
-
 *--legacy-junit-result*::
   Fallback for legacy xml junit results parsing.
 
+*--additional-app-test-apks*=_<String=String>_[,_<String=String>_...]::
+  A list of app & test apks to include in the run. Useful for running multiple module tests within a single Flank run.
+
 *--dump-shards*::
   Measures test shards from given test apks and writes them into android_shards.json file instead of executing.
 

test_runner/docs/ascii/flank.jar_-android-test-environment.adoc

@@ -4,7 +4,7 @@
 == Name
 
 flank.jar
--android-test-environment - Print available devices, OS versions, locales, provided software list and network configuration to test against
+-android-test-environment - Print available Android devices, Android OS versions list, locales, provided software, network configuration, orientation and IP blocks to test against
 
 // end::picocli-generated-man-section-name[]
 
@@ -19,7 +19,7 @@ flank.jar
 // tag::picocli-generated-man-section-description[]
 == Description
 
-Print available Android devices, Android OS versions list, locales, provided software and network configuration to test against
+Print available Android devices, Android OS versions list, locales, provided software, network configuration, orientation and IP blocks to test against
 
 // end::picocli-generated-man-section-description[]
 

test_runner/docs/ascii/flank.jar_-android-versions.adoc

@@ -29,6 +29,9 @@ Information about available software versions. For example prints list of availa
 *list*::
   List of OS versions available to test against
 
+*describe*::
+  List of OS versions available to test against
+
 // end::picocli-generated-man-section-commands[]
 
 // end::picocli-generated-full-manpage[]

test_runner/docs/ascii/flank.jar_-android.adoc

@@ -45,7 +45,7 @@ flank.jar
   Information about available locales on device
 
 *test-environment*::
-  Print available devices, OS versions, locales, provided software list and network configuration to test against
+  Print available Android devices, Android OS versions list, locales, provided software, network configuration, orientation and IP blocks to test against
 
 // end::picocli-generated-man-section-commands[]
 

test_runner/docs/ascii/flank.jar_-firebase-test-android-locales.adoc

@@ -29,6 +29,9 @@ Information about available locales on device. For example prints list of availa
 *list*::
   Print current list of locales available to test against
 
+*describe*::
+  Describe a locales 
+
 // end::picocli-generated-man-section-commands[]
 
 // end::picocli-generated-full-manpage[]

test_runner/docs/ascii/flank.jar_-firebase-test-android-models.adoc

@@ -29,6 +29,9 @@ Information about available models. For example prints list of available models
 *list*::
   Print current list of devices available to test against
 
+*describe*::
+  Describe android model 
+
 // end::picocli-generated-man-section-commands[]
 
 // end::picocli-generated-full-manpage[]

test_runner/docs/ascii/flank.jar_-firebase-test-android-run.adoc

@@ -133,9 +133,6 @@ Configuration is read from flank.yml
 *--shard-time*=_<shardTime>_::
   The max amount of seconds each shard should run.
 
-*--project*=_<project>_::
-  The Google Cloud Platform project name to use for this invocation. If omitted, then the project from the service account credential is used
-
 *--num-test-runs*=_<repeatTests>_::
   The amount of times to run the test executions.
 
@@ -154,6 +151,9 @@ Configuration is read from flank.yml
 *--files-to-download*=_<filesToDownload>_[,_<filesToDownload>_...]::
   A list of paths that will be downloaded from the resulting bucket to the local results folder after the test is complete. These must be absolute paths (for example, --files-to-download /images/tempDir1,/data/local/tmp/tempDir2). Path names are restricted to the characters a-zA-Z0-9_-./+.
 
+*--project*=_<project>_::
+  The Google Cloud Platform project name to use for this invocation. If omitted, then the project from the service account credential is used
+
 *--local-result-dir*=_<localResultsDir>_::
   Saves test result to this local folder. Deleted before each run.
 
@@ -175,6 +175,9 @@ Configuration is read from flank.yml
 *--disable-results-upload*::
   Disables flank results upload on gcloud storage.
 
+*--app*=_<app>_::
+  The path to the application binary file. The path may be in the local filesystem or in Google Cloud Storage using gs:// notation.
+
 *--test*=_<test>_::
   The path to the binary file containing instrumentation tests. The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://.
 
@@ -187,9 +190,6 @@ Configuration is read from flank.yml
 *--no-auto-google-login*::
   Google account not logged in (default behavior). Use --auto-google-login to enable
 
-*--app*=_<app>_::
-  The path to the application binary file. The path may be in the local filesystem or in Google Cloud Storage using gs:// notation.
-
 *--use-orchestrator*::
   Whether each test runs in its own Instrumentation instance with the Android Test Orchestrator (default: Orchestrator is used. To disable, use --no-use-orchestrator). Orchestrator is only compatible with AndroidJUnitRunner v1.0 or higher. See https://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator for more information about Android Test Orchestrator.
 
@@ -240,12 +240,12 @@ You can guide the Robo test to perform specific actions by recording a Robo Scri
 +
 Learn more at https://firebase.google.com/docs/test-lab/robo-ux-test#scripting. 
 
-*--additional-app-test-apks*=_<String=String>_[,_<String=String>_...]::
-  A list of app & test apks to include in the run. Useful for running multiple module tests within a single Flank run.
-
 *--legacy-junit-result*::
   Fallback for legacy xml junit results parsing.
 
+*--additional-app-test-apks*=_<String=String>_[,_<String=String>_...]::
+  A list of app & test apks to include in the run. Useful for running multiple module tests within a single Flank run.
+
 *--dump-shards*::
   Measures test shards from given test apks and writes them into android_shards.json file instead of executing.
 

test_runner/docs/ascii/flank.jar_-firebase-test-android-test-environment.adoc

@@ -4,7 +4,7 @@
 == Name
 
 flank.jar
--firebase-test-android-test-environment - Print available devices, OS versions, locales, provided software list and network configuration to test against
+-firebase-test-android-test-environment - Print available Android devices, Android OS versions list, locales, provided software, network configuration, orientation and IP blocks to test against
 
 // end::picocli-generated-man-section-name[]
 
@@ -19,7 +19,7 @@ flank.jar
 // tag::picocli-generated-man-section-description[]
 == Description
 
-Print available Android devices, Android OS versions list, locales, provided software and network configuration to test against
+Print available Android devices, Android OS versions list, locales, provided software, network configuration, orientation and IP blocks to test against
 
 // end::picocli-generated-man-section-description[]
 

test_runner/docs/ascii/flank.jar_-firebase-test-android-versions.adoc

@@ -29,6 +29,9 @@ Information about available software versions. For example prints list of availa
 *list*::
   List of OS versions available to test against
 
+*describe*::
+  List of OS versions available to test against
+
 // end::picocli-generated-man-section-commands[]
 
 // end::picocli-generated-full-manpage[]

test_runner/docs/ascii/flank.jar_-firebase-test-android.adoc

@@ -45,7 +45,7 @@ flank.jar
   Information about available locales on device
 
 *test-environment*::
-  Print available devices, OS versions, locales, provided software list and network configuration to test against
+  Print available Android devices, Android OS versions list, locales, provided software, network configuration, orientation and IP blocks to test against
 
 // end::picocli-generated-man-section-commands[]
 

test_runner/docs/ascii/flank.jar_-firebase-test-ios-locales.adoc

@@ -29,6 +29,9 @@ Information about available locales on device. For example prints list of availa
 *list*::
   Print current list of locales available to test against
 
+*describe*::
+  Describe a locales 
+
 // end::picocli-generated-man-section-commands[]
 
 // end::picocli-generated-full-manpage[]

test_runner/docs/ascii/flank.jar_-firebase-test-ios-models.adoc

@@ -29,6 +29,9 @@ Information about available models. For example prints list of available models
 *list*::
   Print current list of devices available to test against
 
+*describe*::
+  Describe iOS model 
+
 // end::picocli-generated-man-section-commands[]
 
 // end::picocli-generated-full-manpage[]

test_runner/docs/ascii/flank.jar_-firebase-test-ios-run.adoc

@@ -112,9 +112,6 @@ Configuration is read from flank.yml
 *--shard-time*=_<shardTime>_::
   The max amount of seconds each shard should run.
 
-*--project*=_<project>_::
-  The Google Cloud Platform project name to use for this invocation. If omitted, then the project from the service account credential is used
-
 *--num-test-runs*=_<repeatTests>_::
   The amount of times to run the test executions.
 
@@ -133,6 +130,9 @@ Configuration is read from flank.yml
 *--files-to-download*=_<filesToDownload>_[,_<filesToDownload>_...]::
   A list of paths that will be downloaded from the resulting bucket to the local results folder after the test is complete. These must be absolute paths (for example, --files-to-download /images/tempDir1,/data/local/tmp/tempDir2). Path names are restricted to the characters a-zA-Z0-9_-./+.
 
+*--project*=_<project>_::
+  The Google Cloud Platform project name to use for this invocation. If omitted, then the project from the service account credential is used
+
 *--local-result-dir*=_<localResultsDir>_::
   Saves test result to this local folder. Deleted before each run.
 
@@ -154,15 +154,15 @@ Configuration is read from flank.yml
 *--disable-results-upload*::
   Disables flank results upload on gcloud storage.
 
+*--test*=_<test>_::
+  The path to the test package (a zip file containing the iOS app and XCTest files). The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://. Note: any .xctestrun file in this zip file will be ignored if --xctestrun-file is specified.
+
 *--xctestrun-file*=_<xctestrunFile>_::
   The path to an .xctestrun file that will override any .xctestrun file contained in the --test package. Because the .xctestrun file contains environment variables along with test methods to run and/or ignore, this can be useful for customizing or sharding test suites. The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://.
 
 *--xcode-version*=_<xcodeVersion>_::
   The version of Xcode that should be used to run an XCTest. Defaults to the latest Xcode version supported in Firebase Test Lab. This Xcode version must be supported by all iOS versions selected in the test matrix.
 
-*--test*=_<test>_::
-  The path to the test package (a zip file containing the iOS app and XCTest files). The given path may be in the local filesystem or in Google Cloud Storage using a URL beginning with gs://. Note: any .xctestrun file in this zip file will be ignored if --xctestrun-file is specified.
-
 *--test-targets*=_<testTargets>_[,_<testTargets>_...]::
   A list of one or more test method names to run (default: run all test targets).
 

test_runner/docs/ascii/flank.jar_-firebase-test-ios-test-environment.adoc

@@ -4,7 +4,7 @@
 == Name
 
 flank.jar
--firebase-test-ios-test-environment - Print available devices, OS versions, locales, provided software list and network configuration to test against
+-firebase-test-ios-test-environment - Print available iOS devices, OS versions list, locales, provided software, network configuration, orientation and IP blocks to test against
 
 // end::picocli-generated-man-section-name[]
 
@@ -19,7 +19,7 @@ flank.jar
 // tag::picocli-generated-man-section-description[]
 == Description
 
-Print available iOS devices, iOS OS versions list, locales, provided software and network configuration to test against
+Print available iOS devices, OS versions list, locales, provided software, network configuration, orientation and IP blocks to test against
 
 // end::picocli-generated-man-section-description[]
 

test_runner/docs/ascii/flank.jar_-firebase-test-ios-versions.adoc

@@ -4,7 +4,7 @@
 == Name
 
 flank.jar
--firebase-test-ios-versions - Information about available software versions
+-firebase-test-ios-versions - Describe software versions
 
 // end::picocli-generated-man-section-name[]
 
@@ -29,6 +29,9 @@ Information about available software versions. For example prints list of availa
 *list*::
   List of OS versions available to test against
 
+*describe*::
+  List of OS versions available to test against
+
 // end::picocli-generated-man-section-commands[]
 
 // end::picocli-generated-full-manpage[]

test_runner/docs/ascii/flank.jar_-firebase-test-ios.adoc

@@ -36,13 +36,13 @@ flank.jar
   Information about available models
 
 *versions*::
-  Information about available software versions
+  Describe software versions
 
 *locales*::
   Information about available locales on device
 
 *test-environment*::
-  Print available devices, OS versions, locales, provided software list and network configuration to test against
+  Print available iOS devices, OS versions list, locales, provided software, network configuration, orientation and IP blocks to test against
 
 *screen-orientations*::
   Information about available orientation versions