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

Automigration: Improve setup file transformation and version range handling for a11y migration #30060

Merged

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Dec 13, 2024

Closes #

What I did

  • Fixed the version range for the a11y addon automigration
  • Added a check whether setProjectAnnotations has a string or an array as argument

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-storybook/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>

name before after diff z %
createSize 0 B 0 B 0 B - -
generateSize 77.7 MB 77.7 MB 0 B 3 0%
initSize 136 MB 136 MB 0 B 3 0%
diffSize 58.4 MB 58.4 MB 0 B 3 0%
buildSize 7.24 MB 7.24 MB 0 B 2 0%
buildSbAddonsSize 1.88 MB 1.88 MB 0 B 2 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.86 MB 1.86 MB 0 B 1.74 0%
buildSbPreviewSize 0 B 0 B 0 B - -
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 3.93 MB 3.93 MB 0 B 2 0%
buildPreviewSize 3.3 MB 3.3 MB 0 B 1.91 0%
testBuildSize 0 B 0 B 0 B - -
testBuildSbAddonsSize 0 B 0 B 0 B - -
testBuildSbCommonSize 0 B 0 B 0 B - -
testBuildSbManagerSize 0 B 0 B 0 B - -
testBuildSbPreviewSize 0 B 0 B 0 B - -
testBuildStaticSize 0 B 0 B 0 B - -
testBuildPrebuildSize 0 B 0 B 0 B - -
testBuildPreviewSize 0 B 0 B 0 B - -
name before after diff z %
createTime 12.4s 6.9s -5s -544ms -0.77 -79.9%
generateTime 19.7s 19.8s 149ms -0.66 0.7%
initTime 14.5s 13.5s -1s -15ms -0.62 -7.5%
buildTime 8.3s 8.4s 148ms -0.56 1.7%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 4.5s 4.4s -95ms -1.21 -2.1%
devManagerResponsive 3.4s 3.3s -73ms -1.18 -2.2%
devManagerHeaderVisible 601ms 518ms -83ms -0.81 -16%
devManagerIndexVisible 634ms 551ms -83ms -1.12 -15.1%
devStoryVisibleUncached 1.3s 1.6s 313ms -0.26 18.5%
devStoryVisible 635ms 550ms -85ms -1.12 -15.5%
devAutodocsVisible 480ms 528ms 48ms 0.11 9.1%
devMDXVisible 549ms 502ms -47ms -0.38 -9.4%
buildManagerHeaderVisible 568ms 597ms 29ms -0.14 4.9%
buildManagerIndexVisible 663ms 674ms 11ms -0.31 1.6%
buildStoryVisible 530ms 544ms 14ms -0.17 2.6%
buildAutodocsVisible 435ms 417ms -18ms -0.48 -4.3%
buildMDXVisible 447ms 393ms -54ms -0.76 -13.7%

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings | Greptile

@@ -22,8 +22,7 @@ interface AddonA11yAddonTestOptions {
*/
export const addonA11yAddonTest: Fix<AddonA11yAddonTestOptions> = {
id: 'addonA11yAddonTest',
// TODO: Change to the correct version after testing
versionRange: ['<8.5.0', '*'],
versionRange: ['<8.5.0', '>=8.5.0'],
Copy link
Contributor

Choose a reason for hiding this comment

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

logic: version range ['<8.5.0', '>=8.5.0'] covers all versions and is equivalent to '*'. Consider if this is intentional or if there should be a minimum version requirement.

@valentinpalkovic valentinpalkovic changed the title Refactor addonA11yAddonTest to improve setup file transformation and version range handling Automigration: Improve setup file transformation and version range handling for a11y migration Dec 13, 2024
Copy link

nx-cloud bot commented Dec 13, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b9550a9. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 2 targets

Sent with 💌 from NxCloud.

@valentinpalkovic valentinpalkovic merged commit 4192dde into next Dec 15, 2024
63 of 74 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/improve-addon-a11y-addon-test-automigration branch December 15, 2024 09:18
@yannbf yannbf added needs qa Indicates that this needs manual QA during the upcoming minor/major release and removed needs qa Indicates that this needs manual QA during the upcoming minor/major release labels Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants