Skip to content

Commit

Permalink
add cheatsheet
Browse files Browse the repository at this point in the history
  • Loading branch information
jBorkowska committed Dec 4, 2024
1 parent 9842dea commit 05c077c
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 10 deletions.
7 changes: 6 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@
}
},
"content": {
"showPageTitle": false
"showPageTitle": false,
"zoomImages": true
},
"tabs": [
{
Expand Down Expand Up @@ -85,6 +86,10 @@
"title": "Logs and test results",
"href": "/documentation/logs"
},
{
"title": "Cheatsheet",
"href": "/documentation/cheatsheet"
},
{
"title": "Supported platforms",
"href": "/documentation/supported-platforms"
Expand Down
Binary file added docs/assets/cheatsheet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/ci/firebase-test-lab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,9 @@ Farm][aws_device_farm].
--app build/app/outputs/apk/debug/app-debug.apk \
--test build/app/outputs/apk/androidTest/debug/app-debug-androidTest.apk \
--timeout 1m \
--environment-variables clearPackageData=true \
--results-bucket=<RESULTS_BUCKET> \
--results-dir=<RESULTS_DIRECTORY>
--device model=MediumPhone.arm,version=34,locale=en,orientation=portrait \
--record-video \
--environment-variables clearPackageData=true
```

<Info>
Expand Down
5 changes: 5 additions & 0 deletions docs/documentation/cheatsheet.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Cheatsheet
---

<Image src="/assets/cheatsheet.png"/>
12 changes: 6 additions & 6 deletions docs/documentation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ Check out our video version of this tutorial on YouTube!
```
flutter pub global activate patrol_cli
```
</Step>

[Patrol CLI] (command-line interface) is a small program that enables running
Patrol UI tests. It is necessary to run UI tests (`flutter test` won't work! [Here's why]).
<Info>
Make sure to add `patrol` to your `PATH` environment variable.
It's explained in the [README](https://pub.dev/packages/patrol_cli#installation).
</Info>

</Step>

<Step>
Verify that installation was successful and your environment is set up properly:
Expand Down Expand Up @@ -166,7 +166,7 @@ Check out our video version of this tutorial on YouTube!
<Step>
Add these 2 lines to the `defaultConfig` section:

```groovy
```groovy title="android/app/build.gradle"
testInstrumentationRunner "pl.leancode.patrol.PatrolJUnitRunner"
testInstrumentationRunnerArguments clearPackageData: "true"
```
Expand All @@ -175,7 +175,7 @@ Check out our video version of this tutorial on YouTube!
<Step>
Add this section to the `android` section:

```groovy
```groovy title="android/app/build.gradle"
testOptions {
execution "ANDROIDX_TEST_ORCHESTRATOR"
}
Expand All @@ -185,7 +185,7 @@ Check out our video version of this tutorial on YouTube!
<Step>
Add this line to `dependencies` section:

```groovy
```groovy title="android/app/build.gradle"
androidTestUtil "androidx.test:orchestrator:1.4.2"
```
</Step>
Expand All @@ -194,7 +194,7 @@ Check out our video version of this tutorial on YouTube!
<Warning>
Bear in mind that ProGuard can lead to some problems if not well configured, potentially causing issues such as `ClassNotFoundException`s.
Keep all the Patrol packages or disable ProGuard in `android/app/build.gradle`:
```groovy
```groovy title="android/app/build.gradle"
...
buildTypes {
release {
Expand Down

0 comments on commit 05c077c

Please sign in to comment.