feat: add ability to configure how many commits we retrieve when iterating through repo history (#2679)

* feat: add ability to configure how many commits we retrieve when iterating throgh history

* added commit-batch-size to config.json

Author: ldetmer

docs/manifest-releaser.md

@@ -268,6 +268,12 @@ defaults (those are documented in comments)
   // value, but it will increase the number of API calls used.
   "commit-search-depth": 500,
 
+  // Number of commits to fetch per API request when searching commit history.
+  // This controls the batch size for GraphQL pagination. Lower values result in
+  // more API calls but may help avoid timeouts. Higher values reduce API calls
+  // but each request takes longer. Defaults to 10.
+  "commit-batch-size": 10,
+
   // when creating multiple pull requests or releases, issue GitHub API requests
   // sequentially rather than concurrently, waiting for the previous request to
   // complete before issuing the next one.

schemas/config.json

@@ -431,6 +431,10 @@
           "description": "When considering commit history, only look this many commits deep.",
           "type": "number"
         },
+        "commit-batch-size": {
+          "description": "Number of commits to fetch per API request when searching commit history. Lower values result in more API calls but may help avoid timeouts. Defaults to 10.",
+          "type": "number"
+        },
         "sequential-calls": {
           "description": "Whether to open pull requests/releases sequentially rather than concurrently. If you have many components, you may want to set this to avoid secondary rate limits.",
           "type": "boolean"
@@ -462,6 +466,7 @@
     "group-pull-request-title-pattern": true,
     "release-search-depth": true,
     "commit-search-depth": true,
+    "commit-batch-size": true,
     "sequential-calls": true,
     "release-type": true,
     "bump-minor-pre-major": true,

src/github.ts

@@ -160,6 +160,7 @@ interface ReleaseHistory {
 interface CommitIteratorOptions {
   maxResults?: number;
   backfillFiles?: boolean;
+  batchSize?: number;
 }
 
 interface ReleaseIteratorOptions {
@@ -449,7 +450,7 @@ export class GitHub {
       cursor,
       owner: this.repository.owner,
       repo: this.repository.repo,
-      num: 10,
+      num: options.batchSize ?? 10,
       targetBranch,
       maxFilesChanged: 100, // max is 100
     };

src/manifest.ts

@@ -215,6 +215,7 @@ export interface ManifestOptions {
   groupPullRequestTitlePattern?: string;
   releaseSearchDepth?: number;
   commitSearchDepth?: number;
+  commitBatchSize?: number;
   logger?: Logger;
   dateFormat?: string;
 }
@@ -270,6 +271,7 @@ export interface ManifestConfig extends ReleaserConfigJson {
   'group-pull-request-title-pattern'?: string;
   'release-search-depth'?: number;
   'commit-search-depth'?: number;
+  'commit-batch-size'?: number;
   'sequential-calls'?: boolean;
   'always-update'?: boolean;
 }
@@ -288,6 +290,7 @@ export const DEFAULT_SNAPSHOT_LABELS = ['autorelease: snapshot'];
 export const SNOOZE_LABEL = 'autorelease: snooze';
 const DEFAULT_RELEASE_SEARCH_DEPTH = 400;
 const DEFAULT_COMMIT_SEARCH_DEPTH = 500;
+const DEFAULT_COMMIT_BATCH_SIZE = 10;
 
 export const MANIFEST_PULL_REQUEST_TITLE_PATTERN = 'chore: release ${branch}';
 
@@ -328,6 +331,7 @@ export class Manifest {
   private groupPullRequestTitlePattern?: string;
   readonly releaseSearchDepth: number;
   readonly commitSearchDepth: number;
+  readonly commitBatchSize: number;
   readonly logger: Logger;
   private pullRequestOverflowHandler: PullRequestOverflowHandler;
 
@@ -397,6 +401,8 @@ export class Manifest {
       manifestOptions?.releaseSearchDepth || DEFAULT_RELEASE_SEARCH_DEPTH;
     this.commitSearchDepth =
       manifestOptions?.commitSearchDepth || DEFAULT_COMMIT_SEARCH_DEPTH;
+    this.commitBatchSize =
+      manifestOptions?.commitBatchSize || DEFAULT_COMMIT_BATCH_SIZE;
     this.logger = manifestOptions?.logger ?? defaultLogger;
     this.plugins = (manifestOptions?.plugins || []).map(pluginType =>
       buildPlugin({
@@ -626,6 +632,7 @@ export class Manifest {
     const commitGenerator = this.github.mergeCommitIterator(this.targetBranch, {
       maxResults: this.commitSearchDepth,
       backfillFiles: true,
+      batchSize: this.commitBatchSize,
     });
     const releaseShas = new Set(Object.values(releaseShasByPath));
     this.logger.debug(releaseShas);
@@ -1468,6 +1475,7 @@ async function parseConfig(
     extraLabels: configExtraLabel?.split(','),
     releaseSearchDepth: config['release-search-depth'],
     commitSearchDepth: config['commit-search-depth'],
+    commitBatchSize: config['commit-batch-size'],
     sequentialCalls: config['sequential-calls'],
   };
   return {config: repositoryConfig, options: manifestOptions};