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

Addon A11y: Don't set a11y tag as comment in automigrations #30257

Merged

Conversation

valentinpalkovic
Copy link
Contributor

@valentinpalkovic valentinpalkovic commented Jan 14, 2025

Closes #

What I did

Since we haven't found consensus related to the syntax and meaning of the current a11y-test tag, we will remove its documentation and its scaffolding in the user's .storybook/preview.<js|ts>.

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.9 MB 77.9 MB 0 B 1.73 0%
initSize 131 MB 131 MB 606 B 1.7 0%
diffSize 52.9 MB 52.9 MB 606 B -0.9 0%
buildSize 7.19 MB 7.19 MB 0 B 2.31 0%
buildSbAddonsSize 1.85 MB 1.85 MB 0 B -1.22 0%
buildSbCommonSize 195 kB 195 kB 0 B - 0%
buildSbManagerSize 1.87 MB 1.87 MB 0 B 3 0%
buildSbPreviewSize 0 B 0 B 0 B - -
buildStaticSize 0 B 0 B 0 B - -
buildPrebuildSize 3.91 MB 3.91 MB 0 B 1.98 0%
buildPreviewSize 3.28 MB 3.28 MB 0 B 2.37 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 6.5s 27.2s 20.7s 1.81 🔺76%
generateTime 19.4s 21.3s 1.8s 0.38 8.8%
initTime 12.7s 13.6s 908ms -0.48 6.6%
buildTime 8.6s 12.3s 3.6s 3.54 🔺29.3%
testBuildTime 0ms 0ms 0ms - -
devPreviewResponsive 4.7s 4.4s -276ms -1.06 -6.2%
devManagerResponsive 3.4s 3.2s -185ms -1.17 -5.7%
devManagerHeaderVisible 641ms 550ms -91ms -0.89 -16.5%
devManagerIndexVisible 676ms 562ms -114ms -1.09 -20.3%
devStoryVisibleUncached 1.8s 1.7s -88ms -0.4 -5.1%
devStoryVisible 675ms 582ms -93ms -0.95 -16%
devAutodocsVisible 569ms 520ms -49ms -0.42 -9.4%
devMDXVisible 573ms 488ms -85ms -0.82 -17.4%
buildManagerHeaderVisible 555ms 497ms -58ms -1.25 🔰-11.7%
buildManagerIndexVisible 641ms 588ms -53ms -1.23 -9%
buildStoryVisible 536ms 489ms -47ms -1.19 -9.6%
buildAutodocsVisible 495ms 412ms -83ms -1.23 -20.1%
buildMDXVisible 450ms 410ms -40ms -1.12 -9.8%

Greptile Summary

This PR modifies Storybook's accessibility testing configuration by removing automated inclusion of the a11y-test tag during migrations, due to lack of consensus on its implementation.

  • Set skipPreviewTransformation: true by default in code/lib/cli-storybook/src/automigrate/fixes/addon-a11y-addon-test.ts
  • Removed documentation files for a11y-test tag usage in docs/_snippets/
  • Updated docs/writing-tests/accessibility-testing.mdx to remove configuration section
  • Modified tests in addon-a11y-addon-test.test.ts to reflect skipped preview transformations

Copy link

nx-cloud bot commented Jan 14, 2025

View your CI Pipeline Execution ↗ for commit e82df08.

Command Status Duration Result
nx run-many -t build --parallel=3 ✅ Succeeded 1m 35s View ↗

☁️ Nx Cloud last updated this comment at 2025-01-15 08:28:56 UTC

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.

5 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings | Greptile

docs/_snippets/addon-a11y-meta-tag-exclude.md Show resolved Hide resolved
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.

LGTM

5 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

@valentinpalkovic valentinpalkovic merged commit 3f702aa into next Jan 15, 2025
63 of 68 checks passed
@valentinpalkovic valentinpalkovic deleted the valentin/remove-a11y-test-tag-comment-in-preview branch January 15, 2025 11:47
@github-actions github-actions bot mentioned this pull request Jan 15, 2025
5 tasks
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.

2 participants