Skip to content

Commit 5d7bf85

Browse files
authored
Rename inputs in README for accessibility action
Updated parameter names and descriptions for clarity.
1 parent dd5243a commit 5d7bf85

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

.github/actions/file/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Files GitHub issues to track potential accessibility gaps.
66

77
### Inputs
88

9-
#### `findings`
9+
#### `findings_file`
1010

11-
**Required** List of potential accessibility gaps, as stringified JSON. For example:
11+
**Required** Path to a JSON file containing the list of potential accessibility gaps. For example:
1212

1313
```JS
1414
'[]'
@@ -22,12 +22,12 @@ Files GitHub issues to track potential accessibility gaps.
2222

2323
**Required** Token with fine-grained permission 'issues: write'.
2424

25-
#### `cached_filings`
25+
#### `cached_filings_file`
2626

27-
**Optional** Cached filings from previous runs, as stringified JSON. 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"}}]'`
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"}}]'`
2828

2929
### Outputs
3030

31-
#### `filings`
31+
#### `filings_file`
3232

33-
List of issues filed (and their associated finding(s)), as stringified JSON. For example: `'[{"findings":[],"issue":{"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"}}]'`
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"}}]'`

0 commit comments

Comments
 (0)