Skip to content
Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Augment Action

A GitHub Action that runs the Auggie AI agent to respond to issue and PR comments.

Usage

name: Auggie Boton:
issue_comment:
types: [created]pull_request_review_comment:
types: [created]jobs:
auggie:
runs-on: ubuntu-latestif: contains(github.event.comment.body, '@auggie')steps:
- uses: actions/checkout@v4
- uses: augmentcode/augment-action@mainwith:
prompt: ${{ github.event.comment.body }}augment_api_key: ${{ secrets.AUGMENT_API_KEY }}

Inputs

InputDescriptionRequired
promptThe prompt to send to the Auggie agentYes
augment_api_keyAugment API key for authenticationNo
augment_api_urlAugment API URL (default: https://api.augmentcode.com)No
workspace_rootWorkspace root path for Auggie to indexNo

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:

on:
issue_comment:
types: [created]pull_request_review_comment:
types: [created]jobs:
auggie:
runs-on: ubuntu-latestif: contains(github.event.comment.body, '@auggie')steps:
- uses: actions/checkout@v4
- uses: augmentcode/augment-action@mainwith:
prompt: ${{ github.event.comment.body }}augment_api_key: ${{ secrets.AUGMENT_API_KEY }}

2. Auto Code Review on PRs

Automatically review every new pull request:

on:
pull_request:
types: [opened, synchronize]jobs:
auggie:
runs-on: ubuntu-lateststeps:
- uses: actions/checkout@v4
- uses: augmentcode/augment-action@mainwith:
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:

on:
issues:
types: [opened]jobs:
auggie:
runs-on: ubuntu-lateststeps:
- uses: actions/checkout@v4
- uses: augmentcode/augment-action@mainwith:
prompt: "Analyze this issue, suggest relevant labels, and provide initial guidance"augment_api_key: ${{ secrets.AUGMENT_API_KEY }}

About

No description, website, or topics provided.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages