3 Commits

Author SHA1 Message Date
pacnpal
782f8cccd0 Update README.md 2024-12-24 10:58:45 -05:00
pacnpal
6a73dbfff6 Update README.md 2024-12-24 10:56:46 -05:00
pacnpal
52219d4d98 Update README.md 2024-12-24 10:53:19 -05:00

View File

@@ -13,29 +13,44 @@ A GitHub Action that performs automated code reviews using Claude AI.
Add this to your GitHub workflow file (e.g. `.github/workflows/review.yml`):
```yaml
name: Code Review
name: Claude Code Review
permissions:
contents: read
pull-requests: write
on:
# Run on new/updated PRs
pull_request:
types: [opened, reopened, synchronize]
# Allow manual triggers for existing PRs
workflow_dispatch:
inputs:
pr_number:
description: 'Pull Request Number'
required: true
type: string
jobs:
review:
code-review:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: your-username/claude-code-review-action@v1
- name: Run Claude Review
uses: pacnpal/claude-code-review@v1.0.6
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
anthropic-key: ${{ secrets.ANTHROPIC_API_KEY }}
pr-number: ${{ github.event.pull_request.number }}
pr-number: ${{ github.event.pull_request.number || inputs.pr_number }}
```
- Click on "Claude Code Review" Action under Actions tab.
- Click "Run Workflow"
- Fill in branch and pull request ID and click "Run Workflow"
## Setup
@@ -130,4 +145,4 @@ MIT License - see the [LICENSE](LICENSE) file for details
- Open an issue for bugs/feature requests
- Submit a PR to contribute
- Contact maintainers for other questions
- Contact maintainers for other questions