From 438e0c598a6d931a99e2b3ef093eacff7c0ae3ac Mon Sep 17 00:00:00 2001 From: Benoit Marty Date: Thu, 27 Jul 2023 23:10:26 +0200 Subject: [PATCH] Update the recipe about screenshots recording. --- docs/screenshot_testing.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/screenshot_testing.md b/docs/screenshot_testing.md index 37299af7fc..ca69acaf4a 100644 --- a/docs/screenshot_testing.md +++ b/docs/screenshot_testing.md @@ -30,6 +30,14 @@ If installed correctly, `git push` and `git pull` will now include LFS content. ## Recording +Recording of screenshots is done by triggering the GitHub action [Record screenshots](https://github.com/vector-im/element-x-android/actions/workflows/recordScreenshots.yml), to avoid differences of generated binary files (png images) depending on developers' environment. + +So basically, you will create a branch, do some commits with your work on it, then push your branch, trigger the GitHub action to record the screenshots (only if you think preview may have changed), and finally create a pull request. The GitHub action will record the screenshots and commit the changes to the branch. + +You can still record the screenshots locally, but please do not commit the changes. + +To record the screenshot locally, run the following command: + ```shell ./gradlew recordPaparazziDebug ```