chore: add manual testing guide to storybook#4015
Conversation
|
castastrophe
added
documentation
File metricsSummaryTotal size: 1.43 MB* 🎉 No changes detected in any packages * Size is the sum of all main files for packages in the library.* An ASCII character in UTF-8 is 8 bits or 1 byte. |
📚 Branch previewPR #4015 has been deployed to Azure Blob Storage: https://spectrumcss.z13.web.core.windows.net/pr-4015/index.html. |
marissahuysentruyt
left a comment
marissahuysentruyt
left a comment
There was a problem hiding this comment.
Just some questions for you 😊
|
|
||
| ### Configure Chromatic access | ||
|
|
||
| Run `yarn refresh` to create or update your `.env` file with the necessary environment variables. Ensure the `CHROMATIC_PROJECT_TOKEN` is set correctly. |
There was a problem hiding this comment.
Is it helpful at all to note that the chromatic.config.json in the storybook directory should also have the chromatic project token?
There was a problem hiding this comment.
I could add that though that file is created by the yarn refresh script so updating it manually will get blown away once you refresh.
| ### Basic test execution | ||
|
|
||
| Because the base branch is not `main`, VRT builds are kicked off locally. This makes the build available in the Chromatic UI in order to create a manual review. To get an up-to-date comparison of your branch against the base branch, run the following command on the branch you are testing. | ||
|
|
||
| ```bash | ||
| yarn test | ||
| ``` |
There was a problem hiding this comment.
I was running into issues with yarn test and getting a few errors. I'd gotten one about failing to build the preview, and then another with "can't evaluate main.js," so the test command was either hanging, or was just exit. I ended up running yarn nx reset, and poof- yarn test worked! Is it worth mentioned that at all, like sometimes the Nx cache need to be cleared or something?
This also could have just been me, and/or common knowledge that I missed 🤣
castastrophe
force-pushed
the
castastrophe/docs-add-manual-testing-guide
branch
from
1ebe503 to
5863acc
Compare
2 participants
Description
Because the process for running VRTs against the
spectrum-twobase branch differ from our automated system, this PR adds documentation to help developers through the process.How and where has this been tested?
Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.
Validation steps
Follow the instructions listed here on a branch based against
spectrum-twoand highlight any gaps in the documentation.To-do list