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 legacyMdx1 & @storybook/mdx1-csf automigration #26102

Merged
merged 6 commits into from
Feb 20, 2024

Conversation

ndelangen
Copy link
Member

Closes #25433

What I did

apply more migrations listed in #25433

  • remove the features. legacyMdx1 field from main.ts
  • un-install the @storybook/mdx1-csf package

I do not know how I'd do this:

jsxOptions (addon option from addon-docs) should be removed (though I'm not sure if there's more to it)

Perhaps @shilman or @yannbf should elaborate this task?

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

  • Create a sandbox
  • force this sandbox to use legacyMdx1
  • upgrade this sandbox by running the CLI manually
  • expect the legacyMdx1 property to be removed from main.ts features object.
  • expect the @storybook/mdx1-csf dependency to get uninstalled.

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 self-assigned this Feb 19, 2024
@ndelangen ndelangen added maintenance User-facing maintenance tasks cli ci:normal labels Feb 19, 2024
@ndelangen ndelangen marked this pull request as ready for review February 20, 2024 08:21
Copy link
Contributor

@valentinpalkovic valentinpalkovic left a comment

Choose a reason for hiding this comment

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

LGTM Code-Wise! Please make sure the feature is tested before merging.

@ndelangen ndelangen merged commit 2cc319a into next Feb 20, 2024
58 checks passed
@ndelangen ndelangen deleted the norbert/automigrations-mdx1 branch February 20, 2024 16:14
@github-actions github-actions bot mentioned this pull request Feb 20, 2024
26 tasks
@shilman shilman changed the title CLI: Automigration remove legacyMdx1 & uninstall @storybook/mdx1-csf CLI: Add legacyMdx1 & @storybook/mdx1-csf automigration Feb 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:normal cli maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Auto migration: Detect .stories.mdx and @storybook/mdx1-csf usage
2 participants