action.yml

name: axe DevHub
description: Get the axe DevHub status for a commit

inputs:
  api_key:
    description: axe DevHub API Key
    required: true
  project_id:
    description: the ID of your Axe Developer Hub project
    required: false
  server_url:
    description: axe server URL
    required: false
    default: https://axe.deque.com
  retry_count:
    description: number of times to attempt fetching the commit status
    required: false
    default: 10
  enable_a11y_threshold:
    description: Enable the a11y threshold, which will cause the action to fail if the number of violations is greater than the threshold
    required: false
    default: "false"
  commit_sha:
    description: Override the commit SHA to check status for
    required: false
    default: ${{ github.sha }}
  github_token:
    description: GitHub token
    required: false
    default: ${{ github.token }}

outputs:
  project:
    description: Project name
    value: ${{ steps.main.outputs.project }}
  project_id:
    description: Project ID
    value: ${{ steps.main.outputs.project_id }}
  axe_url:
    description: Axe URL for the commit's issues
    value: ${{ steps.main.outputs.axe_url }}
  issue_count:
    description: Number of violations found
    value: ${{ steps.main.outputs.issue_count }}
  issues_over_a11y_threshold:
    description: Whether the number of violations is over your a11y threshold
    value: ${{ steps.main.outputs.issues_over_a11y_threshold }}

runs:
  using: composite
  steps:
    - name: Get axe DevHub commit overview
      id: main
      run: ${{ github.action_path }}/main.sh
      shell: bash
      env:
        API_KEY: ${{ inputs.api_key }}
        SERVER_URL: ${{ inputs.server_url }}
        RETRY_COUNT: ${{ inputs.retry_count }}
        COMMIT_SHA: ${{ inputs.commit_sha }}
        ENABLE_A11Y_THRESHOLD: ${{ inputs.enable_a11y_threshold }}
        PROJECT_ID: ${{ inputs.project_id }}
    - name: Add a comment with accessibility violations into the current PR
      if: ${{ failure() }}
      run: ${{ github.action_path }}/pr-comment.sh
      shell: bash
      env:
        MODE: upsert
        GITHUB_TOKEN: ${{ inputs.github_token }}
        PR_NUMBER: ${{ github.event.pull_request.number }}
        ENABLE_A11Y_THRESHOLD: ${{ inputs.enable_a11y_threshold }}
        ISSUE_COUNT: ${{ steps.main.outputs.issue_count }}
        ISSUES_OVER_A11Y_THRESHOLD: ${{ steps.main.outputs.issues_over_a11y_threshold }}
        AXE_URL: ${{ steps.main.outputs.axe_url }}
    - name: Hide a previously added comment if there are no violations.
      if: ${{ success() }}
      run: ${{ github.action_path }}/pr-comment.sh
      shell: bash
      env:
        MODE: hide
        GITHUB_TOKEN: ${{ inputs.github_token }}
        PR_NUMBER: ${{ github.event.pull_request.number }}