improve devicelab docs #6206
improve devicelab docs #6206
Conversation
| # Running tests locally | ||
|
|
||
| Do make sure your tests pass locally before deploying to the CI environment. | ||
| Below is a handful of commands that run tests in a fashion very close to how the |
There was a problem hiding this comment.
s/in a fashion very close/in a similar way/
| CI environment runs them. These commands are also useful when you need to | ||
| reproduce a CI test failure locally. | ||
|
|
||
| To run a test use option `-t` (`--task`): |
There was a problem hiding this comment.
To avoid ambiguity, please use a comma to split these statements. ("To xxx, do yyy.") Do the same for the following commands.
|
|
||
| # Reproducing broken builds locally | ||
|
|
||
| So you noticed that a commit broke one of the tests. On |
There was a problem hiding this comment.
Revise: "If a commit caused a test to fail, the dashboard might look something like this:"
|  | ||
|
|
||
| The red circle tells you that a test failed. The number inside tells you how | ||
| many times the devicelab attempted to run the test before giving up on it. |
There was a problem hiding this comment.
"devicelab" (a.k.a. "cocoon") is our test lab where we test Flutter on physical devices. There's only one devicelab. I clarified at the top what it is.
| The red circle tells you that a test failed. The number inside tells you how | ||
| many times the devicelab attempted to run the test before giving up on it. | ||
|
|
||
| To reproduce the breakage locally checkout the corresponding Flutter revision. |
There was a problem hiding this comment.
It's not clear to me what this means: Perform a checkout operation on the Flutter revision (SDK?), or see the Flutter revision number?
There was a problem hiding this comment.
I meant git checkout. Made it more explicit. This document is not user-facing. This is meant for our team. I expect everyone on the team already knows how to checkout a specific revision of Flutter.
b10dead to
66a94e8
Compare
|
lgtm, thanks for the fixes! |
/cc @sethladd @qchong