release-please 14.1.0 → 14.2.0

package/CHANGELOG.md

@@ -4,6 +4,27 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [14.2.0](https://github.com/googleapis/release-please/compare/v14.1.2...v14.2.0) (2022-08-25)
+
+
+### Features
+
+* maintain an instance logger ([#1599](https://github.com/googleapis/release-please/issues/1599)) ([adb8053](https://github.com/googleapis/release-please/commit/adb805357d6344f1737bb3541ec7354e76f45cdc))
+
+## [14.1.2](https://github.com/googleapis/release-please/compare/v14.1.1...v14.1.2) (2022-08-25)
+
+
+### Bug Fixes
+
+* **deps:** update code-suggester to 4.1.0 ([#1600](https://github.com/googleapis/release-please/issues/1600)) ([e123a39](https://github.com/googleapis/release-please/commit/e123a392798e30ce75808f3b74e9b9836832725f))
+
+## [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/commit.d.ts

@@ -1,4 +1,5 @@
 import { PullRequest } from './pull-request';
+import { Logger } from './util/logger';
 import * as parser from '@conventional-commits/parser';
 export interface Commit {
     sha: string;
@@ -23,4 +24,4 @@ export interface ConventionalCommit extends Commit {
  *   more commits returned as a single raw commit may contain multiple release
  *   messages.
  */
-export declare function parseConventionalCommits(commits: Commit[]): ConventionalCommit[];
+export declare function parseConventionalCommits(commits: Commit[], logger?: Logger): ConventionalCommit[];

package/build/src/commit.js

@@ -292,7 +292,7 @@ function parseCommits(message) {
  *   more commits returned as a single raw commit may contain multiple release
  *   messages.
  */
-function parseConventionalCommits(commits) {
+function parseConventionalCommits(commits, logger = logger_1.logger) {
     const conventionalCommits = [];
     for (const commit of commits) {
         const commitMessage = preprocessCommitMessage(commit);
@@ -315,7 +315,7 @@ function parseConventionalCommits(commits) {
             }
         }
         catch (_err) {
-            logger_1.logger.debug(`commit could not be parsed: ${commit.sha} ${commit.message.split('\n')[0]}`);
+            logger.debug(`commit could not be parsed: ${commit.sha} ${commit.message.split('\n')[0]}`);
         }
     }
     return conventionalCommits;

package/build/src/github.d.ts

@@ -10,6 +10,7 @@ import { ReleasePullRequest } from './release-pull-request';
 import { Update } from './update';
 import { Release } from './release';
 import { GitHubFileContents } from '@google-automations/git-file-utils';
+import { Logger } from 'code-suggester/build/src/types';
 declare type RequestBuilderType = typeof request;
 declare type DefaultFunctionType = RequestBuilderType['defaults'];
 declare type RequestFunctionType = ReturnType<DefaultFunctionType>;
@@ -21,6 +22,7 @@ export interface OctokitAPIs {
 export interface GitHubOptions {
     repository: Repository;
     octokitAPIs: OctokitAPIs;
+    logger?: Logger;
 }
 interface GitHubCreateOptions {
     owner: string;
@@ -71,6 +73,7 @@ export declare class GitHub {
     private request;
     private graphql;
     private fileCache;
+    private logger;
     private constructor();
     /**
      * Build a new GitHub client with auto-detected default branch.
@@ -138,12 +141,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

@@ -30,6 +30,7 @@ const signoff_commit_message_1 = require("./util/signoff-commit-message");
 const git_file_utils_1 = require("@google-automations/git-file-utils");
 class GitHub {
     constructor(options) {
+        var _a;
         /**
          * Get the list of file paths modified in a given commit.
          *
@@ -38,7 +39,7 @@ class GitHub {
          * @throws {GitHubAPIError} on an API error
          */
         this.getCommitFiles = wrapAsync(async (sha) => {
-            logger_1.logger.debug(`Backfilling file list for commit: ${sha}`);
+            this.logger.debug(`Backfilling file list for commit: ${sha}`);
             const files = [];
             for await (const resp of this.octokit.paginate.iterator(this.octokit.repos.getCommit, {
                 owner: this.repository.owner,
@@ -52,10 +53,10 @@ class GitHub {
                 }
             }
             if (files.length >= 3000) {
-                logger_1.logger.warn(`Found ${files.length} files. This may not include all the files.`);
+                this.logger.warn(`Found ${files.length} files. This may not include all the files.`);
             }
             else {
-                logger_1.logger.debug(`Found ${files.length} files`);
+                this.logger.debug(`Found ${files.length} files`);
             }
             return files;
         });
@@ -69,26 +70,26 @@ class GitHub {
                     if (response) {
                         return response;
                     }
-                    logger_1.logger.trace('no GraphQL response, retrying');
+                    this.logger.trace('no GraphQL response, retrying');
                 }
                 catch (err) {
                     if (err.status !== 502) {
                         throw err;
                     }
                     if (maxRetries === 0) {
-                        logger_1.logger.warn('ran out of retries and response is required');
+                        this.logger.warn('ran out of retries and response is required');
                         throw err;
                     }
-                    logger_1.logger.info(`received 502 error, ${maxRetries} attempts remaining`);
+                    this.logger.info(`received 502 error, ${maxRetries} attempts remaining`);
                 }
                 maxRetries -= 1;
                 if (maxRetries >= 0) {
-                    logger_1.logger.trace(`sleeping ${seconds} seconds`);
+                    this.logger.trace(`sleeping ${seconds} seconds`);
                     await (0, exports.sleepInMs)(1000 * seconds);
                     seconds = Math.min(seconds * 2, MAX_SLEEP_SECONDS);
                 }
             }
-            logger_1.logger.trace('ran out of retries');
+            this.logger.trace('ran out of retries');
             return undefined;
         });
         /**
@@ -106,7 +107,7 @@ class GitHub {
             if (prefix) {
                 prefix = normalizePrefix(prefix);
             }
-            logger_1.logger.debug(`finding files by filename: ${filename}, ref: ${ref}, prefix: ${prefix}`);
+            this.logger.debug(`finding files by filename: ${filename}, ref: ${ref}, prefix: ${prefix}`);
             return await this.fileCache.findFilesByFilename(filename, ref, prefix);
         });
         this.createPullRequest = wrapAsync(async (pullRequest, targetBranch, message, updates, options) => {
@@ -122,7 +123,7 @@ class GitHub {
                 force: true,
                 fork: !!(options === null || options === void 0 ? void 0 : options.fork),
                 message,
-                logger: logger_1.logger,
+                logger: this.logger,
                 draft: !!(options === null || options === void 0 ? void 0 : options.draft),
                 labels: pullRequest.labels,
             });
@@ -178,11 +179,11 @@ class GitHub {
                 force: true,
                 fork: (options === null || options === void 0 ? void 0 : options.fork) === false ? false : true,
                 message,
-                logger: logger_1.logger,
+                logger: this.logger,
                 draft: releasePullRequest.draft,
             });
             if (prNumber !== number) {
-                logger_1.logger.warn(`updated code for ${prNumber}, but update requested for ${number}`);
+                this.logger.warn(`updated code for ${prNumber}, but update requested for ${number}`);
             }
             const response = await this.octokit.pulls.update({
                 owner: this.repository.owner,
@@ -273,7 +274,7 @@ class GitHub {
          * @throws {GitHubAPIError} on an API error
          */
         this.commentOnIssue = wrapAsync(async (comment, number) => {
-            logger_1.logger.debug(`adding comment to https://github.com/${this.repository.owner}/${this.repository.repo}/issue/${number}`);
+            this.logger.debug(`adding comment to https://github.com/${this.repository.owner}/${this.repository.repo}/issue/${number}`);
             const resp = await this.octokit.issues.createComment({
                 owner: this.repository.owner,
                 repo: this.repository.repo,
@@ -292,7 +293,7 @@ class GitHub {
             if (labels.length === 0) {
                 return;
             }
-            logger_1.logger.debug(`removing labels: ${labels} from issue/pull ${number}`);
+            this.logger.debug(`removing labels: ${labels} from issue/pull ${number}`);
             await Promise.all(labels.map(label => this.octokit.issues.removeLabel({
                 owner: this.repository.owner,
                 repo: this.repository.repo,
@@ -310,7 +311,7 @@ class GitHub {
             if (labels.length === 0) {
                 return;
             }
-            logger_1.logger.debug(`adding labels: ${labels} from issue/pull ${number}`);
+            this.logger.debug(`adding labels: ${labels} from issue/pull ${number}`);
             await this.octokit.issues.addLabels({
                 owner: this.repository.owner,
                 repo: this.repository.repo,
@@ -323,6 +324,7 @@ class GitHub {
         this.request = options.octokitAPIs.request;
         this.graphql = options.octokitAPIs.graphql;
         this.fileCache = new git_file_utils_1.RepositoryFileCache(this.octokit, this.repository);
+        this.logger = (_a = options.logger) !== null && _a !== void 0 ? _a : logger_1.logger;
     }
     /**
      * Build a new GitHub client with auto-detected default branch.
@@ -450,7 +452,7 @@ class GitHub {
     }
     async mergeCommitsGraphQL(targetBranch, cursor, options = {}) {
         var _a, _b;
-        logger_1.logger.debug(`Fetching merge commits on branch ${targetBranch} with cursor: ${cursor}`);
+        this.logger.debug(`Fetching merge commits on branch ${targetBranch} with cursor: ${cursor}`);
         const query = `query pullRequestsSince($owner: String!, $repo: String!, $num: Int!, $maxFilesChanged: Int, $targetBranch: String!, $cursor: String) {
       repository(owner: $owner, name: $repo) {
         ref(qualifiedName: $targetBranch) {
@@ -510,12 +512,12 @@ class GitHub {
             ...params,
         });
         if (!response) {
-            logger_1.logger.warn(`Did not receive a response for query: ${query}`, params);
+            this.logger.warn(`Did not receive a response for query: ${query}`, params);
             return null;
         }
         // if the branch does exist, return null
         if (!((_a = response.repository) === null || _a === void 0 ? void 0 : _a.ref)) {
-            logger_1.logger.warn(`Could not find commits for branch ${targetBranch} - it likely does not exist.`);
+            this.logger.warn(`Could not find commits for branch ${targetBranch} - it likely does not exist.`);
             return null;
         }
         const history = response.repository.ref.target.history;
@@ -542,7 +544,7 @@ class GitHub {
                     files,
                 };
                 if (((_b = pullRequest.files.pageInfo) === null || _b === void 0 ? void 0 : _b.hasNextPage) && options.backfillFiles) {
-                    logger_1.logger.info(`PR #${pullRequest.number} has many files, backfilling`);
+                    this.logger.info(`PR #${pullRequest.number} has many files, backfilling`);
                     commit.files = await this.getCommitFiles(graphCommit.sha);
                 }
                 else {
@@ -568,12 +570,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 +614,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.
@@ -605,7 +673,7 @@ class GitHub {
      */
     async pullRequestsGraphQL(targetBranch, states = 'MERGED', cursor) {
         var _a;
-        logger_1.logger.debug(`Fetching ${states} pull requests on branch ${targetBranch} with cursor ${cursor}`);
+        this.logger.debug(`Fetching ${states} pull requests on branch ${targetBranch} with cursor ${cursor}`);
         const response = await this.graphqlRequest({
             query: `query mergedPullRequests($owner: String!, $repo: String!, $num: Int!, $maxFilesChanged: Int, $targetBranch: String!, $states: [PullRequestState!], $cursor: String) {
         repository(owner: $owner, name: $repo) {
@@ -650,7 +718,7 @@ class GitHub {
             maxFilesChanged: 64,
         });
         if (!((_a = response === null || response === void 0 ? void 0 : response.repository) === null || _a === void 0 ? void 0 : _a.pullRequests)) {
-            logger_1.logger.warn(`Could not find merged pull requests for branch ${targetBranch} - it likely does not exist.`);
+            this.logger.warn(`Could not find merged pull requests for branch ${targetBranch} - it likely does not exist.`);
             return null;
         }
         const pullRequests = (response.repository.pullRequests.nodes ||
@@ -704,7 +772,7 @@ class GitHub {
         }
     }
     async releaseGraphQL(cursor) {
-        logger_1.logger.debug(`Fetching releases with cursor ${cursor}`);
+        this.logger.debug(`Fetching releases with cursor ${cursor}`);
         const response = await this.graphqlRequest({
             query: `query releases($owner: String!, $repo: String!, $num: Int!, $cursor: String) {
         repository(owner: $owner, name: $repo) {
@@ -734,7 +802,7 @@ class GitHub {
             num: 25,
         });
         if (!response.repository.releases.nodes.length) {
-            logger_1.logger.warn('Could not find releases.');
+            this.logger.warn('Could not find releases.');
             return null;
         }
         const releases = response.repository.releases.nodes;
@@ -744,7 +812,7 @@ class GitHub {
                 .filter(release => !!release.tagCommit)
                 .map(release => {
                 if (!release.tag || !release.tagCommit) {
-                    logger_1.logger.debug(release);
+                    this.logger.debug(release);
                 }
                 return {
                     name: release.name || undefined,
@@ -805,7 +873,7 @@ class GitHub {
      * @throws {GitHubAPIError} on other API errors
      */
     async getFileContentsOnBranch(path, branch) {
-        logger_1.logger.debug(`Fetching ${path} from branch ${branch}`);
+        this.logger.debug(`Fetching ${path} from branch ${branch}`);
         try {
             return await this.fileCache.getFileContents(path, branch);
         }
@@ -884,14 +952,14 @@ class GitHub {
                 // if the file is missing and create = false, just continue
                 // to the next update, otherwise create the file.
                 if (!update.createIfMissing) {
-                    logger_1.logger.warn(`file ${update.path} did not exist`);
+                    this.logger.warn(`file ${update.path} did not exist`);
                     continue;
                 }
             }
             const contentText = content
                 ? Buffer.from(content.content, 'base64').toString('utf8')
                 : undefined;
-            const updatedContent = update.updater.updateContent(contentText);
+            const updatedContent = update.updater.updateContent(contentText, this.logger);
             if (updatedContent) {
                 changes.set(update.path, {
                     content: updatedContent,

package/build/src/manifest.d.ts

@@ -2,6 +2,7 @@ import { ChangelogSection } from './changelog-notes';
 import { GitHub, GitHubRelease } from './github';
 import { Version } from './version';
 import { PullRequest } from './pull-request';
+import { Logger } from './util/logger';
 import { ReleasePullRequest } from './release-pull-request';
 import { ReleaseType, VersioningStrategyType, ChangelogNotesType } from './factory';
 import { Release } from './release';
@@ -114,6 +115,7 @@ export interface ManifestOptions {
     groupPullRequestTitlePattern?: string;
     releaseSearchDepth?: number;
     commitSearchDepth?: number;
+    logger?: Logger;
 }
 export interface ReleaserPackageConfig extends ReleaserConfigJson {
     'package-name'?: string;
@@ -192,6 +194,7 @@ export declare class Manifest {
     private groupPullRequestTitlePattern?;
     readonly releaseSearchDepth: number;
     readonly commitSearchDepth: number;
+    readonly logger: Logger;
     /**
      * Create a Manifest from explicit config in code. This assumes that the
      * repository has a single component at the root path.