{{< details >}}

  1. Tier: 基础版, 专业版, 旗舰版
  2. Offering: JihuLab.com, 私有化部署

{{< /details >}}

如果你的应用程序提供了一个 Web 界面,你可以使用 极狐GitLab CI/CD 来确定待处理代码更改的可访问性影响。

Pa11y 是一个免费和开源的工具,用于测量网站的可访问性。极狐GitLab 将 Pa11y 集成到一个 CI/CD 作业模板 中。a11y 作业分析一组定义好的网页,并报告在名为 accessibility 的文件中的可访问性违规、警告和通知。

Pa11y 使用 WCAG 2.1 规则。

可访问性合并请求小部件

极狐GitLab 在合并请求小部件区域显示一个 可访问性报告

Accessibility merge request widget

配置可访问性测试

你可以使用极狐GitLab Accessibility Docker 镜像在极狐GitLab CI/CD 中运行 Pa11y。

要定义 a11y 作业:

  1. 从你的极狐GitLab 安装中 Include Accessibility.gitlab-ci.yml 模板
  2. 将以下配置添加到你的 .gitlab-ci.yml 文件中。

    stages:
      - accessibility
    
    variables:
      a11y_urls: "https://gitlab.cn https://jihulab.com/users/sign_in"
    
    include:
      - template: "Verify/Accessibility.gitlab-ci.yml"
    
  3. 自定义 a11y_urls 变量以列出要使用 Pa11y 测试的网页 URL。

你的 CI/CD 流水线中的 a11y 作业会生成以下文件:

  1. 每个在 a11y_urls 变量中列出的 URL 生成一个 HTML 报告。
  2. 一个包含收集报告数据的文件。这个文件名为 gl-accessibility.json

你可以 在浏览器中查看作业产物

{{< alert type=”note” >}}

模板提供的作业定义不支持 Kubernetes。

{{< /alert >}}

你不能通过 CI 配置将配置传递到 Pa11y。要更改配置,请在你的 CI 文件中编辑模板的副本。