continua11y-ci-reporter
Accessible web sites are important. Moblie first development is also key ensuring the greatest access to web based information for the American public.
Technology Transformation Services in the General Service Administration is trying to make tools that build accessibility testing into the software development practice.
This is module is part of many designed to make that possible:
- continua11y: a web dashboard and API for displaying accessibility reports in a friendly manner, and providing accessibility badges.
- continua11y-acceptance: easy node based acceptance testing that also writes json reports to the file system
- continua11y-ci-reporter: This project, a command line tool for sending the generated json reports to continua11y.
Under the covers our work relies on the pa11y library.
Usage
Continua11y is currently an open platform. Therefore you can just send your report with this module.
Currently only Travis CI is supported.
In your .travis.yml create an after script:
node_modules/.bin/continua11y-ci-reporter accessibility
Your script may vary. For example if your path is setup to find
node_modules/.bin
already, good news, you can just use
continua11y-ci-reporter
directly. Also, accessibility
is the
directory where you have already written your accessibility reports. If
you have configured it to go elsewhere, then pass that directory in.
Contributing
See CONTRIBUTING for additional information.
Public domain
This project is in the worldwide public domain. As stated in CONTRIBUTING:
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.