Skip to content

Updates docs on v3 branch#182

Merged
lindseywild merged 6 commits intov3from
main
Apr 1, 2026
Merged

Updates docs on v3 branch#182
lindseywild merged 6 commits intov3from
main

Conversation

@lindseywild
Copy link
Copy Markdown
Contributor

No description provided.

lindseywild and others added 6 commits April 1, 2026 12:42
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.
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>
@lindseywild lindseywild requested a review from a team as a code owner April 1, 2026 19:00
@lindseywild lindseywild merged commit 32ad4b4 into v3 Apr 1, 2026
9 checks passed
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates documentation for the find, file, and fix GitHub Actions to reflect the v3 interface that passes data via JSON files (inputs/outputs) rather than stringified JSON values.

Changes:

  • Document input migrations to *_file (e.g., issues_file, findings_file, cached_filings_file) with JSON file format examples.
  • Document output migrations to *_file (e.g., findings_file, filings_file, fixings_file) describing the temp-file behavior and example file contents.
  • Standardize examples to show JSON arrays as file contents (using json code fences).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
.github/actions/fix/README.md Updates docs to use issues_file input and fixings_file output, with file-content examples.
.github/actions/find/README.md Updates docs to describe findings_file output as a temp JSON file and shows example JSON contents.
.github/actions/file/README.md Updates docs to use findings_file / cached_filings_file inputs and filings_file output with JSON file format examples.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants