Skip to content

Commit e053a42

Browse files
committed
README: document a quirk about the dark mode test case
On non-Linux platforms, the prerequisite screenshots will not exist before the first run of that test case, which will save them (so that subsequent runs will succeed). This quirk might surprise developers on platforms other than Linux, therefore it is a good idea to document it. Signed-off-by: Johannes Schindelin <[email protected]>
1 parent 4693725 commit e053a42

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,5 @@
1313
/node_modules/
1414
/test-results/
1515
/playwright-report/
16+
/tests/git-scm.spec.js-snapshots/*-darwin.png
17+
/tests/git-scm.spec.js-snapshots/*-win32.png

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,6 +189,9 @@ $ PLAYWRIGHT_TEST_URL='http://localhost:5000/' npx playwright test --project=fir
189189
190190
For more fine-grained testing, you can pass `-g <regex>` to run only the matching test cases.
191191
192+
> [!NOTE]
193+
> When running the test suite on platforms other than Linux, the first run will "fail" in the `dark mode` test case. That is expected! This test case relies on previously-generated screenshots that are stored in `tests/git-scm.spec.js-snapshots/`, and for bandwidth reasons only the Linux ones are committed in the Git repository (because they are required to run the PR/CI builds). The first run will store those screenshots so that subsequent runs of this test case will succeed, though.
194+
192195
## Update manual pages
193196
194197
First, install the Ruby prerequisites:

0 commit comments

Comments
 (0)