aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEthan Lee <ethanalee@google.com>2025-12-18 03:38:25 +0000
committerEthan Lee <ethanalee@google.com>2025-12-20 16:11:51 -0800
commita7c442171859262d3fa27df3fecf6a88e7316e70 (patch)
treed3fc07c8fbb4cb2fd23eec58ecee84175a51eb0d
parent1f39ab54702217a4b686a5902aeec7e5cad36929 (diff)
downloadgo-x-pkgsite-a7c442171859262d3fa27df3fecf6a88e7316e70.tar.xz
tests: update docs for updating screenshot tests
Change-Id: I85997dce21dae9c40ca68eb4007e7a724e519094 Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/731021 Reviewed-by: Jonathan Amsterdam <jba@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> kokoro-CI: kokoro <noreply+kokoro@google.com> Auto-Submit: Ethan Lee <ethanalee@google.com>
-rw-r--r--tests/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/tests/README.md b/tests/README.md
index 7f9fdfb2..8ac69e5b 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -94,6 +94,14 @@ Tests in `./tests/screentest/testcases.txt` run for all environments and
are suitable for tests with data that is consistent between environments or
static pages.
+### Updating the tests
+
+Update screen shot diffs using the following:
+
+1. Run `./tests/screentest/run.sh -update ci` to collect the updated screenshots.
+2. Optionally use `./tests/screentest/run.sh -update -run <test> ci` to update specific tests.
+3. Copy the new screenshots from `./tests/screentest/output` into `./tests/screentest/testdata/testcases`
+
### Understanding Test Failures
If the tests fail with diffs, a file with the diffs will be created in the