-
Notifications
You must be signed in to change notification settings - Fork 218
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add storybook snapshot update command to testing documentation #3728
Conversation
Full-stack documentation: https://docs.openverse.org/_preview/3728 Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again. You can check the GitHub pages deployment action list to see the current status of the deployments. Changed files 🔄: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for updating the documentation!
Ah! It looks like it's not |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! It'll be helpful to also have documentation on how to update the snapshots for a single test.
@@ -17,39 +17,45 @@ Storybook visual regression tests, read | |||
|
|||
2. Run unit tests for the frontend. | |||
|
|||
```console |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is present in many other files too, would you mind opening an issue to fix these? It'll be a simple change that hopefully gives a new contributor a reason to set things up locally!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm about to drop another PR that fixes these and adds a pre-commit check for it, actually!
Description
This came up in #3727 (comment).
This PR adds the storybook snapshot update command to the frontend testing documentation, so folks updating aspects of the frontend have all the necessary commands readily available in the same document.
I also removed all the preceding
$
characters from these commands. Because they're of theconsole
type (or perhaps just a code block in general), Sphinx makes it easy to copy the commands from the browser and paste into a shell. However, those commands come with the leading$
character too which makes them hard to paste and run immediately. This PR removes them all for this document, I'll have a follow up PR that removes them everywhere else.Testing Instructions
View the generated documentation output and verify it looks correct.
Checklist
Update index.md
).main
) or a parent feature branch.Developer Certificate of Origin
Developer Certificate of Origin