-
Notifications
You must be signed in to change notification settings - Fork 1.6k
docs: clarify that Claude does not auto-create PRs by default #824
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,16 @@ | |
| - **No Cross-Repository Access**: Each action invocation is limited to the repository where it was triggered | ||
| - **Limited Scope**: The token cannot access other repositories or perform actions beyond the configured permissions | ||
|
|
||
| ## Pull Request Creation | ||
|
|
||
| In its default configuration, **Claude does not create pull requests automatically** when responding to `@claude` mentions. Instead: | ||
|
|
||
| - Claude commits code changes to a new branch | ||
| - Claude provides a **link to the GitHub PR creation page** in its response | ||
| - **The user must click the link and create the PR themselves**, ensuring human oversight before any code is proposed for merging | ||
|
Comment on lines
+18
to
+22
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The phrasing "ensuring human oversight before any code is proposed for merging" could be clearer about what this oversight entails. Currently, users click a link to a pre-filled PR creation form (with title, body, and branch already configured). The oversight is confirmatory rather than preventative. Consider rephrasing to be more precise:
This more accurately describes the security boundary while still conveying the key point that automatic PR creation doesn't happen. |
||
|
|
||
| This design ensures that users retain full control over what pull requests are created and can review the changes before initiating the PR workflow. | ||
|
|
||
| ## ⚠️ Prompt Injection Risks | ||
|
|
||
| **Beware of potential hidden markdown when tagging Claude on untrusted content.** External contributors may include hidden instructions through HTML comments, invisible characters, hidden attributes, or other techniques. The action sanitizes content by stripping HTML comments, invisible characters, markdown image alt text, hidden HTML attributes, and HTML entities, but new bypass techniques may emerge. We recommend reviewing the raw content of all input coming from external contributors before allowing Claude to process it. | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be helpful to list what config controls this behavior?