Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 29 additions & 8 deletions .github/actions/file/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ 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. The path can be absolute or relative to the working directory (which defaults to `GITHUB_WORKSPACE`). For example: `findings.json`.

```JS
'[]'
The file should contain a JSON array of finding objects. For example:
```json
[]
```

#### `repository`
Expand All @@ -22,12 +23,32 @@ 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. The path can be absolute or relative to the working directory (which defaults to `GITHUB_WORKSPACE`). Without this, duplicate issues may be filed. For example: `cached-filings.json`.

The file should contain a JSON array of filing objects. For example:
```json
[
{
"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"}}]'`
Absolute path to a JSON file containing the list of issues filed (and their associated finding(s)). The action writes this file to a temporary directory and returns the absolute path. For example: `$RUNNER_TEMP/filings-<uuid>.json`.

The file will contain a JSON array of filing objects. For example:
```json
[
{
"findings": [],
"issue": {"id":1,"nodeId":"SXNzdWU6MQ==","url":"https://github.com/github/docs/issues/123","title":"Accessibility issue: 1"}
}
]
```
9 changes: 5 additions & 4 deletions .github/actions/find/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,11 @@ configuration option.

### Outputs

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

List of potential accessibility gaps, as stringified JSON. For example:
Absolute path to a JSON file containing the list of potential accessibility gaps. The action writes this file to a temporary directory and returns the absolute path. For example: `$RUNNER_TEMP/findings-<uuid>.json`.

```JS
'[]'
The file will contain a JSON array of finding objects. For example:
```json
[]
```
27 changes: 23 additions & 4 deletions .github/actions/fix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,18 @@ 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. The path can be absolute or relative to the working directory (which defaults to `GITHUB_WORKSPACE`). For example: `issues.json`.

The file should contain a JSON array of issue objects. For example:
```json
[
{"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"}
]
```

#### `repository`

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

### Outputs

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

Absolute path to a JSON file containing the list of pull requests filed (and their associated issues). The action writes this file to a temporary directory and returns the absolute path. For example: `$RUNNER_TEMP/fixings-<uuid>.json`.

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"}}]'`
The file will contain a JSON array of fixing objects. For example:
```json
[
{
"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