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

Includes changes from
#179.

Author: lindseywild

.github/actions/file/README.md

@@ -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`
@@ -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"}
+  }
+]
+```

.github/actions/find/README.md

@@ -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
+[]
 ```

.github/actions/fix/README.md

@@ -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`
 
@@ -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"}
+  }
+]
+```