release-please 13.2.1 → 13.3.0

package/CHANGELOG.md

@@ -4,6 +4,18 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [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)
 
 

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/strategies/base.d.ts

@@ -81,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.

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,

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/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}`;
     }
 }

package/package.json

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