release-please 13.6.0 → 13.7.0

package/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [13.7.0](https://github.com/googleapis/release-please/compare/v13.6.0...v13.7.0) (2022-03-24)
+
+
+### Features
+
+* allow snoozing release pull requests ([#1345](https://github.com/googleapis/release-please/issues/1345)) ([ea69708](https://github.com/googleapis/release-please/commit/ea6970813a11cebe2394c19d8d006d352c8fb306)), closes [#1339](https://github.com/googleapis/release-please/issues/1339)
+
 ## [13.6.0](https://github.com/googleapis/release-please/compare/v13.5.0...v13.6.0) (2022-03-16)
 
 

package/build/src/changelog-notes.d.ts

@@ -1,4 +1,4 @@
-import { ConventionalCommit } from './commit';
+import { Commit, ConventionalCommit } from './commit';
 export interface BuildNotesOptions {
     host?: string;
     owner: string;
@@ -8,6 +8,7 @@ export interface BuildNotesOptions {
     currentTag: string;
     targetBranch: string;
     changelogSections?: ChangelogSection[];
+    commits?: Commit[];
 }
 export interface ChangelogNotes {
     buildNotes(commits: ConventionalCommit[], options: BuildNotesOptions): Promise<string>;

package/build/src/manifest.d.ts

@@ -223,7 +223,11 @@ export declare class Manifest {
      * @returns {number[]} Pull request numbers of release pull requests
      */
     createPullRequests(): Promise<(PullRequest | undefined)[]>;
+    private findOpenReleasePullRequests;
+    private findSnoozedReleasePullRequests;
     private createOrUpdatePullRequest;
+    private maybeUpdateExistingPullRequest;
+    private maybeUpdateSnoozedPullRequest;
     private findMergedReleasePullRequests;
     /**
      * Find merged, untagged releases and build candidate releases to tag.

package/build/src/manifest.js

@@ -31,6 +31,7 @@ exports.ROOT_PROJECT_PATH = '.';
 const DEFAULT_COMPONENT_NAME = '';
 const DEFAULT_LABELS = ['autorelease: pending'];
 const DEFAULT_RELEASE_LABELS = ['autorelease: tagged'];
+const SNOOZE_LABEL = 'autorelease: snooze';
 exports.MANIFEST_PULL_REQUEST_TITLE_PATTERN = 'chore: release ${branch}';
 class Manifest {
     /**
@@ -398,7 +399,18 @@ class Manifest {
             logger_1.logger.warn('There are untagged, merged release PRs outstanding - aborting');
             return [];
         }
-        // collect open release pull requests
+        // collect open and snoozed release pull requests
+        const openPullRequests = await this.findOpenReleasePullRequests();
+        const snoozedPullRequests = await this.findSnoozedReleasePullRequests();
+        const promises = [];
+        for (const pullRequest of candidatePullRequests) {
+            promises.push(this.createOrUpdatePullRequest(pullRequest, openPullRequests, snoozedPullRequests));
+        }
+        const pullNumbers = await Promise.all(promises);
+        // reject any pull numbers that were not created or updated
+        return pullNumbers.filter(number => !!number);
+    }
+    async findOpenReleasePullRequests() {
         logger_1.logger.info('Looking for open release pull requests');
         const openPullRequests = [];
         const generator = this.github.pullRequestIterator(this.targetBranch, 'OPEN');
@@ -410,34 +422,66 @@ class Manifest {
             }
         }
         logger_1.logger.info(`found ${openPullRequests.length} open release pull requests.`);
-        const promises = [];
-        for (const pullRequest of candidatePullRequests) {
-            promises.push(this.createOrUpdatePullRequest(pullRequest, openPullRequests));
+        return openPullRequests;
+    }
+    async findSnoozedReleasePullRequests() {
+        logger_1.logger.info('Looking for snoozed release pull requests');
+        const snoozedPullRequests = [];
+        const closedGenerator = this.github.pullRequestIterator(this.targetBranch, 'CLOSED');
+        for await (const closedPullRequest of closedGenerator) {
+            if (hasAllLabels([SNOOZE_LABEL], closedPullRequest.labels) &&
+                branch_name_1.BranchName.parse(closedPullRequest.headBranchName) &&
+                pull_request_body_1.PullRequestBody.parse(closedPullRequest.body)) {
+                snoozedPullRequests.push(closedPullRequest);
+            }
         }
-        return await Promise.all(promises);
+        logger_1.logger.info(`found ${snoozedPullRequests.length} snoozed release pull requests.`);
+        return snoozedPullRequests;
     }
-    async createOrUpdatePullRequest(pullRequest, openPullRequests) {
-        // look for existing, open pull rquest
+    async createOrUpdatePullRequest(pullRequest, openPullRequests, snoozedPullRequests) {
+        // look for existing, open pull request
         const existing = openPullRequests.find(openPullRequest => openPullRequest.headBranchName === pullRequest.headRefName);
         if (existing) {
-            // If unchanged, no need to push updates
-            if (existing.body === pullRequest.body.toString()) {
-                logger_1.logger.info(`PR https://github.com/${this.repository.owner}/${this.repository.repo}/pull/${existing.number} remained the same`);
-                return undefined;
-            }
-            const updatedPullRequest = await this.github.updatePullRequest(existing.number, pullRequest, this.targetBranch, {
-                fork: this.fork,
-                signoffUser: this.signoffUser,
-            });
-            return updatedPullRequest;
+            return await this.maybeUpdateExistingPullRequest(existing, pullRequest);
         }
-        else {
-            const newPullRequest = await this.github.createReleasePullRequest(pullRequest, this.targetBranch, {
-                fork: this.fork,
-                signoffUser: this.signoffUser,
-            });
-            return newPullRequest;
+        // look for closed, snoozed pull request
+        const snoozed = snoozedPullRequests.find(openPullRequest => openPullRequest.headBranchName === pullRequest.headRefName);
+        if (snoozed) {
+            return await this.maybeUpdateSnoozedPullRequest(snoozed, pullRequest);
         }
+        const newPullRequest = await this.github.createReleasePullRequest(pullRequest, this.targetBranch, {
+            fork: this.fork,
+            signoffUser: this.signoffUser,
+        });
+        return newPullRequest;
+    }
+    /// only update an existing pull request if it has release note changes
+    async maybeUpdateExistingPullRequest(existing, pullRequest) {
+        // If unchanged, no need to push updates
+        if (existing.body === pullRequest.body.toString()) {
+            logger_1.logger.info(`PR https://github.com/${this.repository.owner}/${this.repository.repo}/pull/${existing.number} remained the same`);
+            return undefined;
+        }
+        const updatedPullRequest = await this.github.updatePullRequest(existing.number, pullRequest, this.targetBranch, {
+            fork: this.fork,
+            signoffUser: this.signoffUser,
+        });
+        return updatedPullRequest;
+    }
+    /// only update an snoozed pull request if it has release note changes
+    async maybeUpdateSnoozedPullRequest(snoozed, pullRequest) {
+        // If unchanged, no need to push updates
+        if (snoozed.body === pullRequest.body.toString()) {
+            logger_1.logger.info(`PR https://github.com/${this.repository.owner}/${this.repository.repo}/pull/${snoozed.number} remained the same`);
+            return undefined;
+        }
+        const updatedPullRequest = await this.github.updatePullRequest(snoozed.number, pullRequest, this.targetBranch, {
+            fork: this.fork,
+            signoffUser: this.signoffUser,
+        });
+        // TODO: consider leaving the snooze label
+        await this.github.removeIssueLabels([SNOOZE_LABEL], snoozed.number);
+        return updatedPullRequest;
     }
     async *findMergedReleasePullRequests() {
         // Find merged release pull requests

package/build/src/strategies/base.d.ts

@@ -82,7 +82,7 @@ export declare abstract class BaseStrategy implements Strategy {
      * @returns {ConventionalCommit[]} modified commits
      */
     protected postProcessCommits(commits: ConventionalCommit[]): Promise<ConventionalCommit[]>;
-    protected buildReleaseNotes(conventionalCommits: ConventionalCommit[], newVersion: Version, newVersionTag: TagName, latestRelease?: Release): Promise<string>;
+    protected buildReleaseNotes(conventionalCommits: ConventionalCommit[], newVersion: Version, newVersionTag: TagName, latestRelease?: Release, commits?: Commit[]): Promise<string>;
     protected buildPullRequestBody(component: string | undefined, newVersion: Version, releaseNotesBody: string, _conventionalCommits: ConventionalCommit[], _latestRelease?: Release): Promise<PullRequestBody>;
     /**
      * Builds a candidate release pull request

package/build/src/strategies/base.js

@@ -92,7 +92,7 @@ class BaseStrategy {
     async postProcessCommits(commits) {
         return commits;
     }
-    async buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease) {
+    async buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease, commits) {
         var _a;
         return await this.changelogNotes.buildNotes(conventionalCommits, {
             owner: this.repository.owner,
@@ -102,6 +102,7 @@ class BaseStrategy {
             currentTag: newVersionTag.toString(),
             targetBranch: this.targetBranch,
             changelogSections: this.changelogSections,
+            commits: commits,
         });
     }
     async buildPullRequestBody(component, newVersion, releaseNotesBody, _conventionalCommits, _latestRelease) {
@@ -141,7 +142,7 @@ class BaseStrategy {
         const branchName = component
             ? branch_name_1.BranchName.ofComponentTargetBranch(component, this.targetBranch)
             : branch_name_1.BranchName.ofTargetBranch(this.targetBranch);
-        const releaseNotesBody = await this.buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease);
+        const releaseNotesBody = await this.buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease, commits);
         if (this.changelogEmpty(releaseNotesBody)) {
             logger_1.logger.info(`No user facing commits found since ${latestRelease ? latestRelease.sha : 'beginning of time'} - skipping`);
             return undefined;

package/build/src/strategies/go-yoshi.d.ts

@@ -1,6 +1,6 @@
 import { BaseStrategy, BuildUpdatesOptions, BaseStrategyOptions } from './base';
 import { Update } from '../update';
-import { ConventionalCommit } from '../commit';
+import { Commit, ConventionalCommit } from '../commit';
 import { Version } from '../version';
 import { TagName } from '../util/tag-name';
 import { Release } from '../release';
@@ -9,6 +9,6 @@ export declare class GoYoshi extends BaseStrategy {
     protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
     protected postProcessCommits(commits: ConventionalCommit[]): Promise<ConventionalCommit[]>;
     getIgnoredSubModules(): Promise<Set<string>>;
-    protected buildReleaseNotes(conventionalCommits: ConventionalCommit[], newVersion: Version, newVersionTag: TagName, latestRelease?: Release): Promise<string>;
+    protected buildReleaseNotes(conventionalCommits: ConventionalCommit[], newVersion: Version, newVersionTag: TagName, latestRelease?: Release, commits?: Commit[]): Promise<string>;
     protected initialReleaseVersion(): Version;
 }

package/build/src/strategies/go-yoshi.js

@@ -137,8 +137,8 @@ class GoYoshi extends base_1.BaseStrategy {
     }
     // "closes" is a little presumptuous, let's just indicate that the
     // PR references these other commits:
-    async buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease) {
-        const releaseNotes = await super.buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease);
+    async buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease, commits) {
+        const releaseNotes = await super.buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease, commits);
         return releaseNotes.replace(/, closes /g, ', refs ');
     }
     initialReleaseVersion() {

package/package.json

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