Skip to content

docs(action): Add action README and review guide for review mode#95

Merged
mhiro2 merged 1 commit into
mainfrom
docs/action-readme-and-review-guide
Apr 29, 2026
Merged

docs(action): Add action README and review guide for review mode#95
mhiro2 merged 1 commit into
mainfrom
docs/action-readme-and-review-guide

Conversation

@mhiro2

@mhiro2 mhiro2 commented Apr 28, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add action/README.md as the action's reference (inputs, outputs, exit codes for both diff and review modes, plus the two-pass review implementation note).
  • Rework docs/github-actions.md into a workflow-wiring guide that links to the new reference and to the sticky-comment sample, with no duplicated input/output tables.

Changes

  • 40e8faf : docs(action): add action README and review guide for review mode
    • Introduce action/README.md covering quick start (diff and review), full input reference (mode-aware), output reference, exit-code semantics for both modes, two-pass review explanation, locally built binary recipe, and troubleshooting (install rate limits, dialect inference, format compatibility, sticky comment cleanup).
    • Rewrite docs/github-actions.md as a guide: dual-mode quick start, schema materialization steps shared by both modes, "Reviewing migrations on pull requests" walkthrough that distills the patterns embedded in action/examples/relune-review.yaml, expanded fork PR section with skip / workflow_run / pull_request_target options, and a unified sample-workflow table covering diff and review.
    • Note that @v0 does not resolve until the first tagged release is cut and direct readers to @main or a commit SHA in the meantime.

@github-actions

This comment has been minimized.

@mhiro2 mhiro2 self-assigned this Apr 29, 2026
@mhiro2 mhiro2 added the documentation Improvements or additions to documentation label Apr 29, 2026
Add action/README.md as the reference for every input, output, and exit
code (covering both diff and review modes plus the two-pass review
implementation), and rework docs/github-actions.md into a workflow-wiring
guide that links to that reference and to the sticky-comment sample
without duplicating the input/output tables.
@mhiro2
mhiro2 force-pushed the docs/action-readme-and-review-guide branch from 81cface to 40e8faf Compare April 29, 2026 01:15
@github-actions

Copy link
Copy Markdown

Code Metrics Report

main (2e6e20c) #95 (75fa94a) +/-
Coverage 94.6% 94.6% 0.0%
Test Execution Time 1m52s 1m32s -20s
Details
  |                     | main (2e6e20c) | #95 (75fa94a) | +/-  |
  |---------------------|----------------|---------------|------|
  | Coverage            |          94.6% |         94.6% | 0.0% |
  |   Files             |             81 |            81 |    0 |
  |   Lines             |          36827 |         36827 |    0 |
  |   Covered           |          34864 |         34864 |    0 |
+ | Test Execution Time |          1m52s |         1m32s | -20s |

Reported by octocov

@mhiro2
mhiro2 merged commit 4f9bbb6 into main Apr 29, 2026
5 checks passed
@mhiro2
mhiro2 deleted the docs/action-readme-and-review-guide branch April 29, 2026 01:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant