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

chore(deps): upgraded storybook #95

Merged
merged 1 commit into from
Mar 25, 2024
Merged

chore(deps): upgraded storybook #95

merged 1 commit into from
Mar 25, 2024

Conversation

cTux
Copy link
Collaborator

@cTux cTux commented Mar 25, 2024

Type

enhancement


Description

  • Upgraded Storybook and its addons to version 8.0.4, ensuring compatibility with the latest features and improvements.
  • Updated @types/react to version 18.2.70 to keep type definitions up to date.
  • Updated the lock file to reflect these dependency upgrades.

Changes walkthrough

Relevant files
Dependencies
package.json
Upgrade Storybook and Related Dependencies                             

package.json

  • Upgraded Storybook and its addons from version 7.6.17 to 8.0.4.
  • Updated @types/react from version 18.2.69 to 18.2.70.
  • +8/-8     
    pnpm-lock.yaml
    Update Lock File for Dependency Upgrades                                 

    pnpm-lock.yaml

  • Updated dependencies to match the new versions specified in
    package.json.
  • +897/-1753

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @cTux cTux self-assigned this Mar 25, 2024
    @github-actions github-actions bot added the enhancement New feature or request label Mar 25, 2024
    Copy link
    Contributor

    PR Description updated to latest commit (49f34b7)

    Copy link
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    1, because the PR primarily involves version updates in the package.json file, which is straightforward and does not require in-depth code review. However, ensuring compatibility and checking for deprecated features or breaking changes in the upgraded versions is essential.

    🧪 Relevant tests

    No

    🔍 Possible issues

    Dependency Conflicts: Upgrading multiple dependencies simultaneously could introduce conflicts between them if they rely on different versions of the same package.

    Breaking Changes: Major version upgrades, such as from 7.x to 8.x for Storybook and its addons, might include breaking changes that could affect the existing setup or configurations.

    🔒 Security concerns

    No

    Code feedback:

    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

    The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

    • When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    
    [pr_reviewer]
    some_config1=...
    some_config2=...
    

    See the review usage page for a comprehensive guide on using this tool.

    Copy link
    Contributor

    github-actions bot commented Mar 25, 2024

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Best practice
    Pin Storybook dependency versions to avoid potential breaking changes.

    Consider pinning your Storybook dependency versions instead of using the caret (^) version
    range. This can help ensure that your project is built with a specific version, reducing
    the risk of introducing breaking changes or inconsistencies due to automatic updates.

    package.json [39-44]

    -"@storybook/addon-actions": "^8.0.4",
    -"@storybook/addon-essentials": "^8.0.4",
    -"@storybook/addon-interactions": "^8.0.4",
    -"@storybook/addon-links": "^8.0.4",
    -"@storybook/react": "^8.0.4",
    -"@storybook/react-vite": "^8.0.4",
    +"@storybook/addon-actions": "8.0.4",
    +"@storybook/addon-essentials": "8.0.4",
    +"@storybook/addon-interactions": "8.0.4",
    +"@storybook/addon-links": "8.0.4",
    +"@storybook/react": "8.0.4",
    +"@storybook/react-vite": "8.0.4",
     
    Perform thorough testing after upgrading major dependencies.

    After upgrading dependencies, especially major versions, it's crucial to perform thorough
    testing, including unit tests, integration tests, and manual testing of the Storybook UI,
    to ensure that there are no regressions or unexpected behavior changes.

    package.json [43]

    -"@storybook/react": "^8.0.4",
    +# This suggestion involves testing procedures, not a direct code change.
     
    Possible issue
    Check and upgrade dependencies related to Storybook for compatibility.

    Ensure compatibility of the newly upgraded Storybook version with other dependencies,
    especially those that are closely integrated with Storybook, such as
    "@storybook/testing-library". It might require upgrading these dependencies as well to
    avoid compatibility issues.

    package.json [45]

    -"@storybook/testing-library": "^0.2.2",
    +"@storybook/testing-library": "^0.3.0", # Example version, ensure to check for the latest compatible version
     
    Maintainability
    Verify and update deprecated configurations after major version upgrades.

    After upgrading major versions of dependencies, it's a good practice to verify if there
    are any deprecated features or configurations that need to be updated or removed. This
    includes checking the Storybook configuration files and any custom addons or integrations.

    package.json [43]

    -"@storybook/react": "^8.0.4",
    +# This suggestion involves checking and updating configuration files and code, not a direct code change.
     
    Enhancement
    Update project documentation to reflect dependency upgrades.

    Consider reviewing and updating the project's documentation, especially the 'Getting
    Started' or 'Setup' sections, to reflect the new versions of Storybook and any other major
    dependency updates. This helps new contributors and team members to set up their
    development environment correctly.

    package.json [43]

    -"@storybook/react": "^8.0.4",
    +# This suggestion involves updating documentation, not a direct code change.
     

    ✨ Improve tool usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

    • When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    
    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    

    See the improve usage page for a comprehensive guide on using this tool.

    @cTux cTux merged commit 2284d42 into develop Mar 25, 2024
    4 checks passed
    @cTux cTux deleted the feat/deps-25-03-2024 branch March 25, 2024 12:07
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant