よくある質問
Axe Developer Hub の使用に関するよくある質問への回答
コンセプト
Git プロジェクトと Gitless プロジェクトの違いは何ですか?
Developer Hub は、テストが Git を使用しているかどうかに応じて結果を異なる方法で整理します。
- 「 Git プロジェクト 」はアクセスビリティの結果をブランチやコミットに関連付け、特定のコード変更まで問題を追跡できるようにします。
- 「 Gitless プロジェクト 」は、Git データを使用せずにタイムスタンプ順に並べられたテスト実行のシリーズとして結果を整理します。
- Git データは Axe Watcher、Axe CLI またはウェブ API 用の Axe DevTools (CLI 経由で結果をアップロード)を使用する場合に利用可能です。モバイルプロジェクトは常に Gitless です。
「 結果を理解する 」および用語集の項目「 Git 」および「 Gitless 」をご覧ください。
A11y 閾値とは何で、それをどのように設定しますか?
A11y 閾値は組織のアクセシビリティ問題に対する許容度を反映し、CI/CD パイプラインで何が失敗と見なされるかを決定します。
- これは、すべての問題をカウントするか新しい問題のみをカウントするか、含める影響レベル(「重大度」は常に含まれます)の2つの基準から計算されます。
- プロジェクト管理者のみが閾値を設定できます。
「 A11y 閾値を変更する 」をご覧ください。
影響レベル(重大度、深刻、 中程度、軽微)は何を意味しますか?
すべてのアクセシビリティ違反には、最も深刻なものから最も軽いものまでの4つの影響レベルのいずれかが割り当てられます。
- 重大度:障害のあるユーザーが機能にアクセスしたり、操作したりすることが完全にできない。
- 深刻:障害のあるユーザーがサイトを利用する際に重大な障壁に直面する。
- 中程度:いくつかの障壁は存在するが、基本的なコンテンツは依然としてアクセス可能。
- 軽微:依然として完全な準拠には解決が必要な、あまり深刻ではない問題。
詳細な定義については「 用語集 」をご覧ください。
比較
Developer Hub は Git プロジェクトに対して2種類の比較を提供します。 クロスブランチ比較 はブランチビューに表示され、各ブランチはデフォルトブランチの最新パイプライン実行と比較されます(今すぐマージした場合の変更点を示します)。 ブランチ内比較 はコミットビューに表示され、各コミットは同じブランチ上の直前のスキャンされたコミットと比較されます(特定のコミットが導入または修正したものを示します)。「 結果を理解する 」をご覧ください。
リリースごとの変化点をどのように把握すればよいですか?
Git プロジェクトのブランチビューでは、クロスブランチ比較を使用してリリース間のアクセシビリティの変化を追跡できます。
- 各ブランチの最新スキャンされたコミットは、デフォルトブランチの最新パイプライン実行と比較されます。
- 比較では、問題の総数、新たに導入された問題、解決された問題、およびスキャンされたページの状態数の変化が表示されます。
ブランチ内の個々のコミットで何が変更されたかを確認するには、 ブランチ内でコミット間で何が変更されたかを確認するにはどうすればよいですか?
プルリクエストの影響をどのように判断できますか?
プルリクエストブランチでテストスイートを実行し、結果をAxe Developer Hubに表示させてください。
- ブランチビューでは、各非デフォルトブランチがデフォルトブランチとのクロスブランチ比較を表示し、新たに導入された問題、解決された問題、総差分が示されます。
- もし GitHubアクションを使用している場合、自動的にPRにコメントを投稿し、要約と完全な結果へのリンクを提供することができます。
ブランチ内の各コミットが何を変更したかを詳しく調べるには、 ブランチ内でコミット間で何が変更されたかを確認するにはどうすればよいですか?
ブランチ内でコミット間で何が変更されたかを確認するにはどうすればよいですか?
ブランチビューから、 コミットを見る をクリックして、各ブランチの個々のスキャンされたコミットを表示してください。ブランチビューでのクロスブランチ比較とは異なり、コミットビューではブランチ内比較が使用されます。
- 各コミットは、そのブランチの前回スキャンされたコミットと比較され、新しい問題、解決された問題、ページ状態の変化が示されます。
- テストスイートが実行されたコミットのみが表示されます。
ブランチ全体がデフォルトブランチとどのように比較されるかを確認するには、 最新のCI/CD実行でデフォルトブランチとブランチを比較するにはどうすればよいですか?
最新のCI/CD実行でデフォルトブランチとブランチを比較するにはどうすればよいですか?
ブランチビューは、各非デフォルトブランチに対してデフォルトブランチの最新パイプライン実行と自動的にクロスブランチ比較を行います。
- これには、プロジェクト管理者がデフォルトブランチでAxe Watcherをパイプラインとして実行するように設定する必要があります。
- 比較には、総問題数、新しい問題、解決された問題、およびページ状態の差が示されます。
そのブランチ内の個々のコミットがどのように変更されたかを確認するには、 ブランチ内でコミット間で何が変更されたかを確認するにはどうすればよいですか?
プルリクエストを作成する前に正確な比較結果を得るにはどうすればよいですか?
マージ前に正確なクロスブランチ比較を行うために、機能ブランチをデフォルトブランチと同期させ続けてください。
- デフォルトブランチを機能ブランチにマージしてください(例:
git merge main)、テストスイートを実行する前に。 - マージコミットをプッシュして、Axe Developer Hubで更新されたブランチをスキャンできるようにしてください。
- その後、ブランチビューではデフォルトブランチの最新パイプライン実行とあなたのブランチを比較し、実際にあなたのブランチが導入したアクセシビリティ変更のみを示します。
あなたの機能ブランチがデフォルトブランチより遅れている場合、デフォルトブランチで既に修正された問題が機能ブランチにまだマージされていないときには、その比較で問題が表面化することがあります。デフォルトブランチを先にマージすることで、これらの誤検知を排除し、プルリクエストをマージしたときの驚きを減少させます。
CI/CD
コードに新たなアクセシビリティの問題がマージされないようにするにはどうすればよいですか?
Axe Developer HubをCI/CDパイプラインに統合して、各コミットやプルリクエストで自動的にアクセシビリティチェックを実行させます:
- GitHubを使用する場合、 Axe Developer Hub GitHubアクション を使用して、アクセシビリティエラーを導入するプルリクエストをブロックできます。
- GitLabやBitbucketのような他のプラットフォームの場合、 RESTサービスAPI を使用して結果を照会し、問題が検出された場合にパイプラインを失敗させます。
- 失敗と見なされるものを細かく設定するには、 a11yしきい値を構成してください。
GitHubを使用していない場合、Axe Developer HubをCI/CDパイプラインに統合するにはどうすればよいですか?
任意のCI/CDプラットフォームと統合するには、RESTサービスAPIを使用できます:
- RESTサービスAPI を使用すると、テストスイートの実行後にAxe Developer Hubから結果を照会できます。
- APIは、問題数、新しい違反、解決された違反、およびDeveloper Hubでの完全な結果へのリンクを返します。
- このレスポンスを利用して、GitLab、Bitbucket、Jenkins、その他のプラットフォームでパイプラインを合格または失格にすることができます。
プロジェクト管理
他のチームメンバーのアクセシビリティスキャンをプロジェクトでどのように表示しますか?
プロジェクトのメンバー全員が追加されると、共有プロジェクト内のすべての結果を表示できます:
- メンバー設定ページを通じてチームメンバーを追加します。
- Gitプロジェクトでは、ブランチビューがAPIキーごとにグループ化された結果を表示するため、誰が各スキャンを実行したかが分かります。
役割と権限の詳細については、 チーム用プロジェクトの設定をご覧ください。
アクセシビリティの結果をどのようにエクスポートするのですか?
デベロッパーハブはデータをエクスポートするいくつかの方法を提供しています:
- 問題の概要ビューから、 問題をエクスポート ボタンをクリックして、結果をCSVまたはJSONでダウンロードします。
- プログラムでのアクセスには、 RESTサービスAPI を使用して、特定のコミットやプロジェクトの結果をクエリします。
詳細については、 プログラムでの結果の取得 をご覧ください。
