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

Nextjs: Migrate from config to previewAnnotations #24178

Merged
merged 1 commit into from Sep 15, 2023

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Sep 14, 2023

Closes #

What I did

This PR migrates Next.js's preset and gets rid of the following warning that affects users:

WARN You (or an addon) are using the 'config' preset field. This has been replaced by 'previewAnnotations' and will be removed in 8.0

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

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

  1. Run a sandbox for nextjs, e.g. yarn task --task sandbox --start-from auto --template nextjs/default-ts
  2. Run Storybook
  3. See no warning for previewAnnotations

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>

@yannbf yannbf added bug patch:yes Bugfix & documentation PR that need to be picked to main branch nextjs ci:merged Run the CI jobs that normally run when merged. labels Sep 14, 2023
@ndelangen ndelangen merged commit 896b2e7 into next Sep 15, 2023
71 of 72 checks passed
@ndelangen ndelangen deleted the yann/nextjs-config-to-preview-annotations branch September 15, 2023 08:12
storybook-bot pushed a commit that referenced this pull request Sep 15, 2023
…iew-annotations

Nextjs: Migrate from config to previewAnnotations
(cherry picked from commit 896b2e7)
@github-actions github-actions bot mentioned this pull request Sep 15, 2023
6 tasks
storybook-bot pushed a commit that referenced this pull request Sep 15, 2023
…iew-annotations

Nextjs: Migrate from config to previewAnnotations
(cherry picked from commit 896b2e7)
storybook-bot pushed a commit that referenced this pull request Sep 15, 2023
…iew-annotations

Nextjs: Migrate from config to previewAnnotations
(cherry picked from commit 896b2e7)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Sep 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:merged Run the CI jobs that normally run when merged. nextjs 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.

None yet

3 participants