Updates find, file, fix action READMEs to include changes to the inputs/outputs.#181
Updates find, file, fix action READMEs to include changes to the inputs/outputs.#181lindseywild merged 5 commits intomainfrom
Conversation
Updated output description to clarify that findings are now output as a JSON file.
Updated parameter names and descriptions for clarity.
Updated input and output parameter names to reflect file paths for issues and fixings.
There was a problem hiding this comment.
Pull request overview
Updates the find, file, and fix GitHub Action READMEs to reflect the shift (from #179) from JSON string inputs/outputs to file-based inputs/outputs.
Changes:
- Renames documented inputs/outputs to
*_filevariants (e.g.,findings_file,filings_file,fixings_file). - Updates descriptions to indicate values are file paths rather than stringified JSON.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .github/actions/find/README.md | Documents findings_file output instead of findings. |
| .github/actions/file/README.md | Documents findings_file / cached_filings_file inputs and filings_file output. |
| .github/actions/fix/README.md | Documents issues_file input and fixings_file output. |
Comments suppressed due to low confidence (5)
.github/actions/fix/README.md:25
- This output is documented as a file path, but the example shown is still JSON content. Update the example to a representative path and optionally add a separate snippet showing what the JSON file contains.
#### `fixings_file`
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"}}]'`
.github/actions/file/README.md:15
- This input is now documented as a JSON file path, but the example remains
'[]'(JSON content). Update the example to a file path and (optionally) provide a separate example of the file contents.
This issue also appears in the following locations of the same file:
- line 25
- line 31
#### `findings_file`
**Required** Path to a JSON file containing the list of potential accessibility gaps. For example:
```JS
'[]'
**.github/actions/file/README.md:27**
* This input is described as a file path, but the example value is still JSON content. Please change the example to a file path and, if needed, include the JSON contents as a separate example block.
cached_filings_file
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"}}]'
**.github/actions/file/README.md:33**
* This output is a file path, but the example shown is JSON content. Update the example to a path to avoid confusion for action consumers.
filings_file
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"}}]'
**.github/actions/find/README.md:50**
* This output is now `findings_file`, but the description/example still reads like the output value is the JSON itself (`'[]'`). Update the wording and example to reflect that the output is a file path (and optionally add an example of reading/parsing the file).
findings_file
List of potential accessibility gaps, output as a JSON file. For example:
'[]'</details>
---
💡 <a href="/github/accessibility-scanner/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
Agent-Logs-Url: https://github.com/github/accessibility-scanner/sessions/b0cb0e0c-0e54-4d95-94ff-e51a544599c0 Co-authored-by: lindseywild <35239154+lindseywild@users.noreply.github.com>
|
Looks good, though it'd be good to have the docs be more explicit about how the path works: are they supposed to use an absolute path, or is relative to the directory without |
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>
|
@JoyceZhu updated! |
Includes changes from #179.