release-please 15.11.1 → 15.12.0

package/CHANGELOG.md

@@ -4,6 +4,21 @@
 
 [1]: https://www.npmjs.com/package/release-please?activeTab=versions
 
+## [15.12.0](https://github.com/googleapis/release-please/compare/v15.11.2...v15.12.0) (2023-07-11)
+
+
+### Features
+
+* Add PrereleaseVersioningStrategy ([#1981](https://github.com/googleapis/release-please/issues/1981)) ([b070888](https://github.com/googleapis/release-please/commit/b070888f25eff6e28c25014bcf67d6f9d47b9717))
+
+## [15.11.2](https://github.com/googleapis/release-please/compare/v15.11.1...v15.11.2) (2023-07-10)
+
+
+### Bug Fixes
+
+* **deps:** Update dependency conventional-changelog-conventionalcommits to v6 ([#1974](https://github.com/googleapis/release-please/issues/1974)) ([1998564](https://github.com/googleapis/release-please/commit/1998564555c472f4eb850cdcec99a009dd76f8ca))
+* **deps:** Update dependency conventional-changelog-writer to v6 ([#1975](https://github.com/googleapis/release-please/issues/1975)) ([a6aa293](https://github.com/googleapis/release-please/commit/a6aa293932200dd004024b8c8f6b458c2fa8f570))
+
 ## [15.11.1](https://github.com/googleapis/release-please/compare/v15.11.0...v15.11.1) (2023-07-10)
 
 

package/README.md

@@ -187,7 +187,7 @@ Release Please automates releases for the following flavors of repositories:
 | `php`               | A repository with a composer.json and a CHANGELOG.md |
 | `python`            | [A Python repository, with a setup.py, setup.cfg, CHANGELOG.md](https://github.com/googleapis/python-storage) and optionally a pyproject.toml and a <project>/\_\_init\_\_.py |
 | `ruby`              | A repository with a version.rb and a CHANGELOG.md |
-| `rust`              | A Rust repository, with a Cargo.toml (either as a crate or workspace) and a CHANGELOG.md |
+| `rust`              | A Rust repository, with a Cargo.toml (either as a crate or workspace, although note that workspaces require a [manifest driven release](https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md) and the "cargo-workspace" plugin) and a CHANGELOG.md |
 | `sfdx`              | A repository with a [sfdx-project.json](https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm) and a CHANGELOG.md |
 | `simple`            | [A repository with a version.txt and a CHANGELOG.md](https://github.com/googleapis/gapic-generator) |
 | `terraform-module`  | [A terraform module, with a version in the README.md, and a CHANGELOG.md](https://github.com/terraform-google-modules/terraform-google-project-factory) |

package/build/src/factories/versioning-strategy-factory.js

@@ -20,12 +20,14 @@ const always_bump_minor_1 = require("../versioning-strategies/always-bump-minor"
 const always_bump_major_1 = require("../versioning-strategies/always-bump-major");
 const service_pack_1 = require("../versioning-strategies/service-pack");
 const errors_1 = require("../errors");
+const prerelease_1 = require("../versioning-strategies/prerelease");
 const versioningTypes = {
     default: options => new default_1.DefaultVersioningStrategy(options),
     'always-bump-patch': options => new always_bump_patch_1.AlwaysBumpPatch(options),
     'always-bump-minor': options => new always_bump_minor_1.AlwaysBumpMinor(options),
     'always-bump-major': options => new always_bump_major_1.AlwaysBumpMajor(options),
     'service-pack': options => new service_pack_1.ServicePackVersioningStrategy(options),
+    prerelease: options => new prerelease_1.PrereleaseVersioningStrategy(options),
 };
 function buildVersioningStrategy(options) {
     const builder = versioningTypes[options.type || 'default'];

package/build/src/versioning-strategies/prerelease.d.ts

@@ -0,0 +1,12 @@
+import { DefaultVersioningStrategy } from './default';
+import { Version } from '../version';
+import { ConventionalCommit } from '..';
+import { VersionUpdater } from '../versioning-strategy';
+/**
+ * This versioning strategy will increment the pre-release number for patch
+ * bumps if there is a pre-release number (preserving any leading 0s).
+ * Example: 1.2.3-beta01 -> 1.2.3-beta02.
+ */
+export declare class PrereleaseVersioningStrategy extends DefaultVersioningStrategy {
+    determineReleaseType(version: Version, commits: ConventionalCommit[]): VersionUpdater;
+}

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

@@ -0,0 +1,148 @@
+"use strict";
+// Copyright 2023 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.PrereleaseVersioningStrategy = void 0;
+const default_1 = require("./default");
+const version_1 = require("../version");
+const versioning_strategy_1 = require("../versioning-strategy");
+const PRERELEASE_PATTERN = /^(?<type>[a-z]+)(?<number>\d+)$/;
+class PrereleasePatchVersionUpdate {
+    /**
+     * Returns the new bumped version
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
+    bump(version) {
+        if (version.preRelease) {
+            const match = version.preRelease.match(PRERELEASE_PATTERN);
+            if (match === null || match === void 0 ? void 0 : match.groups) {
+                const numberLength = match.groups.number.length;
+                const nextPrereleaseNumber = Number(match.groups.number) + 1;
+                const paddedNextPrereleaseNumber = `${nextPrereleaseNumber}`.padStart(numberLength, '0');
+                const nextPrerelease = `${match.groups.type}${paddedNextPrereleaseNumber}`;
+                return new version_1.Version(version.major, version.minor, version.patch, nextPrerelease, version.build);
+            }
+        }
+        return new version_1.Version(version.major, version.minor, version.patch + 1, version.preRelease, version.build);
+    }
+}
+class PrereleaseMinorVersionUpdate {
+    /**
+     * Returns the new bumped version
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
+    bump(version) {
+        if (version.preRelease) {
+            const match = version.preRelease.match(PRERELEASE_PATTERN);
+            if (match === null || match === void 0 ? void 0 : match.groups) {
+                const numberLength = match.groups.number.length;
+                const prereleaseNumber = Number(match.groups.number);
+                let nextPrereleaseNumber = 1;
+                let nextMinorNumber = version.minor + 1;
+                let nextPatchNumber = 0;
+                if (version.patch === 0) {
+                    // this is already the next minor candidate, then bump the pre-release number
+                    nextPrereleaseNumber = prereleaseNumber + 1;
+                    nextMinorNumber = version.minor;
+                    nextPatchNumber = version.patch;
+                }
+                const paddedNextPrereleaseNumber = `${nextPrereleaseNumber}`.padStart(numberLength, '0');
+                const nextPrerelease = `${match.groups.type}${paddedNextPrereleaseNumber}`;
+                return new version_1.Version(version.major, nextMinorNumber, nextPatchNumber, nextPrerelease, version.build);
+            }
+        }
+        return new version_1.Version(version.major, version.minor + 1, 0, version.preRelease, version.build);
+    }
+}
+class PrereleaseMajorVersionUpdate {
+    /**
+     * Returns the new bumped version
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
+    bump(version) {
+        if (version.preRelease) {
+            const match = version.preRelease.match(PRERELEASE_PATTERN);
+            if (match === null || match === void 0 ? void 0 : match.groups) {
+                const numberLength = match.groups.number.length;
+                const prereleaseNumber = Number(match.groups.number);
+                let nextPrereleaseNumber = 1;
+                let nextMajorNumber = version.major + 1;
+                let nextMinorNumber = 0;
+                let nextPatchNumber = 0;
+                if (version.patch === 0 && version.minor === 0) {
+                    // this is already the next major candidate, then bump the pre-release number
+                    nextPrereleaseNumber = prereleaseNumber + 1;
+                    nextMajorNumber = version.major;
+                    nextMinorNumber = version.minor;
+                    nextPatchNumber = version.patch;
+                }
+                const paddedNextPrereleaseNumber = `${nextPrereleaseNumber}`.padStart(numberLength, '0');
+                const nextPrerelease = `${match.groups.type}${paddedNextPrereleaseNumber}`;
+                return new version_1.Version(nextMajorNumber, nextMinorNumber, nextPatchNumber, nextPrerelease, version.build);
+            }
+        }
+        return new version_1.Version(version.major + 1, 0, 0, version.preRelease, version.build);
+    }
+}
+/**
+ * This versioning strategy will increment the pre-release number for patch
+ * bumps if there is a pre-release number (preserving any leading 0s).
+ * Example: 1.2.3-beta01 -> 1.2.3-beta02.
+ */
+class PrereleaseVersioningStrategy extends default_1.DefaultVersioningStrategy {
+    determineReleaseType(version, commits) {
+        // iterate through list of commits and find biggest commit type
+        let breaking = 0;
+        let features = 0;
+        for (const commit of commits) {
+            const releaseAs = commit.notes.find(note => note.title === 'RELEASE AS');
+            if (releaseAs) {
+                // commits are handled newest to oldest, so take the first one (newest) found
+                this.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++;
+            }
+            else if (commit.type === 'feat' || commit.type === 'feature') {
+                features++;
+            }
+        }
+        if (breaking > 0) {
+            if (version.major < 1 && this.bumpMinorPreMajor) {
+                return new PrereleaseMinorVersionUpdate();
+            }
+            else {
+                return new PrereleaseMajorVersionUpdate();
+            }
+        }
+        else if (features > 0) {
+            if (version.major < 1 && this.bumpPatchForMinorPreMajor) {
+                return new PrereleasePatchVersionUpdate();
+            }
+            else {
+                return new PrereleaseMinorVersionUpdate();
+            }
+        }
+        return new PrereleasePatchVersionUpdate();
+    }
+}
+exports.PrereleaseVersioningStrategy = PrereleaseVersioningStrategy;
+//# sourceMappingURL=prerelease.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "15.11.1",
+  "version": "15.12.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -57,7 +57,7 @@
     "@types/yargs": "^17.0.0",
     "ajv": "^8.11.0",
     "ajv-formats": "^2.1.1",
-    "c8": "^7.0.0",
+    "c8": "^8.0.0",
     "chai": "^4.2.0",
     "cross-env": "^7.0.0",
     "gts": "^3.1.0",
@@ -82,8 +82,8 @@
     "@xmldom/xmldom": "^0.8.4",
     "chalk": "^4.0.0",
     "code-suggester": "^4.2.0",
-    "conventional-changelog-conventionalcommits": "^5.0.0",
-    "conventional-changelog-writer": "^5.0.0",
+    "conventional-changelog-conventionalcommits": "^6.0.0",
+    "conventional-changelog-writer": "^6.0.0",
     "conventional-commits-filter": "^3.0.0",
     "detect-indent": "^6.1.0",
     "diff": "^5.0.0",