mirror of
https://github.com/pacnpal/Claude-code-review.git
synced 2025-12-19 20:01:05 -05:00
Add optional auto-review parameter
- Add auto-review input parameter (defaults to true for backward compatibility) - Skip code review when auto-review is set to false - Update README with usage examples for disabling auto-review - Support conditional reviews based on labels or other criteria
This commit is contained in:
27
README.md
27
README.md
@@ -87,6 +87,32 @@ For existing pull requests, you can manually trigger the review:
|
||||
3. Fill in the branch and pull request number
|
||||
4. Click "Run Workflow"
|
||||
|
||||
### Disabling Auto-Review
|
||||
|
||||
You can disable automatic reviews and only use manual triggers by setting `auto-review: false`:
|
||||
|
||||
```yaml
|
||||
- name: Run Claude Review
|
||||
uses: pacnpal/claude-code-review@main
|
||||
with:
|
||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
anthropic-key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||
pr-number: ${{ github.event.pull_request.number || inputs.pr_number }}
|
||||
auto-review: false # Disables automatic reviews
|
||||
```
|
||||
|
||||
You can also make it conditional based on labels or other criteria:
|
||||
|
||||
```yaml
|
||||
- name: Run Claude Review
|
||||
uses: pacnpal/claude-code-review@main
|
||||
with:
|
||||
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
anthropic-key: ${{ secrets.ANTHROPIC_API_KEY }}
|
||||
pr-number: ${{ github.event.pull_request.number || inputs.pr_number }}
|
||||
auto-review: ${{ contains(github.event.pull_request.labels.*.name, 'needs-review') }}
|
||||
```
|
||||
|
||||
## Setup
|
||||
|
||||
### Prerequisites
|
||||
@@ -119,6 +145,7 @@ For existing pull requests, you can manually trigger the review:
|
||||
| `github-token` | GitHub token for API access | Yes | N/A |
|
||||
| `anthropic-key` | Anthropic API key for Claude | Yes | N/A |
|
||||
| `pr-number` | Pull request number to review | Yes | N/A |
|
||||
| `auto-review` | Enable automatic code reviews (set to `false` to skip) | No | `true` |
|
||||
|
||||
## Outputs
|
||||
|
||||
|
||||
@@ -424,6 +424,15 @@ async function run() {
|
||||
const token = core.getInput('github-token', { required: true });
|
||||
const anthropicKey = core.getInput('anthropic-key', { required: true });
|
||||
let prNumber = core.getInput('pr-number');
|
||||
const autoReview = core.getInput('auto-review', { required: false }) || 'true';
|
||||
|
||||
// Check if auto-review is disabled
|
||||
if (autoReview.toLowerCase() === 'false') {
|
||||
core.info('⏭️ Auto-review is disabled, skipping code review');
|
||||
core.setOutput('diff_size', '0');
|
||||
core.setOutput('review', 'Auto-review disabled');
|
||||
return;
|
||||
}
|
||||
|
||||
// Get PR number from event if not provided
|
||||
const context = github.context;
|
||||
|
||||
@@ -11,6 +11,10 @@ inputs:
|
||||
pr-number:
|
||||
description: 'Pull request number'
|
||||
required: true
|
||||
auto-review:
|
||||
description: 'Enable automatic code reviews (set to false to skip review)'
|
||||
required: false
|
||||
default: 'true'
|
||||
outputs:
|
||||
diff_size:
|
||||
description: 'Size of the relevant code changes'
|
||||
|
||||
9
dist/index.js
vendored
9
dist/index.js
vendored
@@ -32260,6 +32260,15 @@ async function run() {
|
||||
const token = core.getInput('github-token', { required: true });
|
||||
const anthropicKey = core.getInput('anthropic-key', { required: true });
|
||||
let prNumber = core.getInput('pr-number');
|
||||
const autoReview = core.getInput('auto-review', { required: false }) || 'true';
|
||||
|
||||
// Check if auto-review is disabled
|
||||
if (autoReview.toLowerCase() === 'false') {
|
||||
core.info('⏭️ Auto-review is disabled, skipping code review');
|
||||
core.setOutput('diff_size', '0');
|
||||
core.setOutput('review', 'Auto-review disabled');
|
||||
return;
|
||||
}
|
||||
|
||||
// Get PR number from event if not provided
|
||||
const context = github.context;
|
||||
|
||||
Reference in New Issue
Block a user