generated from ztimson/template
Use npx instead
This commit is contained in:
@@ -13,4 +13,4 @@ quote_type = single
|
|||||||
|
|
||||||
[*.md]
|
[*.md]
|
||||||
max_line_length = off
|
max_line_length = off
|
||||||
trim_trailing_whitespace = false
|
trim_trailing_whitespace = false
|
||||||
|
|||||||
70
.github/workflows/build.yml
vendored
70
.github/workflows/build.yml
vendored
@@ -1,44 +1,48 @@
|
|||||||
name: Build and publish
|
name: Publish Library
|
||||||
run-name: Build and publish
|
run-name: Publish Library
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
container:
|
build:
|
||||||
name: Build Container
|
name: Build NPM Project
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container: docker
|
container: node:alpine
|
||||||
steps:
|
steps:
|
||||||
- name: Build Container
|
- name: Clone Repository
|
||||||
run: |
|
uses: ztimson/actions/clone@develop
|
||||||
git clone -b "${{github.ref_name}}" "$(echo ${{github.server_url}}/${{github.repository}}.git | sed s%://%://${{github.token}}@% )" .
|
|
||||||
DOCKER_HUB=$([ -n "${{secrets.DOCKER_HUB_USER}}" ] && [ -n "${{secrets.DOCKER_HUB_TOKEN}}" ] && [ -n "${{secrets.DOCKER_HUB_IMAGE}}" ] && echo "true" || echo "false")
|
|
||||||
REGISTRY="$(echo "${{github.server_url}}" | sed -E 's|https?://||')"
|
|
||||||
VERSION="$(cat package.json | grep version | grep -Eo '[0-9][[:alnum:]\.\/\-]+')"
|
|
||||||
|
|
||||||
docker login -u "${{github.repository_owner}}" -p "${{secrets.DEPLOY_TOKEN}}" "$REGISTRY"
|
- name: Install & Build
|
||||||
if [ "$DOCKER_HUB" = "true" ]; then docker login -u "${{secrets.DOCKER_HUB_USER}}" -p "${{secrets.DOCKER_HUB_TOKEN}}" docker.io; fi
|
run: npm i && npm run build
|
||||||
|
|
||||||
docker build -t "$REGISTRY/${{github.repository}}:${{github.ref_name}}" .
|
- name: Publish Library
|
||||||
docker push "$REGISTRY/${{github.repository}}:${{github.ref_name}}"
|
run: |
|
||||||
if [ "$DOCKER_HUB" = "true" ]; then
|
if [ "${{github.ref_name}}" = "master" ]; then
|
||||||
docker tag "$REGISTRY/${{github.repository}}:${{github.ref_name}}" "docker.io/${{secrets.DOCKER_HUB_IMAGE}}:${{github.ref_name}}"
|
REGISTRY="${{github.server_url}}/api/packages/${{github.repository_owner}}/npm/"
|
||||||
docker push "docker.io/${{secrets.DOCKER_HUB_IMAGE}}:${{github.ref_name}}"
|
npm set registry "$REGISTRY"
|
||||||
fi
|
npm set $(echo $REGISTRY | sed s%http:%% | sed s%https:%% ):_authToken "${{secrets.DEPLOY_TOKEN}}"
|
||||||
|
npm publish || echo "Failed to publish"
|
||||||
|
|
||||||
if [ "${{github.ref_name}}" = "master" ]; then
|
REGISTRY="https://registry.npmjs.org/"
|
||||||
docker tag "$REGISTRY/${{github.repository}}:${{github.ref_name}}" "$REGISTRY/${{github.repository}}:$VERSION"
|
npm set registry "$REGISTRY"
|
||||||
docker push "$REGISTRY/${{github.repository}}:$VERSION"
|
npm set $(echo $REGISTRY | sed s%http:%% | sed s%https:%% ):_authToken "${{secrets.NPM_TOKEN}}"
|
||||||
if [ "$DOCKER_HUB" = "true" ]; then
|
npm publish || echo "Failed to publish"
|
||||||
docker tag "$REGISTRY/${{github.repository}}:${{github.ref_name}}" "docker.io/${{secrets.DOCKER_HUB_IMAGE}}:$VERSION"
|
fi
|
||||||
docker push "docker.io/${{secrets.DOCKER_HUB_IMAGE}}:$VERSION"
|
tag:
|
||||||
fi
|
name: Tag Version
|
||||||
|
needs: build
|
||||||
|
if: ${{github.ref_name}} == 'release'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container: node:alpine
|
||||||
|
steps:
|
||||||
|
- name: Clone Repository
|
||||||
|
uses: ztimson/actions/clone@develop
|
||||||
|
|
||||||
docker tag "$REGISTRY/${{github.repository}}:${{github.ref_name}}" "$REGISTRY/${{github.repository}}:latest"
|
- name: Get Version Number
|
||||||
docker push "$REGISTRY/${{github.repository}}:latest"
|
run: echo "VERSION=$(cat package.json | grep version | grep -Eo ':.+' | grep -Eo '[[:alnum:]\.\/\-]+')" >> $GITHUB_ENV
|
||||||
if [ "$DOCKER_HUB" = "true" ]; then
|
|
||||||
docker tag "$REGISTRY/${{github.repository}}:${{github.ref_name}}" "docker.io/${{secrets.DOCKER_HUB_IMAGE}}:latest"
|
- name: Tag Version
|
||||||
docker push "docker.io/${{secrets.DOCKER_HUB_IMAGE}}:latest"
|
uses: ztimson/actions/tag@develop
|
||||||
fi
|
with:
|
||||||
fi
|
tag: ${{env.VERSION}}
|
||||||
|
|||||||
27
.github/workflows/review.yml
vendored
27
.github/workflows/review.yml
vendored
@@ -6,7 +6,7 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
review:
|
review:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
container: docker
|
container: node:22
|
||||||
steps:
|
steps:
|
||||||
- name: Fetch code
|
- name: Fetch code
|
||||||
run: |
|
run: |
|
||||||
@@ -15,17 +15,14 @@ jobs:
|
|||||||
git fetch origin ${{ github.event.pull_request.base.ref }}
|
git fetch origin ${{ github.event.pull_request.base.ref }}
|
||||||
|
|
||||||
- name: Run AI Review
|
- name: Run AI Review
|
||||||
run: |
|
run: npx -y @ztimson/ai-agents review
|
||||||
echo $GITHUB_WORKSPACE
|
env:
|
||||||
docker pull "git.zakscode.com/ztimson/ai-reviewer:test"
|
AI_HOST: anthropic
|
||||||
docker run --rm -v $GITHUB_WORKSPACE:/app \
|
AI_MODEL: claude-sonnet-4-5
|
||||||
-e AI_HOST=anthropic \
|
AI_TOKEN: ${{ secrets.ANTHROPIC_TOKEN }}
|
||||||
-e AI_MODEL=claude-sonnet-4-5 \
|
GIT_HOST: ${{ github.server_url }}
|
||||||
-e AI_TOKEN="${{ secrets.ANTHROPIC_TOKEN }}" \
|
GIT_OWNER: ${{ github.repository_owner }}
|
||||||
-e GIT_HOST="${{ github.server_url }}" \
|
GIT_REPO: ${{ github.event.repository.name }}
|
||||||
-e GIT_OWNER="${{ github.repository_owner }}" \
|
GIT_TOKEN: ${{ secrets.ASSISTANT_TOKEN }}
|
||||||
-e GIT_REPO="${{ github.event.repository.name }}" \
|
GIT_BRANCH: origin/${{ github.event.pull_request.base.ref }}
|
||||||
-e GIT_TOKEN="${{ secrets.ASSISTANT_TOKEN }}" \
|
PULL_REQUEST: ${{ github.event.pull_request.number }}
|
||||||
-e GIT_BRANCH="origin/${{ github.event.pull_request.base.ref }}" \
|
|
||||||
-e PULL_REQUEST="${{ github.event.pull_request.number }}" \
|
|
||||||
"git.zakscode.com/ztimson/ai-reviewer:test"
|
|
||||||
|
|||||||
@@ -1,7 +0,0 @@
|
|||||||
FROM node:22
|
|
||||||
|
|
||||||
COPY . /ai
|
|
||||||
RUN cd /ai && npm ci && mkdir -p /app
|
|
||||||
|
|
||||||
WORKDIR /app
|
|
||||||
ENTRYPOINT ["node", "/ai/src/review.mjs", "/app"]
|
|
||||||
55
README.md
55
README.md
@@ -6,29 +6,29 @@
|
|||||||
<img src="https://git.zakscode.com/repo-avatars/d2c56ffd0220751c2f4a9f6fc1e8125a9a63aeed452ae4f4ab696c084330faa2" alt="Logo" width="200" height="200">
|
<img src="https://git.zakscode.com/repo-avatars/d2c56ffd0220751c2f4a9f6fc1e8125a9a63aeed452ae4f4ab696c084330faa2" alt="Logo" width="200" height="200">
|
||||||
|
|
||||||
<!-- Title -->
|
<!-- Title -->
|
||||||
### AI Reviewer
|
### AI Agents
|
||||||
|
|
||||||
<!-- Description -->
|
<!-- Description -->
|
||||||
Automated AI-powered code review for pull requests 🤖
|
Automated AI-powered agents for automated reviews and code assistance
|
||||||
|
|
||||||
<!-- Repo badges -->
|
<!-- Repo badges -->
|
||||||
[](https://git.zakscode.com/ztimson/ai-reviewer/tags)
|
[](https://git.zakscode.com/ztimson/ai-agents/tags)
|
||||||
[](https://git.zakscode.com/ztimson/ai-reviewer/pulls)
|
[](https://git.zakscode.com/ztimson/ai-agents/pulls)
|
||||||
[](https://git.zakscode.com/ztimson/ai-reviewer/issues)
|
[](https://git.zakscode.com/ztimson/ai-agents/issues)
|
||||||
|
|
||||||
<!-- Links -->
|
<!-- Links -->
|
||||||
---
|
---
|
||||||
<div>
|
<div>
|
||||||
<a href="https://git.zakscode.com/ztimson/ai-reviewer/releases" target="_blank">Release Notes</a>
|
<a href="https://git.zakscode.com/ztimson/ai-agents/releases" target="_blank">Release Notes</a>
|
||||||
• <a href="https://git.zakscode.com/ztimson/ai-reviewer/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
|
• <a href="https://git.zakscode.com/ztimson/ai-agents/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
|
||||||
• <a href="https://git.zakscode.com/ztimson/ai-reviewer/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
|
• <a href="https://git.zakscode.com/ztimson/ai-agents/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
---
|
---
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
- [AI Reviewer](#top)
|
- [AI Agents](#top)
|
||||||
- [About](#about)
|
- [About](#about)
|
||||||
- [Built With](#built-with)
|
- [Built With](#built-with)
|
||||||
- [Setup](#setup)
|
- [Setup](#setup)
|
||||||
@@ -37,7 +37,7 @@ Automated AI-powered code review for pull requests 🤖
|
|||||||
|
|
||||||
## About
|
## About
|
||||||
|
|
||||||
Automated code reviewer that uses AI to analyze git diffs and provide inline comments on pull requests. Supports Anthropic, OpenAI, and Ollama models with tool-based reviewing for precise feedback.
|
Automated code agents that uses AI to analyze git diffs and provide inline comments on pull requests. Supports Anthropic, OpenAI, and Ollama models with tool-based reviewing for precise feedback.
|
||||||
|
|
||||||
### Built With
|
### Built With
|
||||||
[](https://docker.com/)
|
[](https://docker.com/)
|
||||||
@@ -54,40 +54,7 @@ Automated code reviewer that uses AI to analyze git diffs and provide inline com
|
|||||||
</summary>
|
</summary>
|
||||||
|
|
||||||
#### Instructions
|
#### Instructions
|
||||||
1. Add the following git action:
|
1. Run using npx: `npx @ztimson/ai-agents review`
|
||||||
```yaml
|
|
||||||
name: Code review
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
types: [opened, synchronize, reopened]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
review:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container: docker
|
|
||||||
steps:
|
|
||||||
- name: Fetch code
|
|
||||||
run: |
|
|
||||||
git clone "$(echo ${{github.server_url}}/${{github.repository}}.git | sed s%://%://${{github.token}}@% )" .
|
|
||||||
git checkout ${{ github.event.pull_request.head.sha }}
|
|
||||||
git fetch origin ${{ github.event.pull_request.base.ref }}
|
|
||||||
|
|
||||||
- name: Run AI Review
|
|
||||||
run: |
|
|
||||||
echo $GITHUB_WORKSPACE
|
|
||||||
docker pull "git.zakscode.com/ztimson/ai-reviewer:test"
|
|
||||||
docker run --rm -v $GITHUB_WORKSPACE:/app \
|
|
||||||
-e AI_HOST=anthropic \
|
|
||||||
-e AI_MODEL=claude-sonnet-4-5 \
|
|
||||||
-e AI_TOKEN="${{ secrets.ANTHROPIC_TOKEN }}" \
|
|
||||||
-e GIT_HOST="${{ github.server_url }}" \
|
|
||||||
-e GIT_OWNER="${{ github.repository_owner }}" \
|
|
||||||
-e GIT_REPO="${{ github.event.repository.name }}" \
|
|
||||||
-e GIT_TOKEN="${{ secrets.ASSISTANT_TOKEN }}" \
|
|
||||||
-e GIT_BRANCH="origin/${{ github.event.pull_request.base.ref }}" \
|
|
||||||
-e PULL_REQUEST="${{ github.event.pull_request.number }}" \
|
|
||||||
"git.zakscode.com/ztimson/ai-reviewer:test"
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
|||||||
22
package.json
22
package.json
@@ -1,17 +1,21 @@
|
|||||||
{
|
{
|
||||||
"name": "ai-reviewer",
|
"name": "@ztimson/ai-agents",
|
||||||
"version": "0.0.0",
|
"version": "0.0.3",
|
||||||
"scripts": {
|
"description": "AI agents",
|
||||||
"review": "node src/review.mjs"
|
"keywords": ["ai", "review"],
|
||||||
},
|
"author": "ztimson",
|
||||||
"keywords": [],
|
|
||||||
"author": "",
|
|
||||||
"license": "ISC",
|
"license": "ISC",
|
||||||
"description": "",
|
"type": "module",
|
||||||
|
"bin": {
|
||||||
|
"review": "./src/review.mjs"
|
||||||
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@ztimson/ai-utils": "^0.2.4",
|
"@ztimson/ai-utils": "^0.2.4",
|
||||||
"@ztimson/node-utils": "^1.0.7",
|
"@ztimson/node-utils": "^1.0.7",
|
||||||
"@ztimson/utils": "^0.28.3",
|
"@ztimson/utils": "^0.28.3",
|
||||||
"dotenv": "^17.2.3"
|
"dotenv": "^17.2.3"
|
||||||
}
|
},
|
||||||
|
"files": [
|
||||||
|
"src/"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
|
||||||
import {Ai} from '@ztimson/ai-utils';
|
import {Ai} from '@ztimson/ai-utils';
|
||||||
import {$} from '@ztimson/node-utils';
|
import {$} from '@ztimson/node-utils';
|
||||||
import * as os from 'node:os';
|
import * as os from 'node:os';
|
||||||
@@ -5,12 +7,14 @@ import * as path from 'node:path';
|
|||||||
import * as fs from 'node:fs';
|
import * as fs from 'node:fs';
|
||||||
import * as dotenv from 'dotenv';
|
import * as dotenv from 'dotenv';
|
||||||
|
|
||||||
dotenv.config({debug: false});
|
dotenv.config({quiet: true, debug: false});
|
||||||
dotenv.config({path: '.env.local', override: true, debug: false});
|
dotenv.config({path: '.env.local', override: true, quiet: true, debug: false});
|
||||||
|
|
||||||
(async () => {
|
(async () => {
|
||||||
const root = process.argv[2] || process.cwd(),
|
let p = process.argv[process.argv.length - 1];
|
||||||
branch = process.env['GIT_BRANCH'] || await $`cd ${root} && git symbolic-ref refs/remotes/origin/HEAD`,
|
if(p === 'review' || p.endsWith('review.mjs')) p = null;
|
||||||
|
|
||||||
|
const root = p || process.cwd(),
|
||||||
git = process.env['GIT_HOST'],
|
git = process.env['GIT_HOST'],
|
||||||
owner = process.env['GIT_OWNER'],
|
owner = process.env['GIT_OWNER'],
|
||||||
repo = process.env['GIT_REPO'],
|
repo = process.env['GIT_REPO'],
|
||||||
@@ -21,11 +25,11 @@ dotenv.config({path: '.env.local', override: true, debug: false});
|
|||||||
token = process.env['AI_TOKEN'];
|
token = process.env['AI_TOKEN'];
|
||||||
|
|
||||||
console.log(`Reviewing: ${root}\n`);
|
console.log(`Reviewing: ${root}\n`);
|
||||||
|
const branch = process.env['GIT_BRANCH'] || await $`cd ${root} && git symbolic-ref refs/remotes/origin/HEAD`;
|
||||||
const comments = [];
|
const comments = [];
|
||||||
const commit = await $`cd ${root} && git log -1 --pretty=format:%H`;
|
const commit = await $`cd ${root} && git log -1 --pretty=format:%H`;
|
||||||
const gitDiff = await $`cd ${root} && git diff ${branch}`;
|
const gitDiff = await $`cd ${root} && git diff ${branch}`;
|
||||||
|
|
||||||
|
|
||||||
let options = {ollama: {model, host}};
|
let options = {ollama: {model, host}};
|
||||||
if(host === 'anthropic') options = {anthropic: {model, token}};
|
if(host === 'anthropic') options = {anthropic: {model, token}};
|
||||||
else if(host === 'openai') options = {openAi: {model, token}};
|
else if(host === 'openai') options = {openAi: {model, token}};
|
||||||
@@ -33,7 +37,7 @@ dotenv.config({path: '.env.local', override: true, debug: false});
|
|||||||
...options,
|
...options,
|
||||||
model: [host, model],
|
model: [host, model],
|
||||||
path: process.env['path'] || os.tmpdir(),
|
path: process.env['path'] || os.tmpdir(),
|
||||||
system: `You are a code reviewer. Analyze the git diff and use the \`recommend\` tool for EACH issue you find. You must call \`recommend\` exactly once for every bug or improvement opportunity. After making all recommendations, provide a brief bullet point summary in markdown.`,
|
system: `You are a code reviewer. Analyze the git diff and use the \`recommend\` tool for EACH issue you find. You must call \`recommend\` exactly once for every bug or improvement opportunity directly related to changes. Ignore formatting recommendations. After making all recommendations, provide one brief bullet-point summary.`,
|
||||||
tools: [{
|
tools: [{
|
||||||
name: 'read_file',
|
name: 'read_file',
|
||||||
description: 'Read contents of a file',
|
description: 'Read contents of a file',
|
||||||
|
|||||||
Reference in New Issue
Block a user