release-please 14.17.5 → 15.1.0

package/CHANGELOG.md

@@ -4,6 +4,35 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [15.1.0](https://github.com/googleapis/release-please/compare/v15.0.0...v15.1.0) (2023-01-05)
+
+
+### Features
+
+* **ruby:** Add Gemfile.Lock updater ([#1790](https://github.com/googleapis/release-please/issues/1790)) ([9baf736](https://github.com/googleapis/release-please/commit/9baf736aa424bf3dcf0f05009e5cf8c9ef05fd69))
+
+
+### Bug Fixes
+
+* **java-yoshi:** Throw MissingRequiredFile error if no versions.txt found ([#1794](https://github.com/googleapis/release-please/issues/1794)) ([542d412](https://github.com/googleapis/release-please/commit/542d412307ea8d6350908aeb7efaf9db9e3d03f9))
+
+## [15.0.0](https://github.com/googleapis/release-please/compare/v14.17.5...v15.0.0) (2022-12-12)
+
+
+### ⚠ BREAKING CHANGES
+
+* Strategies can parse multiple releases from single release PR ([#1775](https://github.com/googleapis/release-please/issues/1775))
+* Parse conventional commits in manifest ([#1772](https://github.com/googleapis/release-please/issues/1772))
+
+### Features
+
+* Strategies can parse multiple releases from single release PR ([#1775](https://github.com/googleapis/release-please/issues/1775)) ([b565f85](https://github.com/googleapis/release-please/commit/b565f85b64a431be1d62f8e682c183c4c1f1c631))
+
+
+### Code Refactoring
+
+* Parse conventional commits in manifest ([#1772](https://github.com/googleapis/release-please/issues/1772)) ([3391d3b](https://github.com/googleapis/release-please/commit/3391d3bc916ad07102bbb3873b93aeac6e13977c))
+
 ## [14.17.5](https://github.com/googleapis/release-please/compare/v14.17.4...v14.17.5) (2022-12-08)
 
 

package/build/src/manifest.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Manifest = exports.MANIFEST_PULL_REQUEST_TITLE_PATTERN = exports.SNOOZE_LABEL = exports.DEFAULT_SNAPSHOT_LABELS = exports.DEFAULT_RELEASE_LABELS = exports.DEFAULT_LABELS = exports.DEFAULT_COMPONENT_NAME = exports.ROOT_PROJECT_PATH = exports.DEFAULT_RELEASE_PLEASE_MANIFEST = exports.DEFAULT_RELEASE_PLEASE_CONFIG = void 0;
 const version_1 = require("./version");
+const commit_1 = require("./commit");
 const logger_1 = require("./util/logger");
 const commit_split_1 = require("./util/commit-split");
 const tag_name_1 = require("./util/tag-name");
@@ -329,7 +330,7 @@ class Manifest {
             this.logger.info(`Building candidate release pull request for path: ${path}`);
             this.logger.debug(`type: ${config.releaseType}`);
             this.logger.debug(`targetBranch: ${this.targetBranch}`);
-            let pathCommits = commitsPerPath[path];
+            let pathCommits = (0, commit_1.parseConventionalCommits)(commitsPerPath[path], this.logger);
             // The processCommits hook can be implemented by plugins to
             // post-process commits. This can be used to perform cleanup, e.g,, sentence
             // casing all commit messages:
@@ -579,7 +580,7 @@ class Manifest {
         const strategiesByPath = await this.getStrategiesByPath();
         // Find merged release pull requests
         const generator = await this.findMergedReleasePullRequests();
-        const releases = [];
+        const candidateReleases = [];
         for await (const pullRequest of generator) {
             for (const path in this.repositoryConfig) {
                 const config = this.repositoryConfig[path];
@@ -587,11 +588,11 @@ class Manifest {
                 this.logger.debug(`type: ${config.releaseType}`);
                 this.logger.debug(`targetBranch: ${this.targetBranch}`);
                 const strategy = strategiesByPath[path];
-                const release = await strategy.buildRelease(pullRequest, {
+                const releases = await strategy.buildReleases(pullRequest, {
                     groupPullRequestTitlePattern: this.groupPullRequestTitlePattern,
                 });
-                if (release) {
-                    releases.push({
+                for (const release of releases) {
+                    candidateReleases.push({
                         ...release,
                         path,
                         pullRequest,
@@ -601,12 +602,9 @@ class Manifest {
                                 release.tag.version.major === 0),
                     });
                 }
-                else {
-                    this.logger.info(`No release necessary for path: ${path}`);
-                }
             }
         }
-        return releases;
+        return candidateReleases;
     }
     /**
      * Find merged, untagged releases. For each release, create a GitHub release,

package/build/src/plugin.d.ts

@@ -1,7 +1,7 @@
 import { GitHub } from './github';
 import { CandidateReleasePullRequest, RepositoryConfig } from './manifest';
 import { Strategy } from './strategy';
-import { Commit } from './commit';
+import { Commit, ConventionalCommit } from './commit';
 import { Release } from './release';
 import { Logger } from './util/logger';
 /**
@@ -21,7 +21,7 @@ export declare abstract class ManifestPlugin {
      * @param {Commit[]} commits The set of commits that will feed into release pull request.
      * @returns {Commit[]} The modified commit objects.
      */
-    processCommits(commits: Commit[]): Commit[];
+    processCommits(commits: ConventionalCommit[]): ConventionalCommit[];
     /**
      * Post-process candidate pull requests.
      * @param {CandidateReleasePullRequest[]} pullRequests Candidate pull requests

package/build/src/plugin.js

@@ -33,8 +33,6 @@ class ManifestPlugin {
      * @param {Commit[]} commits The set of commits that will feed into release pull request.
      * @returns {Commit[]} The modified commit objects.
      */
-    // TODO: for next major version, let's run the default conventional commit parser earlier
-    // (outside of the strategy classes) and pass in the ConventionalCommit[] objects in.
     processCommits(commits) {
         return commits;
     }

package/build/src/plugins/linked-versions.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LinkedVersions = void 0;
 const plugin_1 = require("../plugin");
+const commit_1 = require("../commit");
 const factory_1 = require("../factory");
 const merge_1 = require("./merge");
 /**
@@ -55,7 +56,7 @@ class LinkedVersions extends plugin_1.ManifestPlugin {
         for (const path in groupStrategies) {
             const strategy = groupStrategies[path];
             const latestRelease = releasesByPath[path];
-            const releasePullRequest = await strategy.buildReleasePullRequest(commitsByPath[path], latestRelease);
+            const releasePullRequest = await strategy.buildReleasePullRequest((0, commit_1.parseConventionalCommits)(commitsByPath[path], this.logger), latestRelease);
             if (releasePullRequest === null || releasePullRequest === void 0 ? void 0 : releasePullRequest.version) {
                 groupVersions[path] = releasePullRequest.version;
             }

package/build/src/plugins/sentence-case.d.ts

@@ -1,7 +1,7 @@
 import { ManifestPlugin } from '../plugin';
 import { GitHub } from '../github';
 import { RepositoryConfig } from '../manifest';
-import { Commit } from '../commit';
+import { ConventionalCommit } from '../commit';
 /**
  * This plugin converts commit messages to sentence case, for the benefit
  * of the generated CHANGELOG.
@@ -14,6 +14,6 @@ export declare class SentenceCase extends ManifestPlugin {
      * @param {Commit[]} commits The set of commits that will feed into release pull request.
      * @returns {Commit[]} The modified commit objects.
      */
-    processCommits(commits: Commit[]): Commit[];
+    processCommits(commits: ConventionalCommit[]): ConventionalCommit[];
     toUpperCase(word: string): string;
 }

package/build/src/plugins/sentence-case.js

@@ -34,6 +34,9 @@ class SentenceCase extends plugin_1.ManifestPlugin {
     processCommits(commits) {
         this.logger.info(`SentenceCase processing ${commits.length} commits`);
         for (const commit of commits) {
+            // The parsed conventional commit message, without the type:
+            console.info(commit.bareMessage);
+            commit.bareMessage = this.toUpperCase(commit.bareMessage);
             // Check whether commit is in conventional commit format, if it is
             // we'll split the string by type and description:
             if (commit.message.includes(':')) {

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

@@ -112,7 +112,7 @@ export declare abstract class BaseStrategy implements Strategy {
      *   open for this path/component. Returns undefined if we should not
      *   open a pull request.
      */
-    buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
+    buildReleasePullRequest(commits: ConventionalCommit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
     private extraFilePaths;
     protected extraFileUpdates(version: Version, versionsMap: VersionsMap): Promise<Update[]>;
     protected changelogEmpty(changelogEntry: string): boolean;
@@ -124,8 +124,15 @@ export declare abstract class BaseStrategy implements Strategy {
      * Given a merged pull request, build the candidate release.
      * @param {PullRequest} mergedPullRequest The merged release pull request.
      * @returns {Release} The candidate release.
+     * @deprecated Use buildReleases() instead.
      */
     buildRelease(mergedPullRequest: PullRequest, options?: BuildReleaseOptions): Promise<Release | undefined>;
+    /**
+     * Given a merged pull request, build the candidate releases.
+     * @param {PullRequest} mergedPullRequest The merged release pull request.
+     * @returns {Release} The candidate release.
+     */
+    buildReleases(mergedPullRequest: PullRequest, options?: BuildReleaseOptions): Promise<Release[]>;
     isPublishedVersion(_version: Version): boolean;
     /**
      * Override this to handle the initial version of a new library.

package/build/src/strategies/base.js

@@ -17,7 +17,6 @@ exports.BaseStrategy = void 0;
 const manifest_1 = require("../manifest");
 const default_1 = require("../versioning-strategies/default");
 const default_2 = require("../changelog-notes/default");
-const commit_1 = require("../commit");
 const version_1 = require("../version");
 const tag_name_1 = require("../util/tag-name");
 const logger_1 = require("../util/logger");
@@ -139,7 +138,7 @@ class BaseStrategy {
      *   open a pull request.
      */
     async buildReleasePullRequest(commits, latestRelease, draft, labels = []) {
-        const conventionalCommits = await this.postProcessCommits((0, commit_1.parseConventionalCommits)(commits, this.logger));
+        const conventionalCommits = await this.postProcessCommits(commits);
         this.logger.info(`Considering: ${conventionalCommits.length} commits`);
         if (conventionalCommits.length === 0) {
             this.logger.info(`No commits for path: ${this.path}, skipping`);
@@ -287,6 +286,7 @@ class BaseStrategy {
      * Given a merged pull request, build the candidate release.
      * @param {PullRequest} mergedPullRequest The merged release pull request.
      * @returns {Release} The candidate release.
+     * @deprecated Use buildReleases() instead.
      */
     async buildRelease(mergedPullRequest, options) {
         var _a;
@@ -365,6 +365,18 @@ class BaseStrategy {
             sha: mergedPullRequest.sha,
         };
     }
+    /**
+     * Given a merged pull request, build the candidate releases.
+     * @param {PullRequest} mergedPullRequest The merged release pull request.
+     * @returns {Release} The candidate release.
+     */
+    async buildReleases(mergedPullRequest, options) {
+        const release = await this.buildRelease(mergedPullRequest, options);
+        if (release) {
+            return [release];
+        }
+        return [];
+    }
     isPublishedVersion(_version) {
         return true;
     }

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

@@ -57,7 +57,7 @@ class JavaYoshi extends java_1.Java {
                 this.versionsContent = await this.github.getFileContentsOnBranch(this.addPath('versions.txt'), this.targetBranch);
             }
             catch (err) {
-                if (err instanceof errors_1.GitHubAPIError) {
+                if (err instanceof errors_1.FileNotFoundError) {
                     throw new errors_1.MissingRequiredFileError(this.addPath('versions.txt'), JavaYoshi.name, `${this.repository.owner}/${this.repository.repo}`);
                 }
                 throw err;

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

@@ -1,7 +1,7 @@
 import { Update } from '../update';
 import { Version } from '../version';
 import { BaseStrategy, BaseStrategyOptions, BuildUpdatesOptions } from './base';
-import { Commit } from '../commit';
+import { ConventionalCommit } from '../commit';
 import { Release } from '../release';
 import { ReleasePullRequest } from '../release-pull-request';
 import { VersioningStrategy } from '../versioning-strategy';
@@ -18,9 +18,9 @@ export declare class Java extends BaseStrategy {
     protected readonly snapshotLabels: string[];
     readonly skipSnapshot: boolean;
     constructor(options: BaseStrategyOptions);
-    buildReleasePullRequest(commits: Commit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
+    buildReleasePullRequest(commits: ConventionalCommit[], latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest | undefined>;
     protected buildSnapshotPullRequest(latestRelease?: Release, draft?: boolean, labels?: string[]): Promise<ReleasePullRequest>;
     isPublishedVersion(version: Version): boolean;
-    protected needsSnapshot(commits: Commit[], latestRelease?: Release): Promise<boolean>;
+    protected needsSnapshot(commits: ConventionalCommit[], latestRelease?: Release): Promise<boolean>;
     protected buildUpdates(options: JavaBuildUpdatesOption): Promise<Update[]>;
 }

package/build/src/strategies/ruby.js

@@ -19,6 +19,7 @@ const indent_commit_1 = require("../util/indent-commit");
 const changelog_1 = require("../updaters/changelog");
 // Ruby
 const version_rb_1 = require("../updaters/ruby/version-rb");
+const gemfile_lock_1 = require("../updaters/ruby/gemfile-lock");
 const base_1 = require("./base");
 class Ruby extends base_1.BaseStrategy {
     constructor(options) {
@@ -48,6 +49,14 @@ class Ruby extends base_1.BaseStrategy {
                 version,
             }),
         });
+        updates.push({
+            path: this.addPath('Gemfile.lock'),
+            createIfMissing: false,
+            updater: new gemfile_lock_1.GemfileLock({
+                version,
+                gemName: this.component || '',
+            }),
+        });
         return updates;
     }
     async postProcessCommits(commits) {

package/build/src/strategy.d.ts

@@ -32,8 +32,15 @@ export interface Strategy {
      * Given a merged pull request, build the candidate release.
      * @param {PullRequest} mergedPullRequest The merged release pull request.
      * @returns {Release} The candidate release.
+     * @deprecated Use buildReleases() instead.
      */
     buildRelease(mergedPullRequest: PullRequest, options?: BuildReleaseOptions): Promise<Release | undefined>;
+    /**
+     * Given a merged pull request, build the candidate releases.
+     * @param {PullRequest} mergedPullRequest The merged release pull request.
+     * @returns {Release} The candidate release.
+     */
+    buildReleases(mergedPullRequest: PullRequest, options?: BuildReleaseOptions): Promise<Release[]>;
     /**
      * Return the component for this strategy. This may be a computed field.
      * @returns {string}

package/build/src/updaters/ruby/common.d.ts

@@ -0,0 +1,17 @@
+import { Version } from '../../version';
+export declare const RUBY_VERSION_REGEX: RegExp;
+/**
+ * Stringify a version to a ruby compatible version string
+ *
+ * @param version The version to stringify
+ * @param useDotPrePreleaseSeperator Use a `.` seperator for prereleases rather then `-`
+ * @returns a ruby compatible version string
+ */
+export declare function stringifyRubyVersion(version: Version, useDotPrePreleaseSeperator?: boolean): string;
+/**
+ * This function mimics Gem::Version parsing of version semver strings
+ *
+ * @param versionString The version string to resolve
+ * @returns A Gem::Version compatible version string
+ */
+export declare function resolveRubyGemfileLockVersion(versionString: string): string;

package/build/src/updaters/ruby/common.js

@@ -0,0 +1,46 @@
+"use strict";
+// Copyright 2022 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.resolveRubyGemfileLockVersion = exports.stringifyRubyVersion = exports.RUBY_VERSION_REGEX = void 0;
+// Ruby gem semver strings using `.` seperator for prereleases rather then `-`
+// See https://guides.rubygems.org/patterns/
+exports.RUBY_VERSION_REGEX = /((\d+).(\d)+.(\d+)(.\w+.*)?)/g;
+/**
+ * Stringify a version to a ruby compatible version string
+ *
+ * @param version The version to stringify
+ * @param useDotPrePreleaseSeperator Use a `.` seperator for prereleases rather then `-`
+ * @returns a ruby compatible version string
+ */
+function stringifyRubyVersion(version, useDotPrePreleaseSeperator = false) {
+    if (!useDotPrePreleaseSeperator) {
+        return version.toString();
+    }
+    return `${version.major}.${version.minor}.${version.patch}${version.preRelease ? `.${version.preRelease}` : ''}`;
+}
+exports.stringifyRubyVersion = stringifyRubyVersion;
+/**
+ * This function mimics Gem::Version parsing of version semver strings
+ *
+ * @param versionString The version string to resolve
+ * @returns A Gem::Version compatible version string
+ */
+function resolveRubyGemfileLockVersion(versionString) {
+    // Replace `-` with `.pre.` as per ruby gem parsing
+    // See https://github.com/rubygems/rubygems/blob/master/lib/rubygems/version.rb#L229
+    return versionString.replace(/-/g, '.pre.');
+}
+exports.resolveRubyGemfileLockVersion = resolveRubyGemfileLockVersion;
+//# sourceMappingURL=common.js.map

package/build/src/updaters/ruby/gemfile-lock.d.ts

@@ -0,0 +1,24 @@
+import { DefaultUpdater, UpdateOptions } from '../default';
+export interface GemfileLockOptions extends UpdateOptions {
+    gemName: string;
+}
+/**
+ * Builds a regex matching a gem version in a Gemfile.lock file.
+ * @example
+ *    rails (7.0.1)
+ *    rails (7.0.1.alpha1)
+ */
+export declare function buildGemfileLockVersionRegex(gemName: string): RegExp;
+/**
+ * Updates a Gemfile.lock files which is expected to have a local path version string.
+ */
+export declare class GemfileLock extends DefaultUpdater {
+    gemName: string;
+    constructor(options: GemfileLockOptions);
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content: string): string;
+}

package/build/src/updaters/ruby/gemfile-lock.js

@@ -0,0 +1,50 @@
+"use strict";
+// Copyright 2022 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.GemfileLock = exports.buildGemfileLockVersionRegex = void 0;
+const default_1 = require("../default");
+const common_1 = require("./common");
+/**
+ * Builds a regex matching a gem version in a Gemfile.lock file.
+ * @example
+ *    rails (7.0.1)
+ *    rails (7.0.1.alpha1)
+ */
+function buildGemfileLockVersionRegex(gemName) {
+    return new RegExp(`s*${gemName} \\(${common_1.RUBY_VERSION_REGEX.source}\\)`);
+}
+exports.buildGemfileLockVersionRegex = buildGemfileLockVersionRegex;
+/**
+ * Updates a Gemfile.lock files which is expected to have a local path version string.
+ */
+class GemfileLock extends default_1.DefaultUpdater {
+    constructor(options) {
+        super(options);
+        this.gemName = options.gemName;
+    }
+    /**
+     * Given initial file contents, return updated contents.
+     * @param {string} content The initial content
+     * @returns {string} The updated content
+     */
+    updateContent(content) {
+        // Bundler will convert 1.0.0-alpha1 to 1.0.0.pre.alpha1, so we need to
+        // do the same here.
+        const versionString = (0, common_1.resolveRubyGemfileLockVersion)(this.version.toString());
+        return content.replace(buildGemfileLockVersionRegex(this.gemName), `${this.gemName} (${versionString})`);
+    }
+}
+exports.GemfileLock = GemfileLock;
+//# sourceMappingURL=gemfile-lock.js.map

package/build/src/updaters/ruby/version-rb.js

@@ -15,6 +15,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VersionRB = void 0;
 const default_1 = require("../default");
+const common_1 = require("./common");
+const RUBY_VERSION_RB_REGEX = new RegExp(`(["'])(${common_1.RUBY_VERSION_REGEX.source})(["'])`);
 /**
  * Updates a versions.rb file which is expected to have a version string.
  */
@@ -25,7 +27,7 @@ class VersionRB extends default_1.DefaultUpdater {
      * @returns {string} The updated content
      */
     updateContent(content) {
-        return content.replace(/(["'])[0-9]+\.[0-9]+\.[0-9]+(-\w+)?["']/, `$1${this.version}$1`);
+        return content.replace(RUBY_VERSION_RB_REGEX, `$1${(0, common_1.stringifyRubyVersion)(this.version)}$1`);
     }
 }
 exports.VersionRB = VersionRB;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "14.17.5",
+  "version": "15.1.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -63,7 +63,7 @@
     "gts": "^3.1.0",
     "mocha": "^9.2.2",
     "nock": "^13.0.0",
-    "sinon": "15.0.0",
+    "sinon": "15.0.1",
     "snap-shot-it": "^7.0.0"
   },
   "dependencies": {