Skip to content

Commit e86870e

Browse files
committed
update action and readme
1 parent 600d158 commit e86870e

2 files changed

Lines changed: 21 additions & 10 deletions

File tree

.github/actions/find/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,14 @@ https://primer.style/octicons/
1919

2020
**Optional** Stringified JSON object containing `username`, `password`, `cookies`, and/or `localStorage` from an authenticated session. For example: `{"username":"some-user","password":"correct-horse-battery-staple","cookies":[{"name":"theme-preference","value":"light","domain":"primer.style","path":"/"}],"localStorage":{"https://primer.style":{"theme-preference":"light"}}}`
2121

22+
#### `include_screenshots`
23+
24+
**Optional** Bool - whether to capture screenshots of scanned pages and include links to them in the issue
25+
26+
#### `Scans`
27+
28+
**Optional** Stringified JSON array of scans (string) to perform. If not provided, only axe will be performed. Valid options currently include 'axe'
29+
2230
### Outputs
2331

2432
#### `findings`

.github/actions/find/action.yml

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,30 @@
1-
name: "Find"
2-
description: "Finds potential accessibility gaps."
1+
name: 'Find'
2+
description: 'Finds potential accessibility gaps.'
33

44
inputs:
55
urls:
6-
description: "Newline-delimited list of URLs to check for accessibility issues"
6+
description: 'Newline-delimited list of URLs to check for accessibility issues'
77
required: true
88
multiline: true
99
auth_context:
1010
description: "Stringified JSON object containing 'username', 'password', 'cookies', and/or 'localStorage' from an authenticated session"
1111
required: false
1212
include_screenshots:
13-
description: "Whether to capture screenshots of scanned pages and include links to them in the issue"
13+
description: 'Whether to capture screenshots of scanned pages and include links to them in the issue'
14+
required: false
15+
default: 'false'
16+
scans:
17+
description: 'Stringified JSON array of scans to perform. If not provided, only axe will be performed'
1418
required: false
15-
default: "false"
1619

1720
outputs:
1821
findings:
19-
description: "List of potential accessibility gaps, as stringified JSON"
22+
description: 'List of potential accessibility gaps, as stringified JSON'
2023

2124
runs:
22-
using: "node24"
23-
main: "bootstrap.js"
25+
using: 'node24'
26+
main: 'bootstrap.js'
2427

2528
branding:
26-
icon: "compass"
27-
color: "blue"
29+
icon: 'compass'
30+
color: 'blue'

0 commit comments

Comments
 (0)