Skip to content

Commit ed52816

Browse files
lindseywildCopilot
andcommitted
Clarify path resolution for file path inputs and outputs
For inputs: explicitly state that paths can be absolute or relative to the working directory (GITHUB_WORKSPACE). For outputs: clarify that the action generates an absolute path in RUNNER_TEMP automatically. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 1c0062f commit ed52816

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

.github/actions/file/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ 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: `findings.json`.
11+
**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`.
1212

1313
The file should contain a JSON array of finding objects. For example:
1414
```json
@@ -25,7 +25,7 @@ The file should contain a JSON array of finding objects. For example:
2525

2626
#### `cached_filings_file`
2727

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`.
28+
**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`.
2929

3030
The file should contain a JSON array of filing objects. For example:
3131
```json
@@ -41,7 +41,7 @@ The file should contain a JSON array of filing objects. For example:
4141

4242
#### `filings_file`
4343

44-
Path to a JSON file containing the list of issues filed (and their associated finding(s)). For example: `filings.json`.
44+
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`.
4545

4646
The file will contain a JSON array of filing objects. For example:
4747
```json

.github/actions/find/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ configuration option.
4343

4444
#### `findings_file`
4545

46-
Path to a JSON file containing the list of potential accessibility gaps. For example: `findings.json`.
46+
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`.
4747

4848
The file will contain a JSON array of finding objects. For example:
4949
```json

.github/actions/fix/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ 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: `issues.json`.
11+
**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`.
1212

1313
The file should contain a JSON array of issue objects. For example:
1414
```json
@@ -31,7 +31,7 @@ The file should contain a JSON array of issue objects. For example:
3131

3232
#### `fixings_file`
3333

34-
Path to a JSON file containing the list of pull requests filed (and their associated issues). For example: `fixings.json`.
34+
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`.
3535

3636
The file will contain a JSON array of fixing objects. For example:
3737
```json

0 commit comments

Comments
 (0)