You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -83,6 +83,7 @@ Each example includes a complete workflow file that you can copy to your `.githu
83
83
|`model`| Optional model to use for generation | No | e.g. `sonnet4`, from `auggie --list-models`|
84
84
|`rules`| JSON array of rules file paths forwarded to agent | No |`[".augment/rules.md"]`|
85
85
|`mcp_configs`| JSON array of MCP config paths forwarded to agent | No |`[".augment/mcp.md"]`|
86
+
|`fetch_depth`| Optional fetch depth for git checkout (default: 0) | No |`10` for shallow clones, `0` for full history |
86
87
87
88
## How It Works
88
89
@@ -92,6 +93,20 @@ Each example includes a complete workflow file that you can copy to your `.githu
92
93
4.**AI Processing**: Calls the Augment Agent to analyze the changes and generate a description
93
94
5.**PR Update**: The Augment Agent updates the PR description with the generated content
94
95
96
+
## Performance Optimization
97
+
98
+
For large repositories with long history, you can use the `fetch_depth` parameter to speed up checkouts by limiting the git history fetched:
99
+
100
+
```yaml
101
+
- name: Generate PR Description
102
+
uses: augmentcode/describe-pr@v0
103
+
with:
104
+
# ... other inputs ...
105
+
fetch_depth: 50# Only fetch last 50 commits
106
+
```
107
+
108
+
This can significantly reduce checkout time for repositories with extensive history while still providing enough context for PR description generation.
109
+
95
110
## Custom Guidelines
96
111
97
112
You can add project-specific guidelines to any workflow by including the `custom_guidelines` input:
0 commit comments