release-please 14.1.0 → 14.1.1

package/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [14.1.1](https://github.com/googleapis/release-please/compare/v14.1.0...v14.1.1) (2022-08-23)
+
+
+### Bug Fixes
+
+* add REST API call to fetch pull requests without files ([#1591](https://github.com/googleapis/release-please/issues/1591)) ([b875a1f](https://github.com/googleapis/release-please/commit/b875a1f437889a46f8cb6e86648073b51401ab9e))
+
 ## [14.1.0](https://github.com/googleapis/release-please/compare/v14.0.0...v14.1.0) (2022-08-19)
 
 

package/build/src/github.d.ts

@@ -138,12 +138,34 @@ export declare class GitHub {
     /**
      * Iterate through merged pull requests with a max number of results scanned.
      *
-     * @param {number} maxResults maxResults - Limit the number of results searched.
-     *   Defaults to unlimited.
+     * @param {string} targetBranch The base branch of the pull request
+     * @param {string} status The status of the pull request
+     * @param {number} maxResults Limit the number of results searched. Defaults to
+     *   unlimited.
+     * @param {boolean} includeFiles Whether to fetch the list of files included in
+     *   the pull request. Defaults to `true`.
      * @yields {PullRequest}
      * @throws {GitHubAPIError} on an API error
      */
-    pullRequestIterator(targetBranch: string, status?: 'OPEN' | 'CLOSED' | 'MERGED', maxResults?: number): AsyncGenerator<PullRequest, void, unknown>;
+    pullRequestIterator(targetBranch: string, status?: 'OPEN' | 'CLOSED' | 'MERGED', maxResults?: number, includeFiles?: boolean): AsyncGenerator<PullRequest, void, void>;
+    /**
+     * Helper implementation of pullRequestIterator that includes files via
+     * the graphQL API.
+     *
+     * @param {string} targetBranch The base branch of the pull request
+     * @param {string} status The status of the pull request
+     * @param {number} maxResults Limit the number of results searched
+     */
+    private pullRequestIteratorWithFiles;
+    /**
+     * Helper implementation of pullRequestIterator that excludes files
+     * via the REST API.
+     *
+     * @param {string} targetBranch The base branch of the pull request
+     * @param {string} status The status of the pull request
+     * @param {number} maxResults Limit the number of results searched
+     */
+    private pullRequestIteratorWithoutFiles;
     /**
      * Return a list of merged pull requests. The list is not guaranteed to be sorted
      * by merged_at, but is generally most recent first.

package/build/src/github.js

@@ -568,12 +568,32 @@ class GitHub {
     /**
      * Iterate through merged pull requests with a max number of results scanned.
      *
-     * @param {number} maxResults maxResults - Limit the number of results searched.
-     *   Defaults to unlimited.
+     * @param {string} targetBranch The base branch of the pull request
+     * @param {string} status The status of the pull request
+     * @param {number} maxResults Limit the number of results searched. Defaults to
+     *   unlimited.
+     * @param {boolean} includeFiles Whether to fetch the list of files included in
+     *   the pull request. Defaults to `true`.
      * @yields {PullRequest}
      * @throws {GitHubAPIError} on an API error
      */
-    async *pullRequestIterator(targetBranch, status = 'MERGED', maxResults = Number.MAX_SAFE_INTEGER) {
+    async *pullRequestIterator(targetBranch, status = 'MERGED', maxResults = Number.MAX_SAFE_INTEGER, includeFiles = true) {
+        const generator = includeFiles
+            ? this.pullRequestIteratorWithFiles(targetBranch, status, maxResults)
+            : this.pullRequestIteratorWithoutFiles(targetBranch, status, maxResults);
+        for await (const pullRequest of generator) {
+            yield pullRequest;
+        }
+    }
+    /**
+     * Helper implementation of pullRequestIterator that includes files via
+     * the graphQL API.
+     *
+     * @param {string} targetBranch The base branch of the pull request
+     * @param {string} status The status of the pull request
+     * @param {number} maxResults Limit the number of results searched
+     */
+    async *pullRequestIteratorWithFiles(targetBranch, status = 'MERGED', maxResults = Number.MAX_SAFE_INTEGER) {
         let cursor = undefined;
         let results = 0;
         while (results < maxResults) {
@@ -592,6 +612,52 @@ class GitHub {
             cursor = response.pageInfo.endCursor;
         }
     }
+    /**
+     * Helper implementation of pullRequestIterator that excludes files
+     * via the REST API.
+     *
+     * @param {string} targetBranch The base branch of the pull request
+     * @param {string} status The status of the pull request
+     * @param {number} maxResults Limit the number of results searched
+     */
+    async *pullRequestIteratorWithoutFiles(targetBranch, status = 'MERGED', maxResults = Number.MAX_SAFE_INTEGER) {
+        const statusMap = {
+            OPEN: 'open',
+            CLOSED: 'closed',
+            MERGED: 'closed',
+        };
+        let results = 0;
+        for await (const { data: pulls } of this.octokit.paginate.iterator(this.octokit.rest.pulls.list, {
+            state: statusMap[status],
+            owner: this.repository.owner,
+            repo: this.repository.repo,
+            base: targetBranch,
+        })) {
+            for (const pull of pulls) {
+                // The REST API does not have an option for "merged"
+                // pull requests - they are closed with a `merge_commit_sha`
+                if (status !== 'MERGED' || pull.merge_commit_sha) {
+                    results += 1;
+                    yield {
+                        headBranchName: pull.head.ref,
+                        baseBranchName: pull.base.ref,
+                        number: pull.number,
+                        title: pull.title,
+                        body: pull.body || '',
+                        labels: pull.labels.map(label => label.name),
+                        files: [],
+                        sha: pull.merge_commit_sha || undefined,
+                    };
+                    if (results >= maxResults) {
+                        break;
+                    }
+                }
+            }
+            if (results >= maxResults) {
+                break;
+            }
+        }
+    }
     /**
      * Return a list of merged pull requests. The list is not guaranteed to be sorted
      * by merged_at, but is generally most recent first.

package/build/src/manifest.js

@@ -444,7 +444,7 @@ class Manifest {
     async findOpenReleasePullRequests() {
         logger_1.logger.info('Looking for open release pull requests');
         const openPullRequests = [];
-        const generator = this.github.pullRequestIterator(this.targetBranch, 'OPEN');
+        const generator = this.github.pullRequestIterator(this.targetBranch, 'OPEN', Number.MAX_SAFE_INTEGER, false);
         for await (const openPullRequest of generator) {
             if ((hasAllLabels(this.labels, openPullRequest.labels) ||
                 hasAllLabels(this.snapshotLabels, openPullRequest.labels)) &&
@@ -459,7 +459,7 @@ class Manifest {
     async findSnoozedReleasePullRequests() {
         logger_1.logger.info('Looking for snoozed release pull requests');
         const snoozedPullRequests = [];
-        const closedGenerator = this.github.pullRequestIterator(this.targetBranch, 'CLOSED');
+        const closedGenerator = this.github.pullRequestIterator(this.targetBranch, 'CLOSED', 200, false);
         for await (const closedPullRequest of closedGenerator) {
             if (hasAllLabels([exports.SNOOZE_LABEL], closedPullRequest.labels) &&
                 branch_name_1.BranchName.parse(closedPullRequest.headBranchName) &&
@@ -518,7 +518,7 @@ class Manifest {
     }
     async *findMergedReleasePullRequests() {
         // Find merged release pull requests
-        const pullRequestGenerator = this.github.pullRequestIterator(this.targetBranch, 'MERGED', 200);
+        const pullRequestGenerator = this.github.pullRequestIterator(this.targetBranch, 'MERGED', 200, false);
         for await (const pullRequest of pullRequestGenerator) {
             if (!hasAllLabels(this.labels, pullRequest.labels)) {
                 continue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "14.1.0",
+  "version": "14.1.1",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",