Merge pull request #180 from dequelabs/main

maksym-shynkarenko · web-flow · commit ccec1381f2da · 2026-01-19T22:35:48.000+02:00
chore: update `v1` branch from `main`
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1 @@
-* @dequelabs/axe-api-team
+* @dequelabs/results-team
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,33 @@
+version: 2
+
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: "chore"
+    groups:
+      # Any updates not caught by the group config will get individual PRs
+      gha-low-risk:
+        update-types:
+          - "minor"
+          - "patch"
+
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 10
+    commit-message:
+      prefix: "chore"
+    ignore:
+      # Handled separately by its own workflow
+      - dependency-name: "@axe-core/watcher"
+    groups:
+      # Any updates not caught by the group config will get individual PRs
+      npm-low-risk:
+        update-types:
+          - "minor"
+          - "patch"
diff --git a/.github/workflows/add-docs-labels-on-close.yml b/.github/workflows/add-docs-labels-on-close.yml
@@ -0,0 +1,18 @@
+name: 'Add Documentation Labels on Issue Close (and completed)'
+
+on:
+  issues:
+    types: [closed]
+
+jobs:
+  add-documentation-label:
+    if: github.event.issue.state_reason == 'completed'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Add NEEDS document label
+        uses: dequelabs/axe-api-team-public/.github/actions/label-issue-based-on-existing-labels-v1@main
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-number: ${{ github.event.issue.number }}
+          trigger-labels: 'Docs: required'
+          add-labels: 'NEEDS: document'
diff --git a/.github/workflows/caller_reach_out_to_zendesk_on_release_merge.yml b/.github/workflows/caller_reach_out_to_zendesk_on_release_merge.yml
@@ -0,0 +1,12 @@
+name: Comment on related Zendesk tickets upon release
+#Description: Whenever the release branch is merged into main or master, call
+#the reusable_reach_out_to_zendesk_on_release_merge workflow in internal-actions-private.
+
+on:
+  push:
+    branches:
+      - main
+jobs:
+  notify-zendesk:
+    uses: dequelabs/internal-actions-private/.github/workflows/reusable_reach_out_to_zendesk_on_release_merge.yml@main
+    secrets: inherit
diff --git a/.github/workflows/semantic-pr-footer.yml b/.github/workflows/semantic-pr-footer.yml
@@ -0,0 +1,16 @@
+name: Semantic PR footer
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+
+jobs:
+  semantic-pr-footer:
+    runs-on: ubuntu-latest
+    timeout-minutes: 1
+    steps:
+      - uses: dequelabs/axe-api-team-public/.github/actions/semantic-pr-footer-v1@main
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -1,36 +1,35 @@
 name: Tests
 
-on: [push]
+on: [push, pull_request]
 
 jobs:
   shellcheck:
     runs-on: ubuntu-latest
+    timeout-minutes: 1
     steps:
-      - uses: ludeeus/action-shellcheck@2.0.0
+      - uses: ludeeus/action-shellcheck@00cae500b08a931fb5698e11e79bfbd38e612a38 # tag=v2
   cypress:
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: 18
       - run: cd example && npm install
-      - uses: browser-actions/setup-chrome@latest
-      - uses: nanasess/setup-chromedriver@v1
       - run: cd example && npm run build
       - name: Run tests
-        uses: GabrielBB/xvfb-action@v1
+        run: xvfb-run --auto-servernum npm run ci
+        working-directory: ./example
         env:
           API_KEY: ${{ secrets.AXE_WATCHER_API_KEY }}
           SERVER_URL: https://axe.dequelabs.com
-        with:
-          run: npm run ci
-          working-directory: ./example
-  watcher:
+  axe-dev-hub:
     runs-on: ubuntu-latest
+    timeout-minutes: 5
     needs: cypress
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./
         with:
           api_key: ${{ secrets.AXE_WATCHER_API_KEY }}
diff --git a/.github/workflows/update-watcher.yml b/.github/workflows/update-watcher.yml
@@ -4,25 +4,26 @@ on:
   workflow_dispatch:
   schedule:
     # Scheduled to run at 2am every day
-    - cron: '0 2 * * *'
+    - cron: "0 2 * * *"
 
 jobs:
   build:
     runs-on: ubuntu-latest
+    timeout-minutes: 1
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
           node-version: 18
-      - run: cd example && npm install --save-dev @axe-core/watcher@next
+      - run: cd example && npm install --save-dev @axe-core/watcher@latest
       - name: Open PR
-        uses: peter-evans/create-pull-request@v3
+        uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # tag=v5
         with:
           token: ${{ secrets.PAT }}
-          commit-message: 'chore: Update @axe-core/watcher'
+          commit-message: "chore: Update @axe-core/watcher"
           branch: auto-update-watcher
           base: main
-          title: 'chore: Update @axe-core/watcher'
+          title: "chore: Update @axe-core/watcher"
           body: |
-            This patch updates version of [`@axe-core/watcher`](https://npmjs.org/@axe-core/watcher) to the latest `@next` version.
+            This patch updates version of [`@axe-core/watcher`](https://npmjs.org/@axe-core/watcher) to the latest version.
             This PR was opened by a robot :robot: :tada:.
diff --git a/README.md b/README.md
@@ -1,24 +1,32 @@
-# axe-watcher-action
+# axe-devhub-action
 
-> A GitHub Action for reporting the axe Watcher status of a particular commit.
+> A GitHub Action for reporting the axe DevHub status of a particular commit.
 
 ## Example Workflow
 
-A full example of the `axe-watcher-action` can be seen at [`.github/workflows/tests.yml`](./.github/workflows/tests.yml).
+A full example of the `axe-devhub-action` can be seen at [`.github/workflows/tests.yml`](./.github/workflows/tests.yml).
 
 ## Inputs
 
-| name           | description                                                                                                 | required           | default                |
-| -------------- | ----------------------------------------------------------------------------------------------------------- | ------------------ | ---------------------- |
-| `api_key`      | Your axe Watcher API key                                                                                    | :white_check_mark: |                        |
-| `server_url`   | Axe server URL                                                                                              | :x:                | https://axe.deque.com  |
-| `retry_count`  | Number of times to retry                                                                                    | :x:                | 10                     |
-| `github-token` | Optional [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) | :x:                | `secrets.GITHUB_TOKEN` |
+| name                    | description                                                                                                              | required            | default                                                                                   |
+| ----------------------- |--------------------------------------------------------------------------------------------------------------------------|---------------------|-------------------------------------------------------------------------------------------|
+| `api_key`               | Your axe Watcher API key                                                                                                 | :white_check_mark:  |                                                                                           |
+| `project_id`            | The ID of your Axe Developer Hub project                                                                                 | :x:                 | Required for newer projects after December 9, 2025. Legacy projects will continue to work |
+| `server_url`            | Axe server URL                                                                                                           | :x:                 | https://axe.deque.com                                                                     |
+| `retry_count`           | Number of times to retry                                                                                                 | :x:                 | 10                                                                                        |
+| `github_token`          | Optional [PAT](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)              | :x:                 | `secrets.GITHUB_TOKEN`                                                                    |
+| `enable_a11y_threshold` | Enable the a11y threshold, which will cause the action to fail if the number of violations is greater than the threshold | :x:                 | `false`                                                                                   |
 
 ## Outputs
 
-| name          | description                                        |
-| ------------- | -------------------------------------------------- |
-| `project`     | Project associated with your API key               |
-| `axe_url`     | URL for viewing axe issues detected on your commit |
-| `issue_count` | Number of axe issues detected                      |
+| name                         | description                                        |
+| ---------------------------- |----------------------------------------------------|
+| `project`                    | Project name                                       |
+| `project_id`                 | Project ID                                          |
+| `axe_url`                    | URL for viewing axe issues detected on your commit |
+| `issue_count`                | Number of axe issues detected                      |
+| `created_at`                 | DateTime when run occurred                         |
+| `resolved_issues`            | Number of axe issues resolved                      |
+| `difference_in_page_states`  | Difference in number of page states detected       |
+| `page_states`                | Number of page states detected                     |
+| `issues_over_a11y_threshold` | Number of issues over a11y threshold               |
diff --git a/action.yml b/action.yml
@@ -1,10 +1,13 @@
-name: axe Watcher
-description: Get the axe Watcher status for a commit
+name: axe DevHub
+description: Get the axe DevHub status for a commit
 
 inputs:
   api_key:
-    description: axe Watcher 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
@@ -13,51 +16,77 @@ inputs:
     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"
   github_token:
     description: GitHub token
+    required: false
     default: ${{ github.token }}
-    required: true
 
 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:
-    - uses: jwalton/gh-find-current-pr@v1
+    - name: Find current PR
+      uses: jwalton/gh-find-current-pr@89ee5799558265a1e0e31fab792ebb4ee91c016b # tag=v1.3.3
       id: find_pr
-    - id: main
+    - 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: ${{ github.sha }}
-    # Add a comment reporting the number of violations.
-    - if: ${{ failure() }}
-      uses: marocchino/sticky-pull-request-comment@v2
+        ENABLE_A11Y_THRESHOLD: ${{ inputs.enable_a11y_threshold }}
+        PROJECT_ID: ${{ inputs.project_id }}
+    - name: Add a comment with accessibility violations over a11y threshold into the current PR
+      if: ${{ failure() && inputs.enable_a11y_threshold == 'true' }}
+      uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # tag=v2.9.4
+      with:
+        header: axe-devhub
+        message: |
+          axe DevHub found **${{ steps.main.outputs.issue_count }}** accessibility violations in this PR.
+          axe DevHub found **${{ steps.main.outputs.issues_over_a11y_threshold }}** accessibility violations over your a11y threshold in this PR.
+
+          See the full report on [axe DevHub](${{ steps.main.outputs.axe_url }}).
+        GITHUB_TOKEN: ${{ inputs.github_token }}
+        number: ${{ steps.find_pr.outputs.pr }}
+    - name: Add a comment with accessibility violations into the current PR
+      if: ${{ failure() && inputs.enable_a11y_threshold == 'false' }}
+      uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # tag=v2.9.4
       with:
-        header: axe-watcher
+        header: axe-devhub
         message: |
-          axe Watcher found **${{ steps.main.outputs.issue_count }}** accessibility violations in this PR.
+          axe DevHub found **${{ steps.main.outputs.issue_count }}** accessibility violations in this PR.
 
           See the full report on [axe DevHub](${{ steps.main.outputs.axe_url }}).
         GITHUB_TOKEN: ${{ inputs.github_token }}
         number: ${{ steps.find_pr.outputs.pr }}
-    # Hide a previously added comment if there are no violations.
-    - if: ${{ success() }}
-      uses: marocchino/sticky-pull-request-comment@v2
+    - name: Hide a previously added comment if there are no violations.
+      if: ${{ success() }}
+      uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # tag=v2.9.4
       with:
-        header: axe-watcher
+        header: axe-devhub
         hide: true
         hide_classify: OUTDATED
         GITHUB_TOKEN: ${{ inputs.github_token }}
diff --git a/example/package-lock.json b/example/package-lock.json
diff --git a/example/package.json b/example/package.json
diff --git a/example/test/support.ts b/example/test/support.ts
diff --git a/main.sh b/main.sh

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-* @dequelabs/axe-api-team`
	`1`	`+* @dequelabs/results-team`