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

Spike/story book accessibility ci #19

Merged
merged 15 commits into from
Jan 27, 2025

Conversation

jarvisraymond-uchicago
Copy link
Contributor

@jarvisraymond-uchicago jarvisraymond-uchicago commented Jan 7, 2025

Link to JIRA ticket if there is one: https://ctds-planx.atlassian.net/browse/HP-1889

Dev Notes

  • Automates accessibility and interaction testing with storybook and auto-generates documentation.
  • Storybook stories will be written for the individual components: developers will create a storybook stories for components, which will test for accessibility, and add interaction tests. Storybook will auto-document the component.

When there are accessibility Violations
image
image

The accessibility issues can be reproduced in Storybook using npm run storybook then clicking the accessibility tab associated with the story and clicking highlight. Developers can then see details about the defect and information to help fix it:

image

When there are NO accessibility Violations
image
image

Using Storybook
Use npm run storybook-test to run tests from CLI
output

Use npm run storybook to launch the graphical user interface
output

New Features

  • Adds support for automated documentation and accessibility and UI interaction CI testing with storybook

Dependency updates

  • Adds "storybook": "^8.4.7" and related packages
  • Adds test runner and updates ci.yaml to run it in github

@jarvisraymond-uchicago jarvisraymond-uchicago marked this pull request as draft January 10, 2025 15:20
@jarvisraymond-uchicago jarvisraymond-uchicago marked this pull request as ready for review January 14, 2025 18:58
Copy link
Contributor

@mfshao mfshao left a comment

Choose a reason for hiding this comment

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

cool!

@jarvisraymond-uchicago jarvisraymond-uchicago merged commit ba9c242 into main Jan 27, 2025
4 checks passed
@jarvisraymond-uchicago jarvisraymond-uchicago deleted the spike/storyBookAccessibilityCI branch January 27, 2025 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants