Skip to content
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.

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

docs: refine history-limit docs, add warning #50

Merged
merged 1 commit into from
Dec 18, 2024
Merged
Changes from all commits
Commits
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
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,21 +162,22 @@ A pull request is considered to be **not** a part of a stack if:
### History Limit

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

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

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

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

## Reference

Expand Down
Loading