release-please
Version:
generate release PRs based on the conventionalcommits.org spec
99 lines • 4.3 kB
JavaScript
;
// 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.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
* significant changes should bump the patch version.
*/
class DefaultVersioningStrategy {
/**
* Create a new DefaultVersioningStrategy
* @param {DefaultVersioningStrategyOptions} options Configuration options
* @param {boolean} options.bumpMinorPreMajor If the current version is less than 1.0.0,
* then bump the minor version for breaking changes
* @param {boolean} options.bumpPatchForMinorPreMajor If the current version is less than
* 1.0.0, then bump the patch version for features
*/
constructor(options = {}) {
var _a;
this.bumpMinorPreMajor = options.bumpMinorPreMajor === true;
this.bumpPatchForMinorPreMajor = options.bumpPatchForMinorPreMajor === true;
this.logger = (_a = options.logger) !== null && _a !== void 0 ? _a : logger_1.logger;
}
/**
* Given the current version of an artifact and a list of commits,
* return a VersionUpdater that knows how to bump the version.
*
* This is useful for chaining together versioning strategies.
*
* @param {Version} version The current version
* @param {ConventionalCommit[]} commits The list of commits to consider
* @returns {VersionUpdater} Updater for bumping the next version.
*/
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.isPreMajor && this.bumpMinorPreMajor) {
return new versioning_strategy_1.MinorVersionUpdate();
}
else {
return new versioning_strategy_1.MajorVersionUpdate();
}
}
else if (features > 0) {
if (version.isPreMajor && this.bumpPatchForMinorPreMajor) {
return new versioning_strategy_1.PatchVersionUpdate();
}
else {
return new versioning_strategy_1.MinorVersionUpdate();
}
}
return new versioning_strategy_1.PatchVersionUpdate();
}
/**
* Given the current version of an artifact and a list of commits,
* return the next version.
*
* @param {Version} version The current version
* @param {ConventionalCommit[]} commits The list of commits to consider
* @returns {Version} The next version
*/
bump(version, commits) {
return this.determineReleaseType(version, commits).bump(version);
}
}
exports.DefaultVersioningStrategy = DefaultVersioningStrategy;
//# sourceMappingURL=default.js.map