Skip to content

Commit ba8fde1

Browse files
authored
Update README.md
1 parent 63bd0aa commit ba8fde1

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,21 @@ This will
3131
- update version numbers, make a corresponding `git commit` and a `git tag`;
3232
- push this commit and tag to Github, which triggers the Github Action that makes a new Github Release and publishes the package to PYPI.
3333

34+
### Github workflow testing
35+
36+
[![widget test](https://github.com/osscar-org/widget-code-input/actions/workflows/widget-test.yml/badge.svg)](https://github.com/osscar-org/widget-code-input/actions/workflows/widget-test.yml)
37+
38+
39+
40+
If the `widget test` fails, it indicates there is something wrong with the code, and the widget is NOT
41+
being displayed correctly in the test.
42+
43+
[![screenshot comparison](https://github.com/osscar-org/widget-code-input/actions/workflows/screenshot-comparison.yml/badge.svg)](https://github.com/osscar-org/widget-code-input/actions/workflows/screenshot-comparison.yml)
44+
45+
46+
If the `widget test` passes but the `screenshot comparison` fails, it indicates the appearance of the widget
47+
is different from the previous version. In this case, you'll need to manually download the artifact from
48+
the `widget test` and use it to replace the `widget-sample.png` figure in the `test` folder.
3449

3550
## Acknowledgements
3651

0 commit comments

Comments
 (0)