feat: replace exclude input with urlConfig for per-URL selector exclusion

Agent-Logs-Url: https://github.com/github/accessibility-scanner/sessions/3565f54a-5878-479d-8bcd-ef2b85413be6

Co-authored-by: abdulahmad307 <204748719+abdulahmad307@users.noreply.github.com>

Author: Copilot

.github/actions/find/action.yml

@@ -4,8 +4,11 @@ description: 'Finds potential accessibility gaps.'
 inputs:
   urls:
     description: 'Newline-delimited list of URLs to check for accessibility issues'
-    required: true
+    required: false
     multiline: true
+  url_config:
+    description: "Stringified JSON array of URL config objects, each with a 'url' field and an optional 'excludeSelectors' field (array of CSS selectors to exclude from the Axe scan for that URL). When provided, takes precedence over the 'urls' input."
+    required: false
   auth_context:
     description: "Stringified JSON object containing 'username', 'password', 'cookies', and/or 'localStorage' from an authenticated session"
     required: false
@@ -22,9 +25,6 @@ inputs:
   color_scheme:
     description: 'Playwright colorScheme setting: https://playwright.dev/docs/api/class-browser#browser-new-context-option-color-scheme'
     required: false
-  exclude:
-    description: 'Stringified JSON array of CSS selectors to exclude from the Axe scan'
-    required: false
 
 outputs:
   findings_file:

.github/actions/find/src/index.ts

@@ -1,4 +1,4 @@
-import type {AuthContextInput, ColorSchemePreference, ReducedMotionPreference} from './types.js'
+import type {AuthContextInput, ColorSchemePreference, ReducedMotionPreference, UrlConfig} from './types.js'
 import fs from 'node:fs'
 import path from 'node:path'
 import * as core from '@actions/core'
@@ -7,8 +7,37 @@ import {findForUrl} from './findForUrl.js'
 
 export default async function () {
   core.info("Starting 'find' action")
-  const urls = core.getMultilineInput('urls', {required: true})
-  core.debug(`Input: 'urls: ${JSON.stringify(urls)}'`)
+  const urlConfigInput = core.getInput('url_config', {required: false})
+  let urlConfigs: UrlConfig[] | undefined
+  if (urlConfigInput) {
+    try {
+      const parsed = JSON.parse(urlConfigInput)
+      if (!Array.isArray(parsed)) {
+        throw new Error("Input 'url_config' must be a JSON array.")
+      }
+      for (const item of parsed) {
+        if (typeof item !== 'object' || item === null || typeof item.url !== 'string') {
+          throw new Error("Each entry in 'url_config' must be an object with a 'url' string field.")
+        }
+      }
+      urlConfigs = parsed as UrlConfig[]
+    } catch (e) {
+      throw new Error(`Invalid 'url_config' input: ${(e as Error).message}`)
+    }
+  }
+
+  let urls: string[]
+  if (urlConfigs) {
+    core.debug(`Input: 'url_config: ${JSON.stringify(urlConfigs)}'`)
+    urls = urlConfigs.map(c => c.url)
+  } else {
+    urls = core.getMultilineInput('urls', {required: false})
+    core.debug(`Input: 'urls: ${JSON.stringify(urls)}'`)
+    if (urls.length === 0) {
+      throw new Error("Either 'urls' or 'url_config' input must be provided.")
+    }
+  }
+
   const authContextInput: AuthContextInput = JSON.parse(core.getInput('auth_context', {required: false}) || '{}')
   const authContext = new AuthContext(authContextInput)
 
@@ -34,20 +63,11 @@ export default async function () {
     colorScheme = colorSchemeInput as ColorSchemePreference
   }
 
-  const excludeInput = core.getInput('exclude', {required: false})
-  let exclude: string[] | undefined
-  if (excludeInput) {
-    try {
-      exclude = JSON.parse(excludeInput) as string[]
-    } catch {
-      throw new Error(`Input 'exclude' must be a valid JSON array of CSS selectors. Received: ${excludeInput}`)
-    }
-  }
-
   const findings = []
   for (const url of urls) {
     core.info(`Preparing to scan ${url}`)
-    const findingsForUrl = await findForUrl(url, authContext, includeScreenshots, reducedMotion, colorScheme, exclude)
+    const excludeSelectors = urlConfigs?.find(c => c.url === url)?.excludeSelectors
+    const findingsForUrl = await findForUrl(url, authContext, includeScreenshots, reducedMotion, colorScheme, excludeSelectors)
     if (findingsForUrl.length === 0) {
       core.info(`No accessibility gaps were found on ${url}`)
       continue

.github/actions/find/src/types.d.ts

@@ -37,3 +37,8 @@ export type AuthContextInput = {
 export type ReducedMotionPreference = 'reduce' | 'no-preference' | null
 
 export type ColorSchemePreference = 'light' | 'dark' | 'no-preference' | null
+
+export type UrlConfig = {
+  url: string
+  excludeSelectors?: string[]
+}

README.md

@@ -58,7 +58,7 @@ jobs:
           # reduced_motion: no-preference # Optional: Playwright reduced motion configuration option
           # color_scheme: light # Optional: Playwright color scheme configuration option
           # scans: '["axe","reflow-scan"]' # Optional: An array of scans (or plugins) to be performed. If not provided, only Axe will be performed.
-          # exclude: '["iframe","#third-party-widget"]' # Optional: A JSON array of CSS selectors to exclude from the Axe scan.
+          # url_config: '[{"url":"https://example.com","excludeSelectors":["iframe","#widget"]}]' # Optional: Per-URL config with CSS selectors to exclude from the Axe scan. When provided, takes precedence over 'urls'.
 ```
 
 > 👉 Update all `REPLACE_THIS` placeholders with your actual values. See [Action Inputs](#action-inputs) for details.
@@ -116,7 +116,7 @@ Trigger the workflow manually or automatically based on your configuration. The
 
 | Input                     | Required | Description                                                                                                                                                                                         | Example                                                     |
 | ------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- |
-| `urls`                    | Yes      | Newline-delimited list of URLs to scan                                                                                                                                                              | `https://primer.style`<br>`https://primer.style/octicons`   |
+| `urls`                    | No*      | Newline-delimited list of URLs to scan. Required unless `url_config` is provided.                                                                                                                   | `https://primer.style`<br>`https://primer.style/octicons`   |
 | `repository`              | Yes      | Repository (with owner) for issues and PRs                                                                                                                                                          | `primer/primer-docs`                                        |
 | `token`                   | Yes      | PAT with write permissions (see above)                                                                                                                                                              | `${{ secrets.GH_TOKEN }}`                                   |
 | `cache_key`               | Yes      | Key for caching results across runs<br>Allowed: `A-Za-z0-9._/-`                                                                                                                                     | `cached_results-primer.style-main.json`                     |
@@ -131,7 +131,7 @@ Trigger the workflow manually or automatically based on your configuration. The
 | `reduced_motion`          | No       | Playwright `reducedMotion` setting for scan contexts. Allowed values: `reduce`, `no-preference`                                                                                                     | `reduce`                                                    |
 | `color_scheme`            | No       | Playwright `colorScheme` setting for scan contexts. Allowed values: `light`, `dark`, `no-preference`                                                                                                | `dark`                                                      |
 | `scans`                   | No       | An array of scans (or plugins) to be performed. If not provided, only Axe will be performed.                                                                        | `'["axe", "reflow-scan", ...other plugins]'`                                 |
-| `exclude`                 | No       | A stringified JSON array of CSS selectors to exclude from the Axe scan. Useful for iframes, third-party widgets, or user-generated content.                         | `'["iframe","#third-party-widget"]'`                         |
+| `url_config`              | No       | A stringified JSON array of URL config objects. Each object must have a `url` field and may have an optional `excludeSelectors` field (array of CSS selectors to exclude from the Axe scan for that URL). When provided, takes precedence over the `urls` input. | `'[{"url":"https://example.com","excludeSelectors":["iframe","#widget"]}]'` |
 
 ---
 

action.yml

@@ -4,8 +4,11 @@ description: 'Finds potential accessibility gaps, files GitHub issues to track t
 inputs:
   urls:
     description: 'Newline-delimited list of URLs to check for accessibility issues'
-    required: true
+    required: false
     multiline: true
+  url_config:
+    description: "Stringified JSON array of URL config objects, each with a 'url' field and an optional 'excludeSelectors' field (array of CSS selectors to exclude from the Axe scan for that URL). When provided, takes precedence over the 'urls' input."
+    required: false
   repository:
     description: 'Repository (with owner) to file issues in'
     required: true
@@ -51,9 +54,6 @@ inputs:
   scans:
     description: 'Stringified JSON array of scans to perform. If not provided, only Axe will be performed'
     required: false
-  exclude:
-    description: 'Stringified JSON array of CSS selectors to exclude from the Axe scan'
-    required: false
 
 outputs:
   results:
@@ -112,12 +112,12 @@ runs:
       uses: ./../../_actions/github/accessibility-scanner/current/.github/actions/find
       with:
         urls: ${{ inputs.urls }}
+        url_config: ${{ inputs.url_config }}
         auth_context: ${{ inputs.auth_context || steps.auth.outputs.auth_context }}
         include_screenshots: ${{ inputs.include_screenshots }}
         reduced_motion: ${{ inputs.reduced_motion }}
         color_scheme: ${{ inputs.color_scheme }}
         scans: ${{ inputs.scans }}
-        exclude: ${{ inputs.exclude }}
     - name: File
       id: file
       uses: ./../../_actions/github/accessibility-scanner/current/.github/actions/file