release-please 13.2.0 → 13.3.2

package/CHANGELOG.md

@@ -4,6 +4,42 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+### [13.3.2](https://github.com/googleapis/release-please/compare/v13.3.1...v13.3.2) (2022-01-13)
+
+
+### Bug Fixes
+
+* BranchName.parse should not throw exceptions ([#1227](https://github.com/googleapis/release-please/issues/1227)) ([364f1ac](https://github.com/googleapis/release-please/commit/364f1ac996b0120820d9bb37db96bb27a79aa936))
+* initial release version should respect Release-As commit ([#1222](https://github.com/googleapis/release-please/issues/1222)) ([22b9770](https://github.com/googleapis/release-please/commit/22b977028e2959aea088c09e3a021e2aa0e10f03))
+* Release-As commits should appear in the changelog correctly ([#1220](https://github.com/googleapis/release-please/issues/1220)) ([ab56c82](https://github.com/googleapis/release-please/commit/ab56c82e81091cbedeb8f328451ac486d7f986a4))
+* use latest Release-As commit when overriding version ([#1224](https://github.com/googleapis/release-please/issues/1224)) ([2d7cb8f](https://github.com/googleapis/release-please/commit/2d7cb8fa329d1c60b881bc0435523b81ea47a32d))
+
+### [13.3.1](https://github.com/googleapis/release-please/compare/v13.3.0...v13.3.1) (2022-01-12)
+
+
+### Bug Fixes
+
+* pass target_commitish instead of sha ([#1219](https://github.com/googleapis/release-please/issues/1219)) ([3f26ec3](https://github.com/googleapis/release-please/commit/3f26ec3de527497d7180f2cd987983c6ae6e44cd))
+
+## [13.3.0](https://github.com/googleapis/release-please/compare/v13.2.1...v13.3.0) (2022-01-12)
+
+
+### Features
+
+* allow configuring simple strategy version file ([#1168](https://github.com/googleapis/release-please/issues/1168)) ([08a0cf2](https://github.com/googleapis/release-please/commit/08a0cf2b2135713f856d8621cffa8f5b92fb8699))
+
+
+### Bug Fixes
+
+* ruby-yoshi strategy should put commit summary only in pull request body ([#1193](https://github.com/googleapis/release-please/issues/1193)) ([d29eda1](https://github.com/googleapis/release-please/commit/d29eda172597979cea5cb54ce6eb278a1dfb03a0)), closes [#1192](https://github.com/googleapis/release-please/issues/1192)
+
+### [13.2.1](https://github.com/googleapis/release-please/compare/v13.2.0...v13.2.1) (2022-01-12)
+
+
+### Bug Fixes
+
+* **php-yoshi:** fix parsing of pull request body ([#1213](https://github.com/googleapis/release-please/issues/1213)) ([00702ca](https://github.com/googleapis/release-please/commit/00702ca575e5d134505280b436e1348eccb2de01))
+
 ## [13.2.0](https://github.com/googleapis/release-please/compare/v13.1.1...v13.2.0) (2022-01-11)
 
 

package/build/src/changelog-notes/default.js

@@ -52,13 +52,16 @@ class DefaultChangelogNotes {
                 subject: commit.bareMessage,
                 type: commit.type,
                 scope: commit.scope,
-                notes: commit.notes,
+                notes: commit.notes.filter(note => note.title === 'BREAKING CHANGE'),
                 references: commit.references,
                 mentions: [],
                 merge: null,
                 revert: null,
                 header: commit.message,
-                footer: null,
+                footer: commit.notes
+                    .filter(note => note.title === 'RELEASE AS')
+                    .map(note => `Release-As: ${note.text}`)
+                    .join('\n'),
                 hash: commit.sha,
             };
         });

package/build/src/factory.js

@@ -76,7 +76,6 @@ const releasers = {
     'php-yoshi': options => new php_yoshi_1.PHPYoshi(options),
     python: options => new python_1.Python(options),
     rust: options => new rust_1.Rust(options),
-    simple: options => new simple_1.Simple(options),
     'terraform-module': options => new terraform_module_1.TerraformModule(options),
     helm: options => new helm_1.Helm(options),
     elixir: options => new elixir_1.Elixir(options),
@@ -159,6 +158,12 @@ async function buildStrategy(options) {
                 versioningStrategy: new service_pack_1.ServicePackVersioningStrategy(),
             });
         }
+        case 'simple': {
+            return new simple_1.Simple({
+                ...strategyOptions,
+                versionFile: options.versionFile,
+            });
+        }
         default: {
             const builder = releasers[options.releaseType];
             if (builder) {

package/build/src/github.js

@@ -304,9 +304,9 @@ class GitHub {
                 repo: this.repository.repo,
                 tag_name: release.tag.toString(),
                 body: release.notes,
-                sha: release.sha,
                 draft: !!options.draft,
                 prerelease: !!options.prerelease,
+                target_commitish: release.sha,
             });
             return {
                 name: resp.data.name || undefined,

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

@@ -9,6 +9,7 @@ import { Version, VersionsMap } from '../version';
 import { TagName } from '../util/tag-name';
 import { Release } from '../release';
 import { ReleasePullRequest } from '../release-pull-request';
+import { PullRequestBody } from '../util/pull-request-body';
 import { PullRequest } from '../pull-request';
 export interface BuildUpdatesOptions {
     changelogEntry: string;
@@ -80,6 +81,7 @@ export declare abstract class BaseStrategy implements Strategy {
      */
     protected postProcessCommits(commits: ConventionalCommit[]): ConventionalCommit[];
     protected buildReleaseNotes(conventionalCommits: ConventionalCommit[], newVersion: Version, newVersionTag: TagName, latestRelease?: Release): Promise<string>;
+    protected buildPullRequestBody(component: string | undefined, newVersion: Version, releaseNotesBody: string, _conventionalCommits: ConventionalCommit[], _latestRelease?: Release): Promise<PullRequestBody>;
     /**
      * Builds a candidate release pull request
      * @param {Commit[]} commits Raw commits to consider for this release.
@@ -97,6 +99,7 @@ export declare abstract class BaseStrategy implements Strategy {
     protected updateVersionsMap(versionsMap: VersionsMap, conventionalCommits: ConventionalCommit[]): Promise<VersionsMap>;
     protected buildNewVersion(conventionalCommits: ConventionalCommit[], latestRelease?: Release): Promise<Version>;
     protected buildVersionsMap(_conventionalCommits: ConventionalCommit[]): Promise<VersionsMap>;
+    protected parsePullRequestBody(pullRequestBody: string): Promise<PullRequestBody | undefined>;
     /**
      * Given a merged pull request, build the candidate release.
      * @param {PullRequest} mergedPullRequest The merged release pull request.

package/build/src/strategies/base.js

@@ -96,6 +96,15 @@ class BaseStrategy {
             changelogSections: this.changelogSections,
         });
     }
+    async buildPullRequestBody(component, newVersion, releaseNotesBody, _conventionalCommits, _latestRelease) {
+        return new pull_request_body_1.PullRequestBody([
+            {
+                component,
+                version: newVersion,
+                notes: releaseNotesBody,
+            },
+        ]);
+    }
     /**
      * Builds a candidate release pull request
      * @param {Commit[]} commits Raw commits to consider for this release.
@@ -131,13 +140,7 @@ class BaseStrategy {
             latestVersion: latestRelease === null || latestRelease === void 0 ? void 0 : latestRelease.tag.version,
         });
         const updatesWithExtras = composite_1.mergeUpdates(updates.concat(...this.extraFileUpdates(newVersion)));
-        const pullRequestBody = new pull_request_body_1.PullRequestBody([
-            {
-                component,
-                version: newVersion,
-                notes: releaseNotesBody,
-            },
-        ]);
+        const pullRequestBody = await this.buildPullRequestBody(component, newVersion, releaseNotesBody, conventionalCommits, latestRelease);
         return {
             title: pullRequestTitle,
             body: pullRequestBody,
@@ -178,16 +181,24 @@ class BaseStrategy {
             logger_1.logger.warn(`Setting version for ${this.path} from release-as configuration`);
             return version_1.Version.parse(this.releaseAs);
         }
-        else if (latestRelease) {
-            return await this.versioningStrategy.bump(latestRelease.tag.version, conventionalCommits);
+        const releaseAsCommit = conventionalCommits.find(conventionalCommit => conventionalCommit.notes.find(note => note.title === 'RELEASE AS'));
+        if (releaseAsCommit) {
+            const note = releaseAsCommit.notes.find(note => note.title === 'RELEASE AS');
+            if (note) {
+                return version_1.Version.parse(note.text);
+            }
         }
-        else {
-            return this.initialReleaseVersion();
+        if (latestRelease) {
+            return await this.versioningStrategy.bump(latestRelease.tag.version, conventionalCommits);
         }
+        return this.initialReleaseVersion();
     }
     async buildVersionsMap(_conventionalCommits) {
         return new Map();
     }
+    async parsePullRequestBody(pullRequestBody) {
+        return pull_request_body_1.PullRequestBody.parse(pullRequestBody);
+    }
     /**
      * Given a merged pull request, build the candidate release.
      * @param {PullRequest} mergedPullRequest The merged release pull request.
@@ -213,7 +224,7 @@ class BaseStrategy {
             logger_1.logger.error(`Bad branch name: ${mergedPullRequest.headBranchName}`);
             return;
         }
-        const pullRequestBody = pull_request_body_1.PullRequestBody.parse(mergedPullRequest.body);
+        const pullRequestBody = await this.parsePullRequestBody(mergedPullRequest.body);
         if (!pullRequestBody) {
             logger_1.logger.error('Could not parse pull request body as a release PR');
             return;

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

@@ -3,8 +3,10 @@ import { Update } from '../update';
 import { Commit } from '../commit';
 import { Release } from '../release';
 import { ReleasePullRequest } from '../release-pull-request';
+import { PullRequestBody } from '../util/pull-request-body';
 export declare class PHPYoshi extends BaseStrategy {
     constructor(options: BaseStrategyOptions);
     buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest>;
+    protected parsePullRequestBody(pullRequestBody: string): Promise<PullRequestBody | undefined>;
     protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
 }

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

@@ -146,6 +146,23 @@ class PHPYoshi extends base_1.BaseStrategy {
             draft: draft !== null && draft !== void 0 ? draft : false,
         };
     }
+    async parsePullRequestBody(pullRequestBody) {
+        const body = pull_request_body_1.PullRequestBody.parse(pullRequestBody);
+        if (!body) {
+            return undefined;
+        }
+        const component = await this.getComponent();
+        const notes = body.releaseData
+            .map(release => {
+            var _a;
+            return `<details><summary>${release.component}: ${(_a = release.version) === null || _a === void 0 ? void 0 : _a.toString()}</summary>\n\n${release.notes}\n</details>`;
+        })
+            .join('\n\n');
+        return new pull_request_body_1.PullRequestBody([{ component, notes }], {
+            footer: body.footer,
+            header: body.header,
+        });
+    }
     async buildUpdates(options) {
         const updates = [];
         const version = options.newVersion;

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

@@ -3,7 +3,7 @@ import { ConventionalCommit } from '../commit';
 import { Update } from '../update';
 import { Release } from '../release';
 import { Version } from '../version';
-import { TagName } from '../util/tag-name';
+import { PullRequestBody } from '../util/pull-request-body';
 interface RubyYoshiStrategyOptions extends BaseStrategyOptions {
     versionFile?: string;
 }
@@ -12,6 +12,6 @@ export declare class RubyYoshi extends BaseStrategy {
     constructor(options: RubyYoshiStrategyOptions);
     protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
     protected postProcessCommits(commits: ConventionalCommit[]): ConventionalCommit[];
-    protected buildReleaseNotes(conventionalCommits: ConventionalCommit[], newVersion: Version, newVersionTag: TagName, latestRelease?: Release): Promise<string>;
+    protected buildPullRequestBody(component: string | undefined, newVersion: Version, releaseNotesBody: string, conventionalCommits: ConventionalCommit[], latestRelease?: Release): Promise<PullRequestBody>;
 }
 export {};

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

@@ -24,6 +24,7 @@ const fs_1 = require("fs");
 const path_1 = require("path");
 const manifest_1 = require("../manifest");
 const logger_1 = require("../util/logger");
+const pull_request_body_1 = require("../util/pull-request-body");
 const CHANGELOG_SECTIONS = [
     { type: 'feat', section: 'Features' },
     { type: 'fix', section: 'Bug Fixes' },
@@ -79,10 +80,9 @@ class RubyYoshi extends base_1.BaseStrategy {
         });
         return commits;
     }
-    async buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease) {
-        const releaseNotes = await super.buildReleaseNotes(conventionalCommits, newVersion, newVersionTag, latestRelease);
+    async buildPullRequestBody(component, newVersion, releaseNotesBody, conventionalCommits, latestRelease) {
         if (!latestRelease) {
-            return releaseNotes;
+            return await super.buildPullRequestBody(component, newVersion, releaseNotesBody, conventionalCommits, latestRelease);
         }
         // summarize the commits that landed:
         let summary = '### Commits since last release:\n\n';
@@ -114,7 +114,15 @@ class RubyYoshi extends base_1.BaseStrategy {
             summary += `${file}\n`;
         });
         summary += `</code></pre>\n[Compare Changes](https://github.com/${repoUrl}/compare/${latestRelease.sha}...HEAD)\n`;
-        return releaseNotes + `\n---\n${summary}`;
+        return new pull_request_body_1.PullRequestBody([
+            {
+                component,
+                version: newVersion,
+                notes: releaseNotesBody,
+            },
+        ], {
+            extra: summary,
+        });
     }
 }
 exports.RubyYoshi = RubyYoshi;

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

@@ -1,5 +1,11 @@
-import { BaseStrategy, BuildUpdatesOptions } from './base';
+import { BaseStrategy, BuildUpdatesOptions, BaseStrategyOptions } from './base';
 import { Update } from '../update';
+interface SimpleStrategyOptions extends BaseStrategyOptions {
+    versionFile?: string;
+}
 export declare class Simple extends BaseStrategy {
+    readonly versionFile: string;
+    constructor(options: SimpleStrategyOptions);
     protected buildUpdates(options: BuildUpdatesOptions): Promise<Update[]>;
 }
+export {};

package/build/src/strategies/simple.js

@@ -20,6 +20,11 @@ const changelog_1 = require("../updaters/changelog");
 const base_1 = require("./base");
 const default_1 = require("../updaters/default");
 class Simple extends base_1.BaseStrategy {
+    constructor(options) {
+        var _a;
+        super(options);
+        this.versionFile = (_a = options.versionFile) !== null && _a !== void 0 ? _a : 'version.txt';
+    }
     async buildUpdates(options) {
         const updates = [];
         const version = options.newVersion;
@@ -32,7 +37,7 @@ class Simple extends base_1.BaseStrategy {
             }),
         });
         updates.push({
-            path: this.addPath('version.txt'),
+            path: this.addPath(this.versionFile),
             createIfMissing: false,
             updater: new default_1.DefaultUpdater({
                 version,

package/build/src/util/branch-name.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BranchName = void 0;
 const version_1 = require("../version");
+const logger_1 = require("./logger");
 // cannot import from '..' - transpiled code references to RELEASE_PLEASE
 // at the script level are undefined, they are only defined inside function
 // or instance methods/properties.
@@ -32,13 +33,19 @@ function getAllResourceNames() {
 class BranchName {
     constructor(_branchName) { }
     static parse(branchName) {
-        const branchNameClass = getAllResourceNames().find(clazz => {
-            return clazz.matches(branchName);
-        });
-        if (!branchNameClass) {
+        try {
+            const branchNameClass = getAllResourceNames().find(clazz => {
+                return clazz.matches(branchName);
+            });
+            if (!branchNameClass) {
+                return undefined;
+            }
+            return new branchNameClass(branchName);
+        }
+        catch (e) {
+            logger_1.logger.warn(`Error parsing branch name: ${branchName}`, e);
             return undefined;
         }
-        return new branchNameClass(branchName);
     }
     static ofComponentVersion(branchPrefix, version) {
         return new AutoreleaseBranchName(`release-${branchPrefix}-v${version}`);

package/build/src/util/pull-request-body.d.ts

@@ -2,10 +2,12 @@ import { Version } from '../version';
 interface PullRequestBodyOptions {
     header?: string;
     footer?: string;
+    extra?: string;
 }
 export declare class PullRequestBody {
     header: string;
     footer: string;
+    extra?: string;
     releaseData: ReleaseData[];
     constructor(releaseData: ReleaseData[], options?: PullRequestBodyOptions);
     static parse(body: string): PullRequestBody | undefined;

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

@@ -24,6 +24,7 @@ class PullRequestBody {
     constructor(releaseData, options) {
         this.header = (options === null || options === void 0 ? void 0 : options.header) || DEFAULT_HEADER;
         this.footer = (options === null || options === void 0 ? void 0 : options.footer) || DEFAULT_FOOTER;
+        this.extra = options === null || options === void 0 ? void 0 : options.extra;
         this.releaseData = releaseData;
     }
     static parse(body) {
@@ -63,7 +64,7 @@ ${NOTES_DELIMITER}
 
 ${notes}
 
-${NOTES_DELIMITER}
+${NOTES_DELIMITER}${this.extra ? `\n\n${this.extra}\n` : ''}
 ${this.footer}`;
     }
 }
@@ -87,7 +88,7 @@ function splitBody(body) {
         content,
     };
 }
-const SUMMARY_PATTERN = /^(?<component>.*): (?<version>\d+\.\d+\.\d+.*)$/;
+const SUMMARY_PATTERN = /^(?<component>.*[^:]):? (?<version>\d+\.\d+\.\d+.*)$/;
 function extractMultipleReleases(notes) {
     const data = [];
     const root = node_html_parser_1.parse(notes);

package/build/src/versioning-strategies/default.js

@@ -16,6 +16,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultVersioningStrategy = void 0;
 const versioning_strategy_1 = require("../versioning-strategy");
 const version_1 = require("../version");
+const logger_1 = require("../util/logger");
 /**
  * This is the default VersioningStrategy for release-please. Breaking
  * changes should bump the major, features should bump the minor, and other
@@ -48,11 +49,12 @@ class DefaultVersioningStrategy {
         // iterate through list of commits and find biggest commit type
         let breaking = 0;
         let features = 0;
-        let customVersion;
         for (const commit of commits) {
             const releaseAs = commit.notes.find(note => note.title === 'RELEASE AS');
             if (releaseAs) {
-                customVersion = version_1.Version.parse(releaseAs.text);
+                // commits are handled newest to oldest, so take the first one (newest) found
+                logger_1.logger.debug(`found Release-As: ${releaseAs.text}, forcing version`);
+                return new versioning_strategy_1.CustomVersionUpdate(version_1.Version.parse(releaseAs.text).toString());
             }
             if (commit.breaking) {
                 breaking++;
@@ -61,9 +63,6 @@ class DefaultVersioningStrategy {
                 features++;
             }
         }
-        if (customVersion) {
-            return new versioning_strategy_1.CustomVersionUpdate(customVersion.toString());
-        }
         if (breaking > 0) {
             if (version.major < 1 && this.bumpMinorPreMajor) {
                 return new versioning_strategy_1.MinorVersionUpdate();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "13.2.0",
+  "version": "13.3.2",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -41,7 +41,7 @@
     "@types/chai": "^4.1.7",
     "@types/iarna__toml": "^2.0.1",
     "@types/js-yaml": "^4.0.0",
-    "@types/mocha": "^8.0.0",
+    "@types/mocha": "^9.0.0",
     "@types/node": "^16.0.0",
     "@types/pino": "^7.0.0",
     "@types/semver": "^7.0.0",
@@ -51,7 +51,7 @@
     "chai": "^4.2.0",
     "cross-env": "^7.0.0",
     "gts": "^3.0.0",
-    "mocha": "^8.0.0",
+    "mocha": "^9.0.0",
     "nock": "^13.0.0",
     "sinon": "12.0.1",
     "snap-shot-it": "^7.0.0"