Skip to content

Commit ead6667

Browse files
committed
update readme
1 parent 23b1259 commit ead6667

File tree

16 files changed

+54
-23
lines changed

16 files changed

+54
-23
lines changed

β€Ž.github/workflows/ai-review.ymlβ€Ž

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ on:
6262
jobs:
6363
ai-review:
6464
runs-on: ubuntu-latest
65+
permissions:
66+
contents: read
67+
pull-requests: write
68+
issues: write
6569
if: github.event.pull_request.draft == false
6670

6771
steps:
@@ -96,7 +100,7 @@ jobs:
96100
fi
97101
98102
- name: AI Code Review
99-
uses: obiwancenobi/ai-code-reviewer@v1
103+
uses: obiwancenobi/ai-code-reviewer@v1.0.12
100104
with:
101105
pr-number: ${{ inputs.pr-number || github.event.pull_request.number }}
102106
repository: ${{ inputs.repository || github.repository }}

β€ŽREADME.mdβ€Ž

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,25 @@ AI-powered code review automation for GitHub pull requests using configurable AI
2323
### AI Code Review in Action
2424

2525
**Inline Comments on Pull Requests:**
26-
![AI Code Review Comments](screenshots/ss_1.png)
27-
![AI Code Review Comments](screenshots/ss_2.png)
26+
![AI Code Review Comments](screenshots/inline_comment_1.png)
27+
![AI Code Review Comments](screenshots/inline_comment_2.png)
28+
![AI Code Review Comments](screenshots/inline_comment_3.png)
29+
![AI Code Review Comments](screenshots/inline_comment_4.png)
2830

2931
**Discord Notifications:**
3032
![Discord Notifications](screenshots/discord_notif.png)
3133

32-
*See the AI reviewer providing detailed code analysis with specific suggestions and line-by-line feedback, plus real-time Discord notifications for review status updates.*
34+
**CLI:**
35+
![CLI](screenshots/cli.png)
36+
37+
*See the AI reviewer providing detailed code analysis with specific suggestions and line-by-line feedback, plus real-time Discord notifications showing AI model information for review status updates.*
3338

3439
## πŸš€ Features
3540

3641
- **Multi-Provider AI Support**: OpenAI GPT-4, Anthropic Claude, Google Gemini, DeepSeek, OpenRouter, xAI Grok, Groq, and Z.ai
3742
- **Configurable Reviewer Personas**: Senior Engineer, Security Expert, Performance Specialist, Accessibility Advocate
3843
- **Smart File Processing**: Large file chunking, comprehensive exclusion patterns for all major development stacks (164+ patterns)
39-
- **Discord Notifications**: Real-time status updates for review start, completion, and errors
44+
- **Discord Notifications**: Real-time status updates for review start, completion, and errors with AI model information
4045
- **GitHub Integration**: Seamless PR commenting with inline and general review comments
4146
- **Enterprise Ready**: Secure credential management, rate limiting, comprehensive error handling, robust JSON parsing
4247
- **Universal Compatibility**: Works with any technology stack (Node.js, Python, Java, Flutter, .NET, Go, Rust, PHP, Ruby, etc.)
@@ -69,7 +74,7 @@ Add AI code review to any repository with one simple step:
6974

7075
steps:
7176
- name: AI Code Review
72-
uses: obiwancenobi/ai-code-reviewer@v1
77+
uses: obiwancenobi/ai-code-reviewer@v1.0.12
7378
with:
7479
pr-number: ${{ github.event.pull_request.number }}
7580
repository: ${{ github.repository }}
@@ -105,7 +110,7 @@ Use repository variables for organization-wide settings:
105110

106111
```yaml
107112
- name: AI Code Review
108-
uses: obiwancenobi/ai-code-reviewer@v1
113+
uses: obiwancenobi/ai-code-reviewer@v1.0.12
109114
with:
110115
pr-number: ${{ github.event.pull_request.number }}
111116
repository: ${{ github.repository }}
@@ -237,7 +242,12 @@ You can define custom reviewer personas with your own prompts:
237242

238243
### Comment Attribution
239244

240-
AI review comments appear with the GitHub Actions bot identity. The author attribution is automatically handled by GitHub based on the token used for authentication.
245+
AI review comments appear with the GitHub Actions bot identity and include AI model information. The author attribution is automatically handled by GitHub based on the token used for authentication.
246+
247+
**Example comment attribution:**
248+
```
249+
*Reviewed by πŸ€– (senior-engineer) using openai/gpt-4*
250+
```
241251
242252
**Note:** The `author` configuration option was removed as GitHub's API doesn't support custom author association for review comments. Comments will appear as coming from the authenticated user/bot associated with the `GITHUB_TOKEN`.
243253
@@ -287,8 +297,8 @@ The system automatically excludes common build artifacts and dependencies:
287297
3. **File Analysis**: System identifies changed files, applies comprehensive exclusion filters
288298
4. **AI Processing**: Code is chunked if needed and sent to configured AI model
289299
5. **Review Generation**: AI analyzes code using specified persona and generates comments
290-
6. **Comment Posting**: Inline and general comments posted to GitHub PR
291-
7. **Notification**: Discord webhook sends status updates (if configured)
300+
6. **Comment Posting**: Inline and general comments posted to GitHub PR with AI model attribution
301+
7. **Notification**: Discord webhook sends status updates with AI model information (if configured)
292302

293303
## πŸ”§ Action Inputs
294304

@@ -333,7 +343,7 @@ Settings are applied in this priority order (highest to lowest):
333343

334344
**Workflow sets:**
335345
```yaml
336-
- uses: obiwancenobi/ai-code-reviewer@v1
346+
- uses: obiwancenobi/ai-code-reviewer@v1.0.12
337347
with:
338348
ai-provider: ${{ vars.AI_PROVIDER || 'anthropic' }}
339349
ai-model: ${{ vars.AI_MODEL || 'claude-3-sonnet' }}
@@ -432,7 +442,7 @@ jobs:
432442
433443
steps:
434444
- name: AI Code Review
435-
uses: obiwancenobi/ai-code-reviewer@v1
445+
uses: obiwancenobi/ai-code-reviewer@v1.0.12
436446
with:
437447
pr-number: ${{ github.event.pull_request.number }}
438448
repository: ${{ github.repository }}
@@ -462,7 +472,7 @@ jobs:
462472
463473
steps:
464474
- name: AI Code Review
465-
uses: obiwancenobi/ai-code-reviewer@v1
475+
uses: obiwancenobi/ai-code-reviewer@v1.0.12
466476
with:
467477
pr-number: ${{ github.event.pull_request.number }}
468478
repository: ${{ github.repository }}
@@ -475,7 +485,7 @@ jobs:
475485
#### Python Projects
476486
```yaml
477487
- name: AI Code Review
478-
uses: obiwancenobi/ai-code-reviewer@v1
488+
uses: obiwancenobi/ai-code-reviewer@v1.0.12
479489
with:
480490
pr-number: ${{ github.event.pull_request.number }}
481491
repository: ${{ github.repository }}
@@ -488,7 +498,7 @@ jobs:
488498
#### Java/.NET Projects
489499
```yaml
490500
- name: AI Code Review
491-
uses: obiwancenobi/ai-code-reviewer@v1
501+
uses: obiwancenobi/ai-code-reviewer@v1.0.12
492502
with:
493503
pr-number: ${{ github.event.pull_request.number }}
494504
repository: ${{ github.repository }}
@@ -510,7 +520,7 @@ Set these in repository Settings β†’ Actions β†’ Variables:
510520

511521
```yaml
512522
- name: AI Code Review
513-
uses: obiwancenobi/ai-code-reviewer@v1
523+
uses: obiwancenobi/ai-code-reviewer@v1.0.12
514524
with:
515525
pr-number: ${{ github.event.pull_request.number }}
516526
repository: ${{ github.repository }}

β€Žindex.jsβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ const program = new Command();
1616
program
1717
.name('ai-code-reviewer')
1818
.description('AI-powered code review for GitHub pull requests')
19-
.version('1.0.11');
19+
.version('1.0.12');
2020

2121
// Review command for GitHub Actions
2222
program

β€Žpackage.jsonβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ai-code-reviewer",
3-
"version": "1.0.11",
3+
"version": "1.0.12",
44
"description": "AI as Code Reviewer",
55
"main": "index.js",
66
"scripts": {

β€Žscreenshots/cli.pngβ€Ž

177 KB
Loading
50.8 KB
Loading
214 KB
Loading
212 KB
Loading
209 KB
Loading
204 KB
Loading

0 commit comments

Comments
Β (0)