release-please 13.0.0-candidate.5 → 13.0.0

package/build/src/versioning-strategy.d.ts

@@ -1,28 +1,90 @@
 import { Version } from './version';
 import { ConventionalCommit } from './commit';
+/**
+ * An interface for updating a version.
+ */
 export interface VersionUpdater {
+    /**
+     * Returns the new bumped version
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
     bump(version: Version): Version;
-    name: string;
 }
+/**
+ * This VersionUpdater performs a SemVer major version bump.
+ */
 export declare class MajorVersionUpdate implements VersionUpdater {
-    name: string;
+    /**
+     * Returns the new bumped version
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
     bump(version: Version): Version;
 }
+/**
+ * This VersionUpdater performs a SemVer minor version bump.
+ */
 export declare class MinorVersionUpdate implements VersionUpdater {
-    name: string;
+    /**
+     * Returns the new bumped version
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
     bump(version: Version): Version;
 }
+/**
+ * This VersionUpdater performs a SemVer patch version bump.
+ */
 export declare class PatchVersionUpdate implements VersionUpdater {
-    name: string;
+    /**
+     * Returns the new bumped version
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
     bump(version: Version): Version;
 }
+/**
+ * This VersionUpdater sets the version to a specific version.
+ */
 export declare class CustomVersionUpdate implements VersionUpdater {
-    name: string;
     private versionString;
     constructor(versionString: string);
+    /**
+     * Returns the new bumped version. This version is specified
+     * at initialization.
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
     bump(_version: Version): Version;
 }
+/**
+ * Implement this interface to create a new versioning scheme.
+ */
 export interface VersioningStrategy {
+    /**
+     * 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: Version, commits: ConventionalCommit[]): Version;
+    /**
+     * 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: Version, commits: ConventionalCommit[]): VersionUpdater;
 }

package/build/src/versioning-strategy.js

@@ -15,38 +15,65 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomVersionUpdate = exports.PatchVersionUpdate = exports.MinorVersionUpdate = exports.MajorVersionUpdate = void 0;
 const version_1 = require("./version");
+/**
+ * This VersionUpdater performs a SemVer major version bump.
+ */
 class MajorVersionUpdate {
-    constructor() {
-        this.name = 'major';
-    }
+    /**
+     * Returns the new bumped version
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
     bump(version) {
         return new version_1.Version(version.major + 1, 0, 0, version.preRelease, version.build);
     }
 }
 exports.MajorVersionUpdate = MajorVersionUpdate;
+/**
+ * This VersionUpdater performs a SemVer minor version bump.
+ */
 class MinorVersionUpdate {
-    constructor() {
-        this.name = 'minor';
-    }
+    /**
+     * Returns the new bumped version
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
     bump(version) {
         return new version_1.Version(version.major, version.minor + 1, 0, version.preRelease, version.build);
     }
 }
 exports.MinorVersionUpdate = MinorVersionUpdate;
+/**
+ * This VersionUpdater performs a SemVer patch version bump.
+ */
 class PatchVersionUpdate {
-    constructor() {
-        this.name = 'patch';
-    }
+    /**
+     * Returns the new bumped version
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
     bump(version) {
         return new version_1.Version(version.major, version.minor, version.patch + 1, version.preRelease, version.build);
     }
 }
 exports.PatchVersionUpdate = PatchVersionUpdate;
+/**
+ * This VersionUpdater sets the version to a specific version.
+ */
 class CustomVersionUpdate {
     constructor(versionString) {
-        this.name = 'custom';
         this.versionString = versionString;
     }
+    /**
+     * Returns the new bumped version. This version is specified
+     * at initialization.
+     *
+     * @param {Version} version The current version
+     * @returns {Version} The bumped version
+     */
     bump(_version) {
         return version_1.Version.parse(this.versionString);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "13.0.0-candidate.5",
+  "version": "13.0.0",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -73,6 +73,7 @@
     "conventional-changelog-conventionalcommits": "^4.6.0",
     "conventional-changelog-writer": "^5.0.0",
     "conventional-commits-filter": "^2.0.2",
+    "detect-indent": "^6.1.0",
     "figures": "^3.0.0",
     "js-yaml": "^4.0.0",
     "node-html-parser": "^5.0.0",
@@ -82,8 +83,7 @@
     "typescript": "^3.8.3",
     "unist-util-visit": "^2.0.3",
     "unist-util-visit-parents": "^3.1.1",
-    "yargs": "^17.0.0",
-    "detect-indent": "^6.1.0"
+    "yargs": "^17.0.0"
   },
   "engines": {
     "node": ">=12.18.0"

package/build/src/release-notes.d.ts

@@ -1,29 +0,0 @@
-import { ConventionalCommit } from './commit';
-export interface ChangelogSection {
-    type: string;
-    section: string;
-    hidden?: boolean;
-}
-interface ReleaseNotesOptions {
-    changelogSections?: ChangelogSection[];
-    commitPartial?: string;
-    headerPartial?: string;
-    mainTemplate?: string;
-}
-interface BuildNotesOptions {
-    host?: string;
-    owner: string;
-    repository: string;
-    version: string;
-    previousTag?: string;
-    currentTag: string;
-}
-export declare class ReleaseNotes {
-    private changelogSections?;
-    private commitPartial?;
-    private headerPartial?;
-    private mainTemplate?;
-    constructor(options?: ReleaseNotesOptions);
-    buildNotes(commits: ConventionalCommit[], options: BuildNotesOptions): Promise<string>;
-}
-export {};

package/build/src/release-notes.js

@@ -1,71 +0,0 @@
-"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.ReleaseNotes = void 0;
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const conventionalChangelogWriter = require('conventional-changelog-writer');
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const presetFactory = require('conventional-changelog-conventionalcommits');
-class ReleaseNotes {
-    constructor(options = {}) {
-        this.changelogSections = options.changelogSections;
-        this.commitPartial = options.commitPartial;
-        this.headerPartial = options.headerPartial;
-        this.mainTemplate = options.mainTemplate;
-    }
-    async buildNotes(commits, options) {
-        const context = {
-            host: options.host || 'https://github.com',
-            owner: options.owner,
-            repository: options.repository,
-            version: options.version,
-            previousTag: options.previousTag,
-            currentTag: options.currentTag,
-            linkCompare: !!options.previousTag,
-        };
-        const config = {};
-        if (this.changelogSections) {
-            config.types = this.changelogSections;
-        }
-        const preset = await presetFactory(config);
-        preset.writerOpts.commitPartial =
-            this.commitPartial || preset.writerOpts.commitPartial;
-        preset.writerOpts.headerPartial =
-            this.headerPartial || preset.writerOpts.headerPartial;
-        preset.writerOpts.mainTemplate =
-            this.mainTemplate || preset.writerOpts.mainTemplate;
-        const changelogCommits = commits.map(commit => {
-            return {
-                body: '',
-                subject: commit.bareMessage,
-                type: commit.type,
-                scope: commit.scope,
-                notes: commit.notes,
-                references: commit.references,
-                mentions: [],
-                merge: null,
-                revert: null,
-                header: commit.message,
-                footer: null,
-                hash: commit.sha,
-            };
-        });
-        return conventionalChangelogWriter
-            .parseArray(changelogCommits, context, preset.writerOpts)
-            .trim();
-    }
-}
-exports.ReleaseNotes = ReleaseNotes;
-//# sourceMappingURL=release-notes.js.map