diff --git a/README.md b/README.md index 019624f..abb4387 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/action.yml b/action.yml index 5899402..70246b7 100644 --- a/action.yml +++ b/action.yml @@ -39,7 +39,7 @@ runs: using: "composite" steps: - name: Checkout PR Head - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0 + uses: actions/checkout@d26b0d41bf4021c914eabfa7ba4dc03269578989 # v4.0.0 with: token: ${{ inputs.github_token }} ref: refs/pull/${{ inputs.pull_number }}/head @@ -60,7 +60,8 @@ runs: CUSTOM_GUIDELINES: ${{ inputs.custom_guidelines }} - name: Run Augment Agent - uses: augmentcode/augment-agent@v0 + # Testing PR #9 commit SHA to verify directory structure compatibility + uses: augmentcode/augment-agent@acf657cb99e573ee2ca730b4779e09045e4c8ce5 with: augment_session_auth: ${{ inputs.augment_session_auth }} github_token: ${{ inputs.github_token }}