release-please 16.1.0 → 16.2.0

package/CHANGELOG.md

@@ -4,6 +4,19 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [16.2.0](https://github.com/googleapis/release-please/compare/v16.1.0...v16.2.0) (2023-11-08)
+
+
+### Features
+
+* Allow customizing PR body footer ([#2115](https://github.com/googleapis/release-please/issues/2115)) ([43014a1](https://github.com/googleapis/release-please/commit/43014a1f15d3640d67cb90cbf3047919facfa53e))
+
+
+### Bug Fixes
+
+* Correctly parse standalone prerelease PR body ([#2123](https://github.com/googleapis/release-please/issues/2123)) ([5ee9e3e](https://github.com/googleapis/release-please/commit/5ee9e3e9ae292dc4128717c3d5924da93b3bb670))
+* Set PR labels serially ([#2122](https://github.com/googleapis/release-please/issues/2122)) ([bf58911](https://github.com/googleapis/release-please/commit/bf58911d989f08abe3105309b6e6f918186e1125))
+
 ## [16.1.0](https://github.com/googleapis/release-please/compare/v16.0.0...v16.1.0) (2023-10-26)
 
 

package/README.md

@@ -63,7 +63,7 @@ A linear git history makes it much easier to:
   change introduced a bug
 * Control the release-please changelog - when you merge a PR, you may have
   commit messages that make sense within the scope of the PR, but don't
-  make sense when merged in the main branch. For example, you make have
+  make sense when merged in the main branch. For example, you may have
   `feat: introduce feature A` and then `fix: some bugfix introduced in
   the first commit`. The `fix` commit is actually irrelevant to the release
   notes as there was never a bug experienced in the main branch.

package/build/src/bin/release-please.js

@@ -274,6 +274,10 @@ function taggingOptions(yargs) {
         .option('pull-request-header', {
         describe: 'Header for release PR',
         type: 'string',
+    })
+        .option('pull-request-footer', {
+        describe: 'Footer for release PR',
+        type: 'string',
     });
 }
 const createReleasePullRequestCommand = {
@@ -300,6 +304,7 @@ const createReleasePullRequestCommand = {
                 changelogHost: argv.changelogHost,
                 pullRequestTitlePattern: argv.pullRequestTitlePattern,
                 pullRequestHeader: argv.pullRequestHeader,
+                pullRequestFooter: argv.pullRequestFooter,
                 changelogSections: argv.changelogSections,
                 releaseAs: argv.releaseAs,
                 versioning: argv.versioningStrategy,

package/build/src/manifest.d.ts

@@ -57,6 +57,7 @@ export interface ReleaserConfig {
     includeVInTag?: boolean;
     pullRequestTitlePattern?: string;
     pullRequestHeader?: string;
+    pullRequestFooter?: string;
     tagSeparator?: string;
     separatePullRequests?: boolean;
     labels?: string[];
@@ -105,6 +106,7 @@ interface ReleaserConfigJson {
     'changelog-host'?: string;
     'pull-request-title-pattern'?: string;
     'pull-request-header'?: string;
+    'pull-request-footer'?: string;
     'separate-pull-requests'?: boolean;
     'tag-separator'?: string;
     'extra-files'?: ExtraFile[];

package/build/src/manifest.js

@@ -688,10 +688,8 @@ class Manifest {
                 releases.length) {
                 // we've either tagged all releases or they were duplicates:
                 // adjust tags on pullRequest
-                await Promise.all([
-                    this.github.removeIssueLabels(this.labels, pullRequest.number),
-                    this.github.addIssueLabels(this.releaseLabels, pullRequest.number),
-                ]);
+                await this.github.removeIssueLabels(this.labels, pullRequest.number);
+                await this.github.addIssueLabels(this.releaseLabels, pullRequest.number);
             }
             if (githubReleases.length === 0) {
                 // If all releases were duplicate, throw a duplicate error
@@ -700,10 +698,8 @@ class Manifest {
         }
         else {
             // adjust tags on pullRequest
-            await Promise.all([
-                this.github.removeIssueLabels(this.labels, pullRequest.number),
-                this.github.addIssueLabels(this.releaseLabels, pullRequest.number),
-            ]);
+            await this.github.removeIssueLabels(this.labels, pullRequest.number);
+            await this.github.addIssueLabels(this.releaseLabels, pullRequest.number);
         }
         return githubReleases;
     }
@@ -791,6 +787,7 @@ function extractReleaserConfig(config) {
         changelogType: config['changelog-type'],
         pullRequestTitlePattern: config['pull-request-title-pattern'],
         pullRequestHeader: config['pull-request-header'],
+        pullRequestFooter: config['pull-request-footer'],
         tagSeparator: config['tag-separator'],
         separatePullRequests: config['separate-pull-requests'],
         labels: (_a = config['label']) === null || _a === void 0 ? void 0 : _a.split(','),
@@ -1011,7 +1008,7 @@ async function latestReleaseVersion(github, targetBranch, releaseFilter, config,
     return candidateTagVersion.sort((a, b) => b.compare(a))[0];
 }
 function mergeReleaserConfig(defaultConfig, pathConfig) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4;
     return {
         releaseType: (_b = (_a = pathConfig.releaseType) !== null && _a !== void 0 ? _a : defaultConfig.releaseType) !== null && _b !== void 0 ? _b : 'node',
         bumpMinorPreMajor: (_c = pathConfig.bumpMinorPreMajor) !== null && _c !== void 0 ? _c : defaultConfig.bumpMinorPreMajor,
@@ -1035,11 +1032,12 @@ function mergeReleaserConfig(defaultConfig, pathConfig) {
         tagSeparator: (_w = pathConfig.tagSeparator) !== null && _w !== void 0 ? _w : defaultConfig.tagSeparator,
         pullRequestTitlePattern: (_x = pathConfig.pullRequestTitlePattern) !== null && _x !== void 0 ? _x : defaultConfig.pullRequestTitlePattern,
         pullRequestHeader: (_y = pathConfig.pullRequestHeader) !== null && _y !== void 0 ? _y : defaultConfig.pullRequestHeader,
-        separatePullRequests: (_z = pathConfig.separatePullRequests) !== null && _z !== void 0 ? _z : defaultConfig.separatePullRequests,
-        skipSnapshot: (_0 = pathConfig.skipSnapshot) !== null && _0 !== void 0 ? _0 : defaultConfig.skipSnapshot,
-        initialVersion: (_1 = pathConfig.initialVersion) !== null && _1 !== void 0 ? _1 : defaultConfig.initialVersion,
-        extraLabels: (_2 = pathConfig.extraLabels) !== null && _2 !== void 0 ? _2 : defaultConfig.extraLabels,
-        excludePaths: (_3 = pathConfig.excludePaths) !== null && _3 !== void 0 ? _3 : defaultConfig.excludePaths,
+        pullRequestFooter: (_z = pathConfig.pullRequestFooter) !== null && _z !== void 0 ? _z : defaultConfig.pullRequestFooter,
+        separatePullRequests: (_0 = pathConfig.separatePullRequests) !== null && _0 !== void 0 ? _0 : defaultConfig.separatePullRequests,
+        skipSnapshot: (_1 = pathConfig.skipSnapshot) !== null && _1 !== void 0 ? _1 : defaultConfig.skipSnapshot,
+        initialVersion: (_2 = pathConfig.initialVersion) !== null && _2 !== void 0 ? _2 : defaultConfig.initialVersion,
+        extraLabels: (_3 = pathConfig.extraLabels) !== null && _3 !== void 0 ? _3 : defaultConfig.extraLabels,
+        excludePaths: (_4 = pathConfig.excludePaths) !== null && _4 !== void 0 ? _4 : defaultConfig.excludePaths,
     };
 }
 /**

package/build/src/plugins/merge.d.ts

@@ -4,6 +4,7 @@ import { GitHub } from '../github';
 interface MergeOptions {
     pullRequestTitlePattern?: string;
     pullRequestHeader?: string;
+    pullRequestFooter?: string;
     headBranchName?: string;
     forceMerge?: boolean;
 }
@@ -16,6 +17,7 @@ interface MergeOptions {
 export declare class Merge extends ManifestPlugin {
     private pullRequestTitlePattern?;
     private pullRequestHeader?;
+    private pullRequestFooter?;
     private headBranchName?;
     private forceMerge;
     constructor(github: GitHub, targetBranch: string, repositoryConfig: RepositoryConfig, options?: MergeOptions);

package/build/src/plugins/merge.js

@@ -33,6 +33,7 @@ class Merge extends plugin_1.ManifestPlugin {
         this.pullRequestTitlePattern =
             (_a = options.pullRequestTitlePattern) !== null && _a !== void 0 ? _a : manifest_1.MANIFEST_PULL_REQUEST_TITLE_PATTERN;
         this.pullRequestHeader = options.pullRequestHeader;
+        this.pullRequestFooter = options.pullRequestFooter;
         this.headBranchName = options.headBranchName;
         this.forceMerge = (_b = options.forceMerge) !== null && _b !== void 0 ? _b : false;
     }
@@ -72,6 +73,7 @@ class Merge extends plugin_1.ManifestPlugin {
             body: new pull_request_body_1.PullRequestBody(releaseData, {
                 useComponents: true,
                 header: this.pullRequestHeader,
+                footer: this.pullRequestFooter,
             }),
             updates,
             labels: Array.from(labels),

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

@@ -43,6 +43,7 @@ export interface BaseStrategyOptions {
     includeVInTag?: boolean;
     pullRequestTitlePattern?: string;
     pullRequestHeader?: string;
+    pullRequestFooter?: string;
     extraFiles?: ExtraFile[];
     versionFile?: string;
     snapshotLabels?: string[];
@@ -74,6 +75,7 @@ export declare abstract class BaseStrategy implements Strategy {
     protected initialVersion?: string;
     readonly pullRequestTitlePattern?: string;
     readonly pullRequestHeader?: string;
+    readonly pullRequestFooter?: string;
     readonly extraFiles: ExtraFile[];
     readonly extraLabels: string[];
     readonly changelogNotes: ChangelogNotes;
@@ -101,7 +103,7 @@ export declare abstract class BaseStrategy implements Strategy {
      */
     protected postProcessCommits(commits: ConventionalCommit[]): Promise<ConventionalCommit[]>;
     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, pullRequestHeader?: string): Promise<PullRequestBody>;
+    protected buildPullRequestBody(component: string | undefined, newVersion: Version, releaseNotesBody: string, _conventionalCommits: ConventionalCommit[], _latestRelease?: Release, pullRequestHeader?: string, pullRequestFooter?: string): Promise<PullRequestBody>;
     /**
      * Builds a candidate release pull request
      * @param {Commit[]} commits Raw commits to consider for this release.

package/build/src/strategies/base.js

@@ -61,6 +61,7 @@ class BaseStrategy {
         this.includeVInTag = (_c = options.includeVInTag) !== null && _c !== void 0 ? _c : true;
         this.pullRequestTitlePattern = options.pullRequestTitlePattern;
         this.pullRequestHeader = options.pullRequestHeader;
+        this.pullRequestFooter = options.pullRequestFooter;
         this.extraFiles = options.extraFiles || [];
         this.initialVersion = options.initialVersion;
         this.extraLabels = options.extraLabels || [];
@@ -118,14 +119,17 @@ class BaseStrategy {
             commits: commits,
         });
     }
-    async buildPullRequestBody(component, newVersion, releaseNotesBody, _conventionalCommits, _latestRelease, pullRequestHeader) {
+    async buildPullRequestBody(component, newVersion, releaseNotesBody, _conventionalCommits, _latestRelease, pullRequestHeader, pullRequestFooter) {
         return new pull_request_body_1.PullRequestBody([
             {
                 component,
                 version: newVersion,
                 notes: releaseNotesBody,
             },
-        ], { header: pullRequestHeader });
+        ], {
+            header: pullRequestHeader,
+            footer: pullRequestFooter,
+        });
     }
     /**
      * Builds a candidate release pull request
@@ -169,7 +173,7 @@ class BaseStrategy {
             commits: conventionalCommits,
         });
         const updatesWithExtras = (0, composite_1.mergeUpdates)(updates.concat(...(await this.extraFileUpdates(newVersion, versionsMap))));
-        const pullRequestBody = await this.buildPullRequestBody(component, newVersion, releaseNotesBody, conventionalCommits, latestRelease, this.pullRequestHeader);
+        const pullRequestBody = await this.buildPullRequestBody(component, newVersion, releaseNotesBody, conventionalCommits, latestRelease, this.pullRequestHeader, this.pullRequestFooter);
         return {
             title: pullRequestTitle,
             body: pullRequestBody,

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

@@ -34,17 +34,20 @@ const CHANGELOG_SECTIONS = [
 const DEFAULT_CHANGELOG_PATH = 'docs/history.md';
 const DEFAULT_PULL_REQUEST_TITLE_PATTERN = 'Release${component} version ${version}';
 const DEFAULT_PULL_REQUEST_HEADER = ':robot: I have created a release *beep* *boop*';
+const DEFAULT_PULL_REQUEST_FOOTER = 'This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).';
 const RELEASE_NOTES_HEADER_PATTERN = /#{2,3} \[?(\d+\.\d+\.\d+-?[^\]]*)\]?.* \((\d{4}-\d{2}-\d{2})\)/;
 class DotnetYoshi extends base_1.BaseStrategy {
     constructor(options) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         options.changelogSections = (_a = options.changelogSections) !== null && _a !== void 0 ? _a : CHANGELOG_SECTIONS;
         options.changelogPath = (_b = options.changelogPath) !== null && _b !== void 0 ? _b : DEFAULT_CHANGELOG_PATH;
         options.pullRequestTitlePattern =
             (_c = options.pullRequestTitlePattern) !== null && _c !== void 0 ? _c : DEFAULT_PULL_REQUEST_TITLE_PATTERN;
         options.pullRequestHeader =
             (_d = options.pullRequestHeader) !== null && _d !== void 0 ? _d : DEFAULT_PULL_REQUEST_HEADER;
-        options.includeVInTag = (_e = options.includeVInTag) !== null && _e !== void 0 ? _e : false;
+        options.pullRequestFooter =
+            (_e = options.pullRequestFooter) !== null && _e !== void 0 ? _e : DEFAULT_PULL_REQUEST_FOOTER;
+        options.includeVInTag = (_f = options.includeVInTag) !== null && _f !== void 0 ? _f : false;
         super(options);
     }
     async buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease) {

package/build/src/updaters/release-please-config.js

@@ -64,6 +64,7 @@ function releaserConfigToJsonConfig(config) {
         'changelog-host': config.changelogHost,
         'pull-request-title-pattern': config.pullRequestTitlePattern,
         'pull-request-header': config.pullRequestHeader,
+        'pull-request-footer': config.pullRequestFooter,
         'separate-pull-requests': config.separatePullRequests,
         'tag-separator': config.tagSeparator,
         'extra-files': config.extraFiles,

package/build/src/util/pull-request-body.js

@@ -127,7 +127,7 @@ function extractMultipleReleases(notes, logger) {
     }
     return data;
 }
-const COMPARE_REGEX = /^#{2,} \[?(?<version>\d+\.\d+\.\d+.*)\]?/;
+const COMPARE_REGEX = /^#{2,} \[?(?<version>\d+\.\d+\.\d+[^\]]*)\]?/;
 function extractSingleRelease(body, logger) {
     var _a;
     body = body.trim();

package/package.json

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

package/schemas/config.json

@@ -103,6 +103,10 @@
           "description": "Customize the release pull request header.",
           "type": "string"
         },
+        "pull-request-footer": {
+          "description": "Customize the release pull request footer.",
+          "type": "string"
+        },
         "separate-pull-requests": {
           "description": "Open a separate release pull request for each component. Defaults to `false`.",
           "type": "boolean"
@@ -404,6 +408,7 @@
     "changelog-path": true,
     "pull-request-title-pattern": true,
     "pull-request-header": true,
+    "pull-request-footer": true,
     "separate-pull-requests": true,
     "tag-separator": true,
     "extra-files": true,