nanyang12138/Cursor Review Action

Reusable Cursor CLI powered PR review action with commands, repo config, diff filtering, and persistent comments

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
cursor-api-keyCursor API key. Pass from secrets.CURSOR_API_KEY.yes
github-tokenGitHub token used to create or update PR comments. Pass github.token.no""
base-shaBase SHA for PR diff.no""
head-shaHead SHA for PR diff.no""
pr-numberPull request number. Required when comment-mode is not off.no""
pr-titlePull request title for review context.no""
pr-bodyPull request body for review context.no""
base-refBase branch name for review context.no""
head-refHead branch name for review context.no""
pr-is-forkWhether the pull request head repository is a fork. Pass github.event.pull_request.head.repo.fork when available.no""
comment-author-associationGitHub author association for issue_comment slash commands.no""
trusted-author-associationsComma-separated author associations allowed to run issue_comment slash commands.noOWNER,MEMBER,COLLABORATOR
commit-messagesNewline-separated commit messages for review context.no""
event-nameGitHub event name, usually github.event_name.no""
comment-bodyPR comment body for command trigger, usually github.event.comment.body.no""
user-promptExtra user instructions. Overrides command text extracted from comment-body.no""
trigger-phraseManual review trigger phrase.no/cursor-review
commandCommand to run: review, ask, improve, describe, or help.noreview
enabled-commandsComma-separated enabled commands.noreview
config-pathRepo-local config file path.no.cursor-review.yml
modelCursor model. Use auto unless you know the account supports a specific model.noauto
languageOutput language.nozh-CN
review-focusComma-separated review focus list.nocorrectness,security,performance,tests,edge-cases
max-findingsMaximum actionable findings to return.no5
max-diff-bytesMaximum diff bytes sent to Cursor.no120000
max-filesMaximum changed files to include in the selected diff. Use 0 for unlimited.no0
max-hunksMaximum diff hunks to include in the selected diff. Use 0 for unlimited.no0
max-cursor-callsMaximum Cursor CLI calls allowed for one action run. Current engine defaults to one call.no1
timeout-secondsPer Cursor CLI call timeout in seconds.no600
filter-modeDiff filter mode: added, diff_context, file.noadded
include-patternsComma-separated file globs to include.no""
exclude-patternsComma-separated file globs to exclude.no""
scope-modeReview scope mode: full or files. Defaults to the full selected PR diff.nofull
scope-filesComma-separated repository-relative paths or globs when scope-mode is files.no""
persistent-commentUpdate the previous Cursor Review comment instead of creating a new one.notrue
comment-modeComment mode: update, create, or off.noupdate
fail-on-errorFail the workflow if Cursor review fails.nofalse
fail-on-findingsFail the workflow when high severity findings are found. Reserved for future use.nofalse
debug-artifactsWrite redacted prompt and raw Cursor output debug files. Off by default to avoid storing raw PR data.nofalse
install-cursorInstall Cursor CLI before running review.notrue
namedescription
summaryRendered PR review markdown.
findings-jsonStructured findings JSON when available.
ci-policy-jsonMachine-readable CI status policy decision for this run.
exit-codeCursor agent exit code.
diff-truncatedWhether the diff was truncated.
resolved-commandResolved command: review, ask, improve, or describe.
should-commentWhether the action should publish a PR comment for this run.
comment-urlCreated or updated PR comment URL.