Accessibility testing (FREE ALL)
If your application offers a web interface, you can use GitLab CI/CD to determine the accessibility impact of pending code changes.
Pa11y is a free and open source tool for
measuring the accessibility of web sites. GitLab integrates Pa11y into a
CI/CD job template.
a11y job analyzes a defined set of web pages and reports
accessibility violations, warnings, and notices in a file named
Accessibility merge request widget
GitLab displays an Accessibility Report in the merge request widget area:
Configure accessibility testing
You can run Pa11y with GitLab CI/CD using the GitLab Accessibility Docker image.
To define the
Add the following configuration to your
stages: - accessibility variables: a11y_urls: "https://about.gitlab.com https://gitlab.com/users/sign_in" include: - template: "Verify/Accessibility.gitlab-ci.yml"
a11y_urlsvariable to list the URLs of the web pages to test with Pa11y.
a11y job in your CI/CD pipeline generates these files:
- One HTML report per URL listed in the
- One file containing the collected report data. In GitLab versions 12.11 and later, this
file is named
gl-accessibility.json. In GitLab versions 12.10 and earlier, this file is named
You can view job artifacts in your browser.
NOTE: The job definition provided by the template does not support Kubernetes.
You cannot pass configurations into Pa11y via CI configuration. To change the configuration, edit a copy of the template in your CI file.