アクセシビリティテスト

アプリケーションがウェブインターフェースを提供する場合、GitLab CI/CDを使用して、保留中のコード変更によるアクセシビリティへの影響を判断できます。

Pa11yは、ウェブサイトのアクセシビリティを測定するためのFreeのオープンソースツールです。GitLabはPa11yをCI/CDジョブテンプレートに統合します。a11yジョブは、定義された一連のウェブページを分析し、アクセシビリティの違反、警告、通知をaccessibilityという名前のファイルでレポートします。

Pa11yはWCAG 2.1ルールを使用します。

アクセシビリティマージリクエストウィジェット

GitLabは、マージリクエストウィジェット領域にAccessibility Reportを表示します:

アクセシビリティテストの設定

GitLab CI/CDでPa11yを実行するには、GitLab Accessibility Dockerイメージを使用します。

a11yジョブを定義するには:

1. お使いのGitLabインストールから、Accessibility.gitlab-ci.ymlテンプレートを含めてください。

2. 次の設定を.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"

3. Pa11yでテストするウェブページのURLをリストするために、a11y_urls変数をカスタマイズします。

CI/CDパイプライン内のa11yジョブは、次のファイルを生成します:

• a11y_urls変数にリストされているURLごとに1つのHTMLレポート。
• 収集されたレポートデータを含む1つのファイル。このファイルはgl-accessibility.jsonという名前です。

ブラウザでジョブアーティファクトを表示できます。

CIの設定を介してPa11yに設定を渡すことはできません。設定を変更するには、CIファイル内のテンプレートのコピーを編集します。