Help us learn about your current experience with the documentation. Take the survey.
可访问性测试
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
如果你的应用提供 Web 界面,你可以使用 GitLab CI/CD 来确定待定代码变更对可访问性的影响。
Pa11y 是一个用于测量网站可访问性的免费开源工具。GitLab 将 Pa11y 集成到一个
CI/CD 作业模板 中。
a11y 作业会分析一组定义的网页,并在名为
accessibility 的文件中报告可访问性违规、警告和通知。
Pa11y 使用 WCAG 2.1 规则。
可访问性合并请求组件
GitLab 在合并请求组件区域显示一个可访问性报告:
配置可访问性测试
你可以使用 GitLab Accessibility Docker 镜像 通过 GitLab CI/CD 来运行 Pa11y。
要定义 a11y 作业:
- 从你的 GitLab 安装中引入
Accessibility.gitlab-ci.yml模板。 - 将以下配置添加到你的
.gitlab-ci.yml文件中。
stages:
- accessibility
variables:
a11y_urls: "https://about.gitlab.com https://gitlab.com/users/sign_in"
include:
- template: "Verify/Accessibility.gitlab-ci.yml"- 自定义
a11y_urls变量,以列出要使用 Pa11y 测试的网页 URL。
你的 CI/CD 流水线中的 a11y 作业会生成这些文件:
- 针对
a11y_urls变量中列出的每个 URL,生成一个 HTML 报告。 - 一个包含所收集报告数据的文件。该
文件名为
gl-accessibility.json。
你可以在浏览器中查看作业产物。
模板提供的作业定义不支持 Kubernetes。
你无法通过 CI 配置将配置传递给 Pa11y。 要更改配置,请在你的 CI 文件中编辑该模板的副本。