Skip to content

Updates find, file, fix action READMEs to include changes to the inputs/outputs. #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lindseywild merged 5 commits into from
Apr 1, 2026
Merged

Updates find, file, fix action READMEs to include changes to the inputs/outputs. #181

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dd5243a
Updates action README's to support v3.0.0 release
lindseywild Apr 1, 2026
5d7bf85
Rename inputs in README for accessibility action
lindseywild Apr 1, 2026
72aa646
Rename inputs and outputs to use file paths
lindseywild Apr 1, 2026
1c0062f
fix: update README examples to show file paths instead of JSON content
Copilot Apr 1, 2026
ed52816
Clarify path resolution for file path inputs and outputs
lindseywild Apr 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .github/actions/file/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Files GitHub issues to track potential accessibility gaps.

### Inputs

#### `findings`
#### `findings_file`

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

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

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

#### `cached_filings`
#### `cached_filings_file`

**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"}}]'`
**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"}}]'`

### Outputs

#### `filings`
#### `filings_file`

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"}}]'`
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"}}]'`
4 changes: 2 additions & 2 deletions .github/actions/find/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ configuration option.

### Outputs

#### `findings`
#### `findings_file`

List of potential accessibility gaps, as stringified JSON. For example:
List of potential accessibility gaps, output as a JSON file. For example:

```JS
'[]'
Expand Down
8 changes: 4 additions & 4 deletions .github/actions/fix/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ Attempts to fix issues with Copilot.

### Inputs

#### `issues`
#### `issues_file`

**Required** List of issues to attempt to fix—including, at a minimum, their `url`s—as stringified JSON. 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"}]'`.
**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"}]'`.
Comment thread
lindseywild marked this conversation as resolved.
Outdated

#### `repository`

Expand All @@ -20,6 +20,6 @@ Attempts to fix issues with Copilot.

### Outputs

#### `fixings`
#### `fixings_file`

List of pull requests filed (and their associated issues), as stringified JSON. 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"}}]'`
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"}}]'`
Loading