From 53663ea34281d624e21ab5eeba3b9d2ef66fd73a Mon Sep 17 00:00:00 2001 From: Maya Raskin Date: Thu, 25 Sep 2025 10:57:01 +0300 Subject: [PATCH] Add warnings about GitHub API limitations for PR changed files and batch size calculations in documentation --- .../all/working_agreements_and_measuring_pr_standards.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/guides/all/working_agreements_and_measuring_pr_standards.md b/docs/guides/all/working_agreements_and_measuring_pr_standards.md index f587e4ede7..6302b5380d 100644 --- a/docs/guides/all/working_agreements_and_measuring_pr_standards.md +++ b/docs/guides/all/working_agreements_and_measuring_pr_standards.md @@ -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. +::: +

Scorecard Definition

This agreement has multiple levels based on the number of files changed. @@ -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. +::: +

Scorecard Definition

This agreement has levels based on the batch size.