Skip to content

Commit 746f7a5

Browse files
authored
docs: refine history-limit docs, add warning (#50)
1 parent 379e52b commit 746f7a5

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -162,21 +162,22 @@ A pull request is considered to be **not** a part of a stack if:
162162
### History Limit
163163

164164
In order to accurately visualize stacked changes, the action needs to fetch _all_ open
165-
and closed pull requests. This can problematic for larger/older repositories that have
166-
a large number of closed pull requests.
165+
and closed pull requests. However, this can increase the runtime of the action for
166+
larger/older repositories.
167167

168-
The action can be configured to fetch a limited number of closed pull requests. This is
169-
customizable with the `history-limit` input:
168+
If you're experiencing long runtimes, the `history-limit` input can be configured to
169+
limit the total number of closed pull requests fetched by the action:
170170

171171
```yaml
172172
- uses: git-town/action@v1
173173
with:
174174
history-limit: '500' # Only fetch the latest 500 closed pull requests
175175
```
176176

177-
> [!NOTE]
178-
> This only applies to closed pull requests. Open pull requests will be completely fetched
179-
> regardless of the `history-limit`.
177+
> [!WARNING]
178+
> You may encounter inaccuracies in the visualization when customizing `history-limit` as
179+
> open pull requests may refer to closed pull requests not fetched within the configured
180+
> limits.
180181

181182
## Reference
182183

0 commit comments

Comments
 (0)