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

Storybook8 update - DO NOT MERGE UNTIL 2025 #514

Merged
merged 10 commits into from
Feb 19, 2025
Merged

Conversation

isacoder
Copy link
Collaborator

@isacoder isacoder commented Nov 15, 2024

Description

This PR is to upgrade the UI Kit dependencies to use Storybook 8

Considerations on Implementation

  • The upgrade follows the Storybook Migration Guide from 6.x to 8.0.
  • Knobs retro-compatibility: This update retains compatibility with Knobs. Migration to Controls will be addressed in a separate PR.
  • Node.js version requirement: Storybook 8 requires Node.js 18. Updated instructions for running the project with Node 18 have been included.

Pending for a next PR

  • The addDecorator method has been deprecated. The JSX Decorator addon has not been updated in three years and is incompatible with Storybook 8.
  • A workaround has been shared in the addon’s issue tracker.
    This test branch implements the workaround but requires updating all component stories to use Controls for compatibility, need to review the decision to use it with the team.

Reviewing/Testing steps

  • Install a clean version of the UI Kit using npm ci with Node.js 18.
  • Verify that Storybook components are displaying correctly and that Knobs functionality remains.
  • Verify Router in Global page functionality.
  • Review theme is working as expected.
Screenshot 2024-11-20 at 13 16 24

@isacoder isacoder self-assigned this Nov 15, 2024
@isacoder isacoder marked this pull request as ready for review November 20, 2024 05:02
@isacoder isacoder added the Project Dependency For Future Standard use, this highlights features required in upcoming projects. label Nov 20, 2024
@isacoder isacoder requested a review from atomworks November 20, 2024 05:02
@isacoder isacoder changed the title Storybook8 update Storybook8 update - DO NOT MERGE UNTIL 2025 Dec 2, 2024
Copy link
Collaborator

@atomworks atomworks left a comment

Choose a reason for hiding this comment

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

All looks good, thank you. Ready for deployment in the new year!

@isacoder isacoder merged commit ed2fb8c into main Feb 19, 2025
1 check passed
@isacoder isacoder deleted the feature/storybook8-update branch February 19, 2025 05:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Project Dependency For Future Standard use, this highlights features required in upcoming projects.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants