Skip to content

Add warnings about GitHub API limitations for PRs #2837

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add warnings about GitHub API limitations for PRs #2837

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions docs/guides/all/working_agreements_and_measuring_pr_standards.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,10 @@ Map the milestone information from your data source to the `milestone` property.

### PR Changed X Files or Less

:::warning GitHub API Limitation
This feature is only available with live-events and not during ingestion due to GitHub API limitations. The `changed_files` property is not available through the GitHub REST API for historical pull requests.
:::

<h4> Scorecard Definition </h4>

This agreement has multiple levels based on the number of files changed.
Expand Down Expand Up @@ -569,6 +573,10 @@ Ensure that `createdAt` and `mergedAt` properties are correctly mapped from your

### PR Batch Size Calculation

:::warning GitHub API Limitation
This feature is only available with live-events and not during ingestion due to GitHub API limitations. The `additions`, `deletions`, `commits`, and `changed_files` properties required for batch size calculation are not available through the GitHub REST API for historical pull requests.
:::

<h4> Scorecard Definition </h4>

This agreement has levels based on the batch size.
Expand Down