Skip to content
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

CLI: Add Visual Tests addon install auto-migration when upgrading to 8.0.x #26766

Merged
merged 14 commits into from
Apr 10, 2024

Conversation

ndelangen
Copy link
Member

@ndelangen ndelangen commented Apr 8, 2024

Closes #26665

What I did

  • I added an auto-migration that adds the @chromatic-com/storybook addon for visual regression testing.
  • Wrote a test for the check method of the above auto-migration.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

I ran this manually on my machine:

  1. I created a sandbox
  2. I removed the '@chromatic-dom/storybook' entry in main.ts under addons.
  3. I ran ../../code/lib/cli/bin/index.js upgrade
  4. I observed the auto-migration being requested
  5. I replied "yes"
  6. It ran successfully.

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@ndelangen ndelangen changed the title add VTA automigration CLI: Add VTA addon via auto-migration when upgrading from 7 > 8 Apr 8, 2024
Copy link

nx-cloud bot commented Apr 8, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 90055cb. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@ndelangen ndelangen marked this pull request as ready for review April 9, 2024 06:39
@ndelangen ndelangen marked this pull request as draft April 10, 2024 08:38
@shilman shilman changed the title CLI: Add VTA addon via auto-migration when upgrading from 7 > 8 CLI: Add Visual Tests addon install auto-migration when upgrading to 8.0.x Apr 10, 2024
@ndelangen ndelangen marked this pull request as ready for review April 10, 2024 08:51
return dedent`
New to Storybook 8: Storybook's Visual Tests addon helps you catch unintentional changes/bugs in your stories. The addon is powered by Chromatic, a cloud-based testing tool developed by Storybook's core team.

Learn more: storybook.js.org/docs/writing-tests/visual-testing
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Learn more: storybook.js.org/docs/writing-tests/visual-testing
Learn more: ${chalk.yellow('https://storybook.js.org/docs/writing-tests/visual-testing'})

Copy link
Contributor

Choose a reason for hiding this comment

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

something about long URLs getting chopped up and not being copy-pastable when inside boxen. So I think we might want to keep it as short as possible.

Copy link
Member

Choose a reason for hiding this comment

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

FWIW the Chromatic CLI uses cyan for links.

@vanessayuenn vanessayuenn added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Apr 10, 2024
code/lib/cli/src/automigrate/fixes/vta.ts Outdated Show resolved Hide resolved
code/lib/cli/src/automigrate/fixes/vta.ts Outdated Show resolved Hide resolved
code/lib/cli/src/automigrate/fixes/vta.ts Show resolved Hide resolved
code/lib/cli/src/automigrate/fixes/vta.ts Outdated Show resolved Hide resolved
@ndelangen ndelangen merged commit c9fbb76 into next Apr 10, 2024
54 of 61 checks passed
@ndelangen ndelangen deleted the norbert/vta-added-on-upgrade branch April 10, 2024 15:40
storybook-bot pushed a commit that referenced this pull request Apr 10, 2024
CLI: Add Visual Tests addon install auto-migration when upgrading to 8.0.x
(cherry picked from commit c9fbb76)
storybook-bot pushed a commit that referenced this pull request Apr 10, 2024
CLI: Add Visual Tests addon install auto-migration when upgrading to 8.0.x
(cherry picked from commit c9fbb76)
storybook-bot pushed a commit that referenced this pull request Apr 11, 2024
CLI: Add Visual Tests addon install auto-migration when upgrading to 8.0.x
(cherry picked from commit c9fbb76)
storybook-bot pushed a commit that referenced this pull request Apr 11, 2024
CLI: Add Visual Tests addon install auto-migration when upgrading to 8.0.x
(cherry picked from commit c9fbb76)
@github-actions github-actions bot mentioned this pull request Apr 11, 2024
12 tasks
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automigrations ci:normal cli feature request patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automigration for adding VTA on upgrade
8 participants