Skip to content

docs: update testing docs for vrt #6136

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

Merged
merged 1 commit into from
May 30, 2025
Merged

docs: update testing docs for vrt #6136

merged 1 commit into from
May 30, 2025

Conversation

joshblack
Copy link
Member

Closes https://github.com/github/primer/issues/5249

Changelog

New

Changed

  • Add a note to our VRT testing docs to include running storybook

Removed

  • Remove our old docs on running storybook tests

Rollout strategy

  • None; if selected, include a brief description as to why

This is a change to contributor docs

@Copilot Copilot AI review requested due to automatic review settings May 29, 2025 15:08
@joshblack joshblack requested a review from a team as a code owner May 29, 2025 15:08
@joshblack joshblack requested a review from francinelucca May 29, 2025 15:08
Copy link

changeset-bot bot commented May 29, 2025

⚠️ No Changeset found

Latest commit: 61870c1

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@joshblack joshblack added the skip changeset This change does not need a changelog label May 29, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the testing documentation to clarify that Storybook must be running before Visual Regression Tests and removes the outdated Storybook tests guide.

  • Adds a note in testing.md to ensure Storybook is running locally before tests
  • Deletes the old storybook-tests.md file

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
contributor-docs/testing.md Clarify requirement for Storybook to be running
contributor-docs/storybook-tests.md Remove deprecated Storybook tests documentation
Comments suppressed due to low confidence (2)

contributor-docs/testing.md:113

  • The markdown bullet is missing a space after the dash and "setup" should be split into the verb form "set up". Consider changing to - section to set up your machine. You also need Storybook to be running locally before running any tests.
-section to setup your machine. You also need Storybook to be running locally before running any tests.

contributor-docs/storybook-tests.md:1

  • Ensure that all links or references to contributor-docs/storybook-tests.md have been updated or removed elsewhere in the docs to prevent broken links.
entire file removal

Copy link
Contributor

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 94.36 KB (0%)
packages/react/dist/browser.umd.js 94.55 KB (0%)

@@ -111,7 +111,8 @@ You can run these tests using Playwright locally or you can see the results of
these tests on GitHub through the CI workflow.

To get started locally, make sure to follow the [Prerequisites](#prerequisites)
section to setup your machine. If you're looking for a quick overview of the commands
section to setup your machine. You also need Storybook to be running locally
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did running script/test-e2e work for you @joshblack I was runnign into errors when i tried despite running docker and storybook

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@francinelucca I opened up: #6142 for this to fix it, seems like a change to vitest caused it to no longer work 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

perfect! thanksss

@joshblack joshblack added this pull request to the merge queue May 30, 2025
Merged via the queue into main with commit 256396d May 30, 2025
40 of 43 checks passed
@joshblack joshblack deleted the docs/update-vrt-guidance branch May 30, 2025 17:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset This change does not need a changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants