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

feat(Storybook): upgrade v7 #280

Merged
merged 90 commits into from
Nov 9, 2023
Merged

Conversation

arwehrman
Copy link
Contributor

@arwehrman arwehrman commented Jul 11, 2023

Description

This PR upgrades LUI to Storybook v7
v7 Migration Guide

Changes:

  • preview.js and main.js changed to ESM format
  • main.js includes framework
  • package.json commands to build Storybook have changed
    • old commands start-storybook and build-storybook
    • new commands storybook dev and storybook build
  • changes references of @storybook/addon-docs to @storybook/blocks
  • removes references to Canvas from all docs
  • updates doc template to populate the correct fields
  • changes references of @storybook/api to @storybook/manager-api
  • adds the ability to link Figma files in components

Items to Note:

  • Docs now appear in Sidebar with the stories
  • Docs no longer use .stories.mdx please use .mdx
  • Using MDX2 for mdx files reference

Files Removed:

  • register.js in .storybook folder- code was moved to manager.js
    - lightning-ui-docs/.storybook/controls-delete/argTypes/index.js - had a version of the createModeControl function
  • controls-delete folder and contents, old code no longer using

References

LUI-906

Testing

  • clone branch
  • yarn clean
  • yarn install
  • yarn start
  • Storybook should start up

Automation

Automation test will need to be updated for the following components as the URL for them has changed:

  • Button
  • Card
  • CardContent
  • Checkboxes
  • Control
  • Keyboard
  • ListItem
  • Radio
  • Slider
  • Toggle

Checklist

  • all commented code has been removed
  • any new console issues have been resolved
  • code linter and formatter has been run
  • test coverage meets repo requirements
  • PR name matches the expected semantic-commit syntax

@arwehrman arwehrman added DO NOT MERGE WIP In progress but could use an initial review labels Jul 11, 2023
@arwehrman arwehrman added enhancement New feature or request and removed WIP In progress but could use an initial review DO NOT MERGE labels Jul 19, 2023
@arwehrman arwehrman force-pushed the feature/Storybook-upgrade-v7 branch from 7b11ccd to 6aa6f64 Compare July 19, 2023 21:59
@svc-lightning-ui-components
Copy link
Collaborator

Sanity Tests Execution Failed.

1 similar comment
@svc-lightning-ui-components
Copy link
Collaborator

Sanity Tests Execution Failed.

@arwehrman arwehrman force-pushed the feature/Storybook-upgrade-v7 branch from dd8f65a to cc06b18 Compare August 15, 2023 15:19
@arwehrman arwehrman requested a review from slhay28 as a code owner August 15, 2023 15:19
@arwehrman arwehrman force-pushed the feature/Storybook-upgrade-v7 branch from b1edcf6 to a8733f5 Compare August 15, 2023 16:21
@svc-lightning-ui-components
Copy link
Collaborator

Test Execution Failed.

1 similar comment
@svc-lightning-ui-components
Copy link
Collaborator

Test Execution Failed.

@arwehrman arwehrman force-pushed the feature/Storybook-upgrade-v7 branch from 7346b8a to d3cb6f2 Compare August 25, 2023 13:44
@svc-lightning-ui-components
Copy link
Collaborator

Test Execution Failed.

1 similar comment
@svc-lightning-ui-components
Copy link
Collaborator

Test Execution Failed.

@erautenberg erautenberg changed the title Feature/storybook upgrade v7 feat(Storybook): upgrade v7 Aug 28, 2023
@svc-lightning-ui-components
Copy link
Collaborator

Test Execution Failed.

@arwehrman arwehrman force-pushed the feature/Storybook-upgrade-v7 branch from 0d341cd to 4b2a14b Compare November 8, 2023 17:16
@svc-lightning-ui-components
Copy link
Collaborator

Test Execution Failed.

@arwehrman arwehrman merged commit 5e39f37 into develop Nov 9, 2023
5 checks passed
@arwehrman arwehrman deleted the feature/Storybook-upgrade-v7 branch November 9, 2023 14:30
svc-lightning-ui-components pushed a commit that referenced this pull request Nov 9, 2023
@svc-lightning-ui-components
Copy link
Collaborator

🎉 This PR is included in version @lightningjs/ui-components-theme-base-v1.2.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

svc-lightning-ui-components pushed a commit that referenced this pull request Nov 9, 2023
# [@lightningjs/ui-components-v2.16.0](https://github.com/rdkcentral/Lightning-UI-Components/compare/@lightningjs/ui-components-v2.15.1...@lightningjs/ui-components-v2.16.0) (2023-11-09)

### Bug Fixes

* lock lng core version to avoid bug introduced in 2.12.0 ([#400](#400)) ([a128329](a128329))

### Features

* **Storybook:** upgrade v7 ([#280](#280)) ([5e39f37](5e39f37))
@svc-lightning-ui-components
Copy link
Collaborator

🎉 This PR is included in version @lightningjs/ui-components-v2.16.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

svc-lightning-ui-components pushed a commit that referenced this pull request Nov 9, 2023
# [@lightningjs/ui-components-test-utils-v1.5.0](https://github.com/rdkcentral/Lightning-UI-Components/compare/@lightningjs/ui-components-test-utils-v1.4.3...@lightningjs/ui-components-test-utils-v1.5.0) (2023-11-09)

### Bug Fixes

* lock lng core version to avoid bug introduced in 2.12.0 ([#400](#400)) ([a128329](a128329))

### Features

* **Storybook:** upgrade v7 ([#280](#280)) ([5e39f37](5e39f37))
@svc-lightning-ui-components
Copy link
Collaborator

🎉 This PR is included in version @lightningjs/ui-components-test-utils-v1.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants