release-please 13.0.2 → 13.1.0

package/CHANGELOG.md

@@ -4,6 +4,13 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [13.1.0](https://www.github.com/googleapis/release-please/compare/v13.0.2...v13.1.0) (2021-12-29)
+
+
+### Features
+
+* introduce generic updater ([#1157](https://www.github.com/googleapis/release-please/issues/1157)) ([c97598c](https://www.github.com/googleapis/release-please/commit/c97598c137b5018c76f5d62137e277b991f4bfa3)), closes [#435](https://www.github.com/googleapis/release-please/issues/435) [#305](https://www.github.com/googleapis/release-please/issues/305) [#1139](https://www.github.com/googleapis/release-please/issues/1139) [#1174](https://www.github.com/googleapis/release-please/issues/1174)
+
 ### [13.0.2](https://www.github.com/googleapis/release-please/compare/v13.0.1...v13.0.2) (2021-12-29)
 
 

package/build/src/factory.js

@@ -68,6 +68,7 @@ const allReleaseTypes = [
 const releasers = {
     go: options => new go_1.Go(options),
     'go-yoshi': options => new go_yoshi_1.GoYoshi(options),
+    'java-yoshi': options => new java_yoshi_1.JavaYoshi(options),
     'krm-blueprint': options => new krm_blueprint_1.KRMBlueprint(options),
     node: options => new node_1.Node(options),
     ocaml: options => new ocaml_1.OCaml(options),
@@ -122,6 +123,7 @@ async function buildStrategy(options) {
         includeComponentInTag: options.includeComponentInTag,
         changelogNotes,
         pullRequestTitlePattern: options.pullRequestTitlePattern,
+        extraFiles: options.extraFiles,
     };
     switch (options.releaseType) {
         case 'ruby': {
@@ -136,23 +138,15 @@ async function buildStrategy(options) {
                 versionFile: options.versionFile,
             });
         }
-        case 'java-yoshi': {
-            return new java_yoshi_1.JavaYoshi({
-                ...strategyOptions,
-                extraFiles: options.extraFiles,
-            });
-        }
         case 'java-backport': {
             return new java_yoshi_1.JavaYoshi({
                 ...strategyOptions,
-                extraFiles: options.extraFiles,
                 versioningStrategy: new always_bump_patch_1.AlwaysBumpPatch(),
             });
         }
         case 'java-bom': {
             return new java_yoshi_1.JavaYoshi({
                 ...strategyOptions,
-                extraFiles: options.extraFiles,
                 versioningStrategy: new dependency_manifest_1.DependencyManifest({
                     bumpMinorPreMajor: options.bumpMinorPreMajor,
                     bumpPatchForMinorPreMajor: options.bumpPatchForMinorPreMajor,
@@ -162,7 +156,6 @@ async function buildStrategy(options) {
         case 'java-lts': {
             return new java_yoshi_1.JavaYoshi({
                 ...strategyOptions,
-                extraFiles: options.extraFiles,
                 versioningStrategy: new service_pack_1.ServicePackVersioningStrategy(),
             });
         }

package/build/src/plugins/merge.js

@@ -31,36 +31,18 @@ class Merge extends plugin_1.ManifestPlugin {
         if (candidates.length < 1) {
             return candidates;
         }
-        const updatesByPath = {};
         const releaseData = [];
         const labels = new Set();
+        let rawUpdates = [];
         for (const candidate of candidates) {
             const pullRequest = candidate.pullRequest;
-            for (const update of pullRequest.updates) {
-                if (updatesByPath[update.path]) {
-                    updatesByPath[update.path].push(update);
-                }
-                else {
-                    updatesByPath[update.path] = [update];
-                }
-            }
+            rawUpdates = rawUpdates.concat(...pullRequest.updates);
             for (const label of pullRequest.labels) {
                 labels.add(label);
             }
             releaseData.push(...pullRequest.body.releaseData);
         }
-        const updates = [];
-        for (const path in updatesByPath) {
-            const update = updatesByPath[path];
-            const updaters = update.map(u => u.updater);
-            updates.push({
-                path,
-                createIfMissing: update[0].createIfMissing,
-                updater: updaters.length === 1
-                    ? updaters[0]
-                    : new composite_1.CompositeUpdater(...updaters),
-            });
-        }
+        const updates = composite_1.mergeUpdates(rawUpdates);
         const pullRequest = {
             title: pull_request_title_1.PullRequestTitle.ofTargetBranch(this.targetBranch, manifest_1.MANIFEST_PULL_REQUEST_TITLE_PATTERN),
             body: new pull_request_body_1.PullRequestBody(releaseData),

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

@@ -36,6 +36,7 @@ export interface BaseStrategyOptions {
     changelogNotes?: ChangelogNotes;
     includeComponentInTag?: boolean;
     pullRequestTitlePattern?: string;
+    extraFiles?: string[];
 }
 /**
  * A strategy is responsible for determining which files are
@@ -55,6 +56,7 @@ export declare abstract class BaseStrategy implements Strategy {
     private releaseAs?;
     private includeComponentInTag;
     private pullRequestTitlePattern?;
+    readonly extraFiles: string[];
     readonly changelogNotes: ChangelogNotes;
     protected changelogSections?: ChangelogSection[];
     constructor(options: BaseStrategyOptions);
@@ -90,6 +92,7 @@ export declare abstract class BaseStrategy implements Strategy {
      *   open a pull request.
      */
     buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
+    private extraFileUpdates;
     protected changelogEmpty(changelogEntry: string): boolean;
     protected updateVersionsMap(versionsMap: VersionsMap, conventionalCommits: ConventionalCommit[]): Promise<VersionsMap>;
     protected buildNewVersion(conventionalCommits: ConventionalCommit[], latestRelease?: Release): Promise<Version>;

package/build/src/strategies/base.js

@@ -24,6 +24,8 @@ const logger_1 = require("../util/logger");
 const pull_request_title_1 = require("../util/pull-request-title");
 const branch_name_1 = require("../util/branch-name");
 const pull_request_body_1 = require("../util/pull-request-body");
+const composite_1 = require("../updaters/composite");
+const generic_1 = require("../updaters/generic");
 const DEFAULT_CHANGELOG_PATH = 'CHANGELOG.md';
 /**
  * A strategy is responsible for determining which files are
@@ -50,6 +52,7 @@ class BaseStrategy {
             options.changelogNotes || new default_2.DefaultChangelogNotes(options);
         this.includeComponentInTag = (_a = options.includeComponentInTag) !== null && _a !== void 0 ? _a : true;
         this.pullRequestTitlePattern = options.pullRequestTitlePattern;
+        this.extraFiles = options.extraFiles || [];
     }
     /**
      * Return the component for this strategy. This may be a computed field.
@@ -127,6 +130,7 @@ class BaseStrategy {
             versionsMap,
             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,
@@ -137,13 +141,23 @@ class BaseStrategy {
         return {
             title: pullRequestTitle,
             body: pullRequestBody,
-            updates,
+            updates: updatesWithExtras,
             labels,
             headRefName: branchName.toString(),
             version: newVersion,
             draft: draft !== null && draft !== void 0 ? draft : false,
         };
     }
+    extraFileUpdates(version) {
+        const genericUpdater = new generic_1.Generic({ version });
+        return this.extraFiles.map(path => {
+            return {
+                path,
+                createIfMissing: false,
+                updater: genericUpdater,
+            };
+        });
+    }
     changelogEmpty(changelogEntry) {
         return changelogEntry.split('\n').length <= 1;
     }

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

@@ -5,14 +5,10 @@ import { GitHubFileContents } from '../github';
 import { Commit, ConventionalCommit } from '../commit';
 import { Release } from '../release';
 import { ReleasePullRequest } from '../release-pull-request';
-interface JavaStrategyOptions extends BaseStrategyOptions {
-    extraFiles?: string[];
-}
 export declare class JavaYoshi extends BaseStrategy {
-    readonly extraFiles: string[];
     private versionsContent?;
     private snapshotVersioning;
-    constructor(options: JavaStrategyOptions);
+    constructor(options: BaseStrategyOptions);
     buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
     private buildSnapshotPullRequest;
     private needsSnapshot;
@@ -22,4 +18,3 @@ export declare class JavaYoshi extends BaseStrategy {
     protected updateVersionsMap(versionsMap: VersionsMap, conventionalCommits: ConventionalCommit[]): Promise<VersionsMap>;
     protected initialReleaseVersion(): Version;
 }
-export {};

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

@@ -49,7 +49,6 @@ class JavaYoshi extends base_1.BaseStrategy {
         const parentVersioningStrategy = options.versioningStrategy || new default_1.DefaultVersioningStrategy();
         options.versioningStrategy = new java_snapshot_1.JavaSnapshot(parentVersioningStrategy);
         super(options);
-        this.extraFiles = options.extraFiles || [];
         this.snapshotVersioning = new java_add_snapshot_1.JavaAddSnapshot(parentVersioningStrategy);
     }
     async buildReleasePullRequest(commits, latestRelease, draft, labels = []) {

package/build/src/updaters/composite.d.ts

@@ -1,10 +1,10 @@
-import { Updater } from '../update';
+import { Updater, Update } from '../update';
 /**
  * The CompositeUpdater chains 0...n updaters and updates
  * the content in order.
  */
 export declare class CompositeUpdater implements Updater {
-    updaters: Updater[];
+    readonly updaters: Updater[];
     /**
      * Instantiate a new CompositeUpdater
      * @param {Updater[]} updaters The updaters to chain together
@@ -17,3 +17,4 @@ export declare class CompositeUpdater implements Updater {
      */
     updateContent(content: string | undefined): string;
 }
+export declare function mergeUpdates(updates: Update[]): Update[];

package/build/src/updaters/composite.js

@@ -13,7 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CompositeUpdater = void 0;
+exports.mergeUpdates = exports.CompositeUpdater = void 0;
 /**
  * The CompositeUpdater chains 0...n updaters and updates
  * the content in order.
@@ -39,4 +39,27 @@ class CompositeUpdater {
     }
 }
 exports.CompositeUpdater = CompositeUpdater;
+function mergeUpdates(updates) {
+    const updatesByPath = {};
+    for (const update of updates) {
+        if (updatesByPath[update.path]) {
+            updatesByPath[update.path].push(update);
+        }
+        else {
+            updatesByPath[update.path] = [update];
+        }
+    }
+    const newUpdates = [];
+    for (const path in updatesByPath) {
+        const update = updatesByPath[path];
+        const updaters = update.map(u => u.updater);
+        newUpdates.push({
+            path,
+            createIfMissing: update[0].createIfMissing,
+            updater: updaters.length === 1 ? updaters[0] : new CompositeUpdater(...updaters),
+        });
+    }
+    return newUpdates;
+}
+exports.mergeUpdates = mergeUpdates;
 //# sourceMappingURL=composite.js.map

package/build/src/updaters/generic.d.ts

@@ -0,0 +1,32 @@
+import { DefaultUpdater } from './default';
+/**
+ * The Generic updater looks for well known patterns and replaces
+ * content. The well known patterns are:
+ *
+ * 1. `x-release-please-version` if this string is found on the line,
+ *    then replace a semver-looking string on that line with the next
+ *    version
+ * 2. `x-release-please-major` if this string is found on the line,
+ *    then replace an integer looking value with the the next version's
+ *    major
+ * 3. `x-release-please-minor` if this string is found on the line,
+ *    then replace an integer looking value with the the next version's
+ *    minor
+ * 4. `x-release-please-patch` if this string is found on the line,
+ *    then replace an integer looking value with the the next version's
+ *    patch
+ *
+ * You can also use a block-based replacement. Content between the
+ * opening `x-release-please-start-version` and `x-release-please-end` will
+ * be considered for version replacement. You can also open these blocks
+ * with `x-release-please-start-<major|minor|patch>` to replace single
+ * numbers
+ */
+export declare class Generic extends DefaultUpdater {
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content: string | undefined): string;
+}

package/build/src/updaters/generic.js

@@ -0,0 +1,110 @@
+"use strict";
+// Copyright 2021 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Generic = void 0;
+const default_1 = require("./default");
+const logger_1 = require("../util/logger");
+const VERSION_REGEX = /(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)(-(?<preRelease>[\w.]+))?(\+(?<build>[-\w.]+))?/;
+const SINGLE_VERSION_REGEX = /\b\d+\b/;
+const INLINE_UPDATE_REGEX = /x-release-please-(?<scope>major|minor|patch|version)/;
+const BLOCK_START_REGEX = /x-release-please-start-(?<scope>major|minor|patch|version)/;
+const BLOCK_END_REGEX = /x-release-please-end/;
+/**
+ * The Generic updater looks for well known patterns and replaces
+ * content. The well known patterns are:
+ *
+ * 1. `x-release-please-version` if this string is found on the line,
+ *    then replace a semver-looking string on that line with the next
+ *    version
+ * 2. `x-release-please-major` if this string is found on the line,
+ *    then replace an integer looking value with the the next version's
+ *    major
+ * 3. `x-release-please-minor` if this string is found on the line,
+ *    then replace an integer looking value with the the next version's
+ *    minor
+ * 4. `x-release-please-patch` if this string is found on the line,
+ *    then replace an integer looking value with the the next version's
+ *    patch
+ *
+ * You can also use a block-based replacement. Content between the
+ * opening `x-release-please-start-version` and `x-release-please-end` will
+ * be considered for version replacement. You can also open these blocks
+ * with `x-release-please-start-<major|minor|patch>` to replace single
+ * numbers
+ */
+class Generic extends default_1.DefaultUpdater {
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content) {
+        if (!content) {
+            return '';
+        }
+        const newLines = [];
+        let blockScope;
+        function replaceVersion(line, scope, version) {
+            switch (scope) {
+                case 'major':
+                    newLines.push(line.replace(SINGLE_VERSION_REGEX, `${version.major}`));
+                    return;
+                case 'minor':
+                    newLines.push(line.replace(SINGLE_VERSION_REGEX, `${version.minor}`));
+                    return;
+                case 'patch':
+                    newLines.push(line.replace(SINGLE_VERSION_REGEX, `${version.patch}`));
+                    return;
+                case 'version':
+                    newLines.push(line.replace(VERSION_REGEX, version.toString()));
+                    return;
+                default:
+                    logger_1.logger.warn(`unknown block scope: ${scope}`);
+                    newLines.push(line);
+            }
+        }
+        content.split(/\r?\n/).forEach(line => {
+            var _a, _b;
+            let match = line.match(INLINE_UPDATE_REGEX);
+            if (match) {
+                // replace inline versions
+                replaceVersion(line, (((_a = match.groups) === null || _a === void 0 ? void 0 : _a.scope) || 'version'), this.version);
+            }
+            else if (blockScope) {
+                // in a block, so try to replace versions
+                replaceVersion(line, blockScope, this.version);
+                if (line.match(BLOCK_END_REGEX)) {
+                    blockScope = undefined;
+                }
+            }
+            else {
+                // look for block start line
+                match = line.match(BLOCK_START_REGEX);
+                if (match) {
+                    if ((_b = match.groups) === null || _b === void 0 ? void 0 : _b.scope) {
+                        blockScope = match.groups.scope;
+                    }
+                    else {
+                        blockScope = 'version';
+                    }
+                }
+                newLines.push(line);
+            }
+        });
+        return newLines.join('\n');
+    }
+}
+exports.Generic = Generic;
+//# sourceMappingURL=generic.js.map

package/package.json

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