Skip to content

Bump to 0.1.5 and fix readme formatting #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
justinxu421 merged 2 commits into from
Oct 9, 2025
Merged

Bump to 0.1.5 and fix readme formatting #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a38d6fa
fix readme formatting
justinxu421 Oct 9, 2025
a7ec966
bump to 0.1.5
justinxu421 Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,17 +73,17 @@ Each example includes a complete workflow file that you can copy to your `.githu

## Inputs

| Input | Description | Required | Example |
| ---------------------- | ------------------------------------------------------------------------------------------ | -------- | --------------------------------------------------- |
| `augment_session_auth` | Augment session authentication JSON containing accessToken and tenantURL (store as secret) | Yes | `${{ secrets.AUGMENT_SESSION_AUTH }}` |
| `github_token` | GitHub token with `repo` scopes | Yes | `${{ secrets.GITHUB_TOKEN }}` |
| `pull_number` | The number of the pull request being reviewed | Yes | `${{ github.event.pull_request.number }}` |
| `repo_name` | The full name (owner/repo) of the repository | Yes | `${{ github.repository }}` |
| `custom_guidelines` | Custom guidelines to include in PR reviews | No | See [Custom Guidelines](#custom-guidelines) section |
| `model` | Optional model name to use; passed directly to augment agent | No | e.g. `sonnet4`, from `auggie --list-models` |
| `rules` | JSON array of rule file paths forwarded to augment agent as repeated `--rules` flags | No | `'[".augment/rules.md"]'` |
| `mcp_configs` | JSON array of MCP config file paths forwarded as repeated `--mcp-config` flags | No | `'[".augment/mcp.json"]'` |
| `fetch_depth` | Number of commits to fetch. Use `0` for full history (default), `1` for shallow clone, or any positive integer for specific depth | No | `1` (shallow), `50` (last 50 commits), `0` (full) |
| Input | Description | Required | Example |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------- |
| `augment_session_auth` | Augment session authentication JSON containing accessToken and tenantURL (store as secret) | Yes | `${{ secrets.AUGMENT_SESSION_AUTH }}` |
| `github_token` | GitHub token with `repo` scopes | Yes | `${{ secrets.GITHUB_TOKEN }}` |
| `pull_number` | The number of the pull request being reviewed | Yes | `${{ github.event.pull_request.number }}` |
| `repo_name` | The full name (owner/repo) of the repository | Yes | `${{ github.repository }}` |
| `custom_guidelines` | Custom guidelines to include in PR reviews | No | See [Custom Guidelines](#custom-guidelines) section |
| `model` | Optional model name to use; passed directly to augment agent | No | e.g. `sonnet4`, from `auggie --list-models` |
| `rules` | JSON array of rule file paths forwarded to augment agent as repeated `--rules` flags | No | `'[".augment/rules.md"]'` |
| `mcp_configs` | JSON array of MCP config file paths forwarded as repeated `--mcp-config` flags | No | `'[".augment/mcp.json"]'` |
| `fetch_depth` | Number of commits to fetch. Use `0` for full history (default), `1` for shallow clone, or any positive integer for specific depth | No | `1` (shallow), `50` (last 50 commits), `0` (full) |

## How It Works

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "augment-review-pr",
"version": "0.1.4",
"version": "0.1.5",
"description": "AI-powered code assistance for reviewing pull requests using Augment's intelligent development tools",
"main": "action.yml",
"type": "module",
Expand Down