Skip to content

Commit 1c0062f

Browse files
Copilotlindseywild
andauthored
fix: update README examples to show file paths instead of JSON content
Agent-Logs-Url: https://github.com/github/accessibility-scanner/sessions/b0cb0e0c-0e54-4d95-94ff-e51a544599c0 Co-authored-by: lindseywild <35239154+lindseywild@users.noreply.github.com>
1 parent 72aa646 commit 1c0062f

3 files changed

Lines changed: 51 additions & 10 deletions

File tree

.github/actions/file/README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@ Files GitHub issues to track potential accessibility gaps.
88

99
#### `findings_file`
1010

11-
**Required** Path to a JSON file containing the list of potential accessibility gaps. For example:
11+
**Required** Path to a JSON file containing the list of potential accessibility gaps. For example: `findings.json`.
1212

13-
```JS
14-
'[]'
13+
The file should contain a JSON array of finding objects. For example:
14+
```json
15+
[]
1516
```
1617

1718
#### `repository`
@@ -24,10 +25,30 @@ Files GitHub issues to track potential accessibility gaps.
2425

2526
#### `cached_filings_file`
2627

27-
**Optional** Path to a JSON file containing cached filings from previous runs. Without this, duplicate issues may be filed. For example: `'[{"findings":[],"issue":{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"}}]'`
28+
**Optional** Path to a JSON file containing cached filings from previous runs. Without this, duplicate issues may be filed. For example: `cached-filings.json`.
29+
30+
The file should contain a JSON array of filing objects. For example:
31+
```json
32+
[
33+
{
34+
"findings": [],
35+
"issue": {"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"}
36+
}
37+
]
38+
```
2839

2940
### Outputs
3041

3142
#### `filings_file`
3243

33-
Path to a JSON file containing the list of issues filed (and their associated finding(s)). For example: `'[{"findings":[],"issue":{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"}}]'`
44+
Path to a JSON file containing the list of issues filed (and their associated finding(s)). For example: `filings.json`.
45+
46+
The file will contain a JSON array of filing objects. For example:
47+
```json
48+
[
49+
{
50+
"findings": [],
51+
"issue": {"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"}
52+
}
53+
]
54+
```

.github/actions/find/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,9 @@ configuration option.
4343

4444
#### `findings_file`
4545

46-
List of potential accessibility gaps, output as a JSON file. For example:
46+
Path to a JSON file containing the list of potential accessibility gaps. For example: `findings.json`.
4747

48-
```JS
49-
'[]'
48+
The file will contain a JSON array of finding objects. For example:
49+
```json
50+
[]
5051
```

.github/actions/fix/README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,16 @@ Attempts to fix issues with Copilot.
88

99
#### `issues_file`
1010

11-
**Required** Path to a JSON file containing the list of issues to attempt to fix—including, at a minimum, their `url`s. For example: `'[{"url":"https://github.com/github/docs/issues/123"},{"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124"},{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}]'`.
11+
**Required** Path to a JSON file containing the list of issues to attempt to fix—including, at a minimum, their `url`s. For example: `issues.json`.
12+
13+
The file should contain a JSON array of issue objects. For example:
14+
```json
15+
[
16+
{"url":"https://github.com/github/docs/issues/123"},
17+
{"nodeId":"SXNzdWU6Mg==","url":"https://github.com/github/docs/issues/124"},
18+
{"id":4,"nodeId":"SXNzdWU6NA==","url":"https://github.com/github/docs/issues/126","title":"Accessibility issue: 4"}
19+
]
20+
```
1221

1322
#### `repository`
1423

@@ -22,4 +31,14 @@ Attempts to fix issues with Copilot.
2231

2332
#### `fixings_file`
2433

25-
Path to a JSON file containing the list of pull requests filed (and their associated issues). For example: `'[{"issue":{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},"pullRequest":{"url":"https://github.com/github/docs/pulls/124"}}]'`
34+
Path to a JSON file containing the list of pull requests filed (and their associated issues). For example: `fixings.json`.
35+
36+
The file will contain a JSON array of fixing objects. For example:
37+
```json
38+
[
39+
{
40+
"issue": {"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"},
41+
"pullRequest": {"url":"https://github.com/github/docs/pulls/124"}
42+
}
43+
]
44+
```

0 commit comments

Comments
 (0)