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

Manager: Add migration note about react 18 #25435

Merged
merged 3 commits into from
Jan 10, 2024

Conversation

ndelangen
Copy link
Member

What I did

I added a migration note informing addon creators about the move to react 18, and the API changes because of it.

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!

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 migration note about react 18 in the manager Manager: Add migration note about react 18 Jan 3, 2024
@ndelangen ndelangen self-assigned this Jan 3, 2024
@ndelangen ndelangen added api: addons documentation ci:docs Run the CI jobs for documentation checks only. labels Jan 3, 2024
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@ndelangen, thank you for taking the time to put together this pull request and add this item to the migration. Appreciate it 🙏 ! I'll check the remainder of the documentation and adjust accordingly in a follow-up pull request. I left a small item for you to look into when you're able. To unblock this, I'm going to approve it so that you can merge it once the feedback is addressed.

MIGRATION.md Outdated
@@ -339,6 +340,26 @@

## From version 7.x to 8.0.0

### Manager addons are now rendered with react 18

The UI added to the manager via addon, are now rendered with react 18.
Copy link
Contributor

Choose a reason for hiding this comment

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

@ndelangen when you have a moment can you adjust this sentence to be:
"The UI added to the manager via addons is now rendered with React 18."

Also, can you capitalize react in the heading and adjust the link above accordingly?

MIGRATION.md Outdated Show resolved Hide resolved
MIGRATION.md Outdated Show resolved Hide resolved
MIGRATION.md Outdated Show resolved Hide resolved
@ndelangen ndelangen merged commit feb4a6a into next Jan 10, 2024
18 checks passed
@ndelangen ndelangen deleted the norbert/migration-note-react18-manager branch January 10, 2024 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: addons ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants