Add optional fetch_depth parameter for performance optimization

- Add fetch_depth input parameter to action.yml with default value of '0'
- Document fetch_depth in README.md inputs table
- Add Performance Optimization section to README.md explaining shallow clone benefits
- Update all example workflows with helpful fetch-depth comments
- Enables users to use shallow clones (fetch-depth: 1) for faster checkouts in large repos
- Maintains backward compatibility with default full history behavior

Author: justinxu421

README.md

@@ -64,6 +64,23 @@ Each example includes a complete workflow file that you can copy to your `.githu
 
 ## Advanced
 
+### Performance Optimization
+
+For large repositories with extensive history, you can significantly speed up the checkout process by using a shallow clone:
+
+```yaml
+- uses: actions/checkout@v4
+  with:
+    fetch-depth: 1  # Shallow clone for faster checkout
+```
+
+The `fetch-depth` parameter controls how much history is fetched:
+- `fetch-depth: 1` - Only the latest commit (fastest for most use cases)
+- `fetch-depth: 50` - Last 50 commits (balance between speed and history)
+- `fetch-depth: 0` - Full history (slowest but complete, default behavior)
+
+For most PR reviews and code analysis, a shallow clone (`fetch-depth: 1`) provides sufficient context while significantly reducing checkout time.
+
 ### Inputs
 
 | Input                  | Description                                                                             | Required | Example                                     |
@@ -82,6 +99,7 @@ Each example includes a complete workflow file that you can copy to your `.githu
 | `model`                | Model to use; passed through to auggie as --model                                       | No       | e.g. `sonnet4`, from `auggie --list-models` |
 | `rules`                | JSON array of rules file paths (each forwarded as individual `--rules` flags)           | No       | `'[".github/augment/rules.md"]'`            |
 | `mcp_configs`          | JSON array of MCP config file paths (each forwarded as individual `--mcp-config` flags) | No       | `'[".augment/mcp/config.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) |
 
 \*Either `instruction`, `instruction_file`, or `template_directory` must be provided.
 

action.yml

@@ -49,6 +49,10 @@ inputs:
   mcp_configs:
     description: "JSON array of MCP config file paths. Each entry is forwarded to auggie as an individual --mcp-config flag."
     required: false
+  fetch_depth:
+    description: "Number of commits to fetch. Use '0' for full history (default), '1' for shallow clone (latest commit only), or any positive integer for a specific depth."
+    required: false
+    default: "0"
 
 runs:
   using: "composite"

example-workflows/code-review.yml

@@ -9,7 +9,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          fetch-depth: 0  # Use fetch-depth: 1 for shallow clone (faster), or fetch-depth: 0 for full history
       - name: Create instruction file
         env:
           PR_NUMBER: ${{ github.event.pull_request.number }}

example-workflows/pr-description.yml

@@ -9,7 +9,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          fetch-depth: 0  # Use fetch-depth: 1 for shallow clone (faster), or fetch-depth: 0 for full history
       - name: Create instruction file
         env:
           PR_NUMBER: ${{ github.event.pull_request.number }}

example-workflows/template-pr-review.yml

@@ -9,7 +9,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          fetch-depth: 0  # Use fetch-depth: 1 for shallow clone (faster), or fetch-depth: 0 for full history
 
       - name: Create template directory
         run: |

example-workflows/triage-issue.yml

@@ -9,7 +9,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          fetch-depth: 0  # Use fetch-depth: 1 for shallow clone (faster), or fetch-depth: 0 for full history
       - name: Create instruction file
         env:
           ISSUE_NUMBER: ${{ github.event.issue.number }}