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: Add a11y tests and GitHub action #460

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Conversation

ethanWallace
Copy link
Collaborator

@ethanWallace ethanWallace commented Jan 17, 2025

Summary | Résumé

Add cypress e2e test to test the accessibility of all pages on the documentation site. Also updated an old GitHub workflow to run these tests on pull request into main and merge into main.

Also includes some accessibility fixes that were identified by the tests, mostly misaligned HTML and headings.

How to use

Run tests in browser

  • Run npm run start to start a local version of the documentation site
  • Run npm run cy:open
  • This will open the cypress interface in the browser of your choice to view the tests

Run tests in terminal

  • Run npm run cy:run
  • This will start the site and run the tests. The Site will be closed after the tests complete.

cds-snc/design-gc-conception#1192

Note: Tests fail at the moment because of how we preview components that our landmarks. Brainstorming a different way to preview them.

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.

1 participant