https://github.com/augmentcode/augment-action
https://github.com/augmentcode/augment-action
Last synced: 14 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/augmentcode/augment-action
- Owner: augmentcode
- License: mit
- Created: 2025-12-08T23:27:19.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-12-16T23:14:48.000Z (about 1 month ago)
- Last Synced: 2025-12-20T13:07:39.408Z (about 1 month ago)
- Language: TypeScript
- Size: 88.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Augment Action
A GitHub Action that runs the Auggie AI agent to respond to issue and PR comments.
## Usage
```yaml
name: Auggie Bot
on:
issue_comment:
types: [created]
pull_request_review_comment:
types: [created]
jobs:
auggie:
runs-on: ubuntu-latest
if: contains(github.event.comment.body, '@auggie')
steps:
- uses: actions/checkout@v4
- uses: augmentcode/augment-action@main
with:
prompt: ${{ github.event.comment.body }}
augment_api_key: ${{ secrets.AUGMENT_API_KEY }}
```
## Inputs
| Input | Description | Required |
|-------|-------------|----------|
| `prompt` | The prompt to send to the Auggie agent | Yes |
| `augment_api_key` | Augment API key for authentication | No |
| `augment_api_url` | Augment API URL (default: `https://api.augmentcode.com`) | No |
| `workspace_root` | Workspace root path for Auggie to index | No |
## What It Does
The Auggie agent will:
1. React to your comment with 👀 to acknowledge the request
2. Post a comment with its response
3. Update the comment in real-time as it works through the task
## Use Cases
### 1. Respond to Comments
Trigger Auggie when someone mentions `@auggie` in a comment:
```yaml
on:
issue_comment:
types: [created]
pull_request_review_comment:
types: [created]
jobs:
auggie:
runs-on: ubuntu-latest
if: contains(github.event.comment.body, '@auggie')
steps:
- uses: actions/checkout@v4
- uses: augmentcode/augment-action@main
with:
prompt: ${{ github.event.comment.body }}
augment_api_key: ${{ secrets.AUGMENT_API_KEY }}
```
### 2. Auto Code Review on PRs
Automatically review every new pull request:
```yaml
on:
pull_request:
types: [opened, synchronize]
jobs:
auggie:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: augmentcode/augment-action@main
with:
prompt: "Review this PR for bugs, security issues, and code quality"
augment_api_key: ${{ secrets.AUGMENT_API_KEY }}
```
### 3. Triage New Issues
Automatically analyze and label new issues:
```yaml
on:
issues:
types: [opened]
jobs:
auggie:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: augmentcode/augment-action@main
with:
prompt: "Analyze this issue, suggest relevant labels, and provide initial guidance"
augment_api_key: ${{ secrets.AUGMENT_API_KEY }}
```