release-please 17.1.3 → 17.2.1

package/build/src/bin/release-please.js

@@ -77,6 +77,11 @@ function releaseOptions(yargs) {
             'tag creation upon "un-drafting" the release.',
         type: 'boolean',
         default: false,
+    })
+        .option('force-tag-creation', {
+        describe: 'Force the creation of a Git tag for the release.',
+        type: 'boolean',
+        default: false,
     })
         .option('prerelease', {
         describe: 'mark release that have prerelease versions ' +
@@ -380,6 +385,7 @@ const createReleaseCommand = {
                 component: argv.component,
                 packageName: argv.packageName,
                 draft: argv.draft,
+                forceTag: argv.forceTag,
                 prerelease: argv.prerelease,
                 includeComponentInTag: argv.monorepoTags,
                 includeVInTag: argv.includeVInTags,
@@ -497,6 +503,7 @@ const bootstrapCommand = {
             component: argv.component,
             packageName: argv.packageName,
             draft: argv.draft,
+            forceTag: argv.forceTag,
             prerelease: argv.prerelease,
             draftPullRequest: argv.draftPullRequest,
             bumpMinorPreMajor: argv.bumpMinorPreMajor,

package/build/src/github.d.ts

@@ -57,6 +57,7 @@ interface TagIteratorOptions {
 export interface ReleaseOptions {
     draft?: boolean;
     prerelease?: boolean;
+    forceTag?: boolean;
 }
 export interface GitHubRelease {
     id: number;

package/build/src/github.js

@@ -274,6 +274,25 @@ class GitHub {
          * @throws {GitHubAPIError} on other API errors
          */
         this.createRelease = wrapAsync(async (release, options = {}) => {
+            if (options.forceTag) {
+                try {
+                    await this.octokit.git.createRef({
+                        owner: this.repository.owner,
+                        repo: this.repository.repo,
+                        ref: `refs/tags/${release.tag.toString()}`,
+                        sha: release.sha,
+                    });
+                }
+                catch (err) {
+                    // ignore if tag already exists
+                    if (err.status === 422) {
+                        this.logger.debug(`Tag ${release.tag.toString()} already exists, skipping tag creation`);
+                    }
+                    else {
+                        throw err;
+                    }
+                }
+            }
             const resp = await this.octokit.repos.createRelease({
                 name: release.name,
                 owner: this.repository.owner,

package/build/src/index.d.ts

@@ -14,4 +14,4 @@ export { Logger, setLogger } from './util/logger';
 export { GitHub } from './github';
 export declare const configSchema: any;
 export declare const manifestSchema: any;
-export declare const VERSION = "17.1.3";
+export declare const VERSION = "17.2.1";

package/build/src/index.js

@@ -36,6 +36,6 @@ Object.defineProperty(exports, "GitHub", { enumerable: true, get: function () {
 exports.configSchema = require('../../schemas/config.json');
 exports.manifestSchema = require('../../schemas/manifest.json');
 // x-release-please-start-version
-exports.VERSION = '17.1.3';
+exports.VERSION = '17.2.1';
 // x-release-please-end
 //# sourceMappingURL=index.js.map

package/build/src/manifest.d.ts

@@ -55,12 +55,14 @@ export interface ReleaserConfig {
     skipGithubRelease?: boolean;
     skipChangelog?: boolean;
     draft?: boolean;
+    forceTag?: boolean;
     prerelease?: boolean;
     draftPullRequest?: boolean;
     component?: string;
     packageName?: string;
     includeComponentInTag?: boolean;
     includeVInTag?: boolean;
+    includeVInReleaseName?: boolean;
     pullRequestTitlePattern?: string;
     pullRequestHeader?: string;
     pullRequestFooter?: string;
@@ -91,6 +93,7 @@ export interface CandidateRelease extends Release {
     pullRequest: PullRequest;
     path: string;
     draft?: boolean;
+    forceTag?: boolean;
     prerelease?: boolean;
 }
 interface ReleaserConfigJson {
@@ -104,6 +107,7 @@ interface ReleaserConfigJson {
     'skip-github-release'?: boolean;
     'skip-changelog'?: boolean;
     draft?: boolean;
+    'force-tag-creation'?: boolean;
     prerelease?: boolean;
     'draft-pull-request'?: boolean;
     label?: string;
@@ -111,6 +115,7 @@ interface ReleaserConfigJson {
     'extra-label'?: string;
     'include-component-in-tag'?: boolean;
     'include-v-in-tag'?: boolean;
+    'include-v-in-release-name'?: boolean;
     'changelog-type'?: ChangelogNotesType;
     'changelog-host'?: string;
     'pull-request-title-pattern'?: string;

package/build/src/manifest.js

@@ -649,6 +649,7 @@ class Manifest {
                         path,
                         pullRequest,
                         draft: (_a = config.draft) !== null && _a !== void 0 ? _a : this.draft,
+                        forceTag: config.forceTag,
                         prerelease: config.prerelease &&
                             (!!release.tag.version.preRelease ||
                                 release.tag.version.major === 0),
@@ -751,6 +752,7 @@ class Manifest {
         const githubRelease = await this.github.createRelease(release, {
             draft: release.draft,
             prerelease: release.prerelease,
+            forceTag: release.forceTag,
         });
         return {
             ...githubRelease,
@@ -819,6 +821,7 @@ function extractReleaserConfig(config) {
         skipGithubRelease: config['skip-github-release'],
         skipChangelog: config['skip-changelog'],
         draft: config.draft,
+        forceTag: config['force-tag-creation'],
         prerelease: config.prerelease,
         draftPullRequest: config['draft-pull-request'],
         component: config['component'],
@@ -827,6 +830,7 @@ function extractReleaserConfig(config) {
         extraFiles: config['extra-files'],
         includeComponentInTag: config['include-component-in-tag'],
         includeVInTag: config['include-v-in-tag'],
+        includeVInReleaseName: config['include-v-in-release-name'],
         changelogType: config['changelog-type'],
         pullRequestTitlePattern: config['pull-request-title-pattern'],
         pullRequestHeader: config['pull-request-header'],
@@ -1054,7 +1058,7 @@ async function latestReleaseVersion(github, targetBranch, releaseFilter, config,
     return candidateTagVersion.sort((a, b) => b.compare(a))[0];
 }
 function mergeReleaserConfig(defaultConfig, pathConfig) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10;
     return {
         releaseType: (_b = (_a = pathConfig.releaseType) !== null && _a !== void 0 ? _a : defaultConfig.releaseType) !== null && _b !== void 0 ? _b : 'node',
         bumpMinorPreMajor: (_c = pathConfig.bumpMinorPreMajor) !== null && _c !== void 0 ? _c : defaultConfig.bumpMinorPreMajor,
@@ -1069,25 +1073,27 @@ function mergeReleaserConfig(defaultConfig, pathConfig) {
         skipGithubRelease: (_m = pathConfig.skipGithubRelease) !== null && _m !== void 0 ? _m : defaultConfig.skipGithubRelease,
         skipChangelog: (_o = pathConfig.skipChangelog) !== null && _o !== void 0 ? _o : defaultConfig.skipChangelog,
         draft: (_p = pathConfig.draft) !== null && _p !== void 0 ? _p : defaultConfig.draft,
-        draftPullRequest: (_q = pathConfig.draftPullRequest) !== null && _q !== void 0 ? _q : defaultConfig.draftPullRequest,
-        prerelease: (_r = pathConfig.prerelease) !== null && _r !== void 0 ? _r : defaultConfig.prerelease,
-        component: (_s = pathConfig.component) !== null && _s !== void 0 ? _s : defaultConfig.component,
-        packageName: (_t = pathConfig.packageName) !== null && _t !== void 0 ? _t : defaultConfig.packageName,
-        versionFile: (_u = pathConfig.versionFile) !== null && _u !== void 0 ? _u : defaultConfig.versionFile,
-        extraFiles: (_v = pathConfig.extraFiles) !== null && _v !== void 0 ? _v : defaultConfig.extraFiles,
-        includeComponentInTag: (_w = pathConfig.includeComponentInTag) !== null && _w !== void 0 ? _w : defaultConfig.includeComponentInTag,
-        includeVInTag: (_x = pathConfig.includeVInTag) !== null && _x !== void 0 ? _x : defaultConfig.includeVInTag,
-        tagSeparator: (_y = pathConfig.tagSeparator) !== null && _y !== void 0 ? _y : defaultConfig.tagSeparator,
-        pullRequestTitlePattern: (_z = pathConfig.pullRequestTitlePattern) !== null && _z !== void 0 ? _z : defaultConfig.pullRequestTitlePattern,
-        pullRequestHeader: (_0 = pathConfig.pullRequestHeader) !== null && _0 !== void 0 ? _0 : defaultConfig.pullRequestHeader,
-        pullRequestFooter: (_1 = pathConfig.pullRequestFooter) !== null && _1 !== void 0 ? _1 : defaultConfig.pullRequestFooter,
-        componentNoSpace: (_2 = pathConfig.componentNoSpace) !== null && _2 !== void 0 ? _2 : defaultConfig.componentNoSpace,
-        separatePullRequests: (_3 = pathConfig.separatePullRequests) !== null && _3 !== void 0 ? _3 : defaultConfig.separatePullRequests,
-        skipSnapshot: (_4 = pathConfig.skipSnapshot) !== null && _4 !== void 0 ? _4 : defaultConfig.skipSnapshot,
-        initialVersion: (_5 = pathConfig.initialVersion) !== null && _5 !== void 0 ? _5 : defaultConfig.initialVersion,
-        extraLabels: (_6 = pathConfig.extraLabels) !== null && _6 !== void 0 ? _6 : defaultConfig.extraLabels,
-        excludePaths: (_7 = pathConfig.excludePaths) !== null && _7 !== void 0 ? _7 : defaultConfig.excludePaths,
-        dateFormat: (_8 = pathConfig.dateFormat) !== null && _8 !== void 0 ? _8 : defaultConfig.dateFormat,
+        forceTag: (_q = pathConfig.forceTag) !== null && _q !== void 0 ? _q : defaultConfig.forceTag,
+        draftPullRequest: (_r = pathConfig.draftPullRequest) !== null && _r !== void 0 ? _r : defaultConfig.draftPullRequest,
+        prerelease: (_s = pathConfig.prerelease) !== null && _s !== void 0 ? _s : defaultConfig.prerelease,
+        component: (_t = pathConfig.component) !== null && _t !== void 0 ? _t : defaultConfig.component,
+        packageName: (_u = pathConfig.packageName) !== null && _u !== void 0 ? _u : defaultConfig.packageName,
+        versionFile: (_v = pathConfig.versionFile) !== null && _v !== void 0 ? _v : defaultConfig.versionFile,
+        extraFiles: (_w = pathConfig.extraFiles) !== null && _w !== void 0 ? _w : defaultConfig.extraFiles,
+        includeComponentInTag: (_x = pathConfig.includeComponentInTag) !== null && _x !== void 0 ? _x : defaultConfig.includeComponentInTag,
+        includeVInTag: (_y = pathConfig.includeVInTag) !== null && _y !== void 0 ? _y : defaultConfig.includeVInTag,
+        includeVInReleaseName: (_z = pathConfig.includeVInReleaseName) !== null && _z !== void 0 ? _z : defaultConfig.includeVInReleaseName,
+        tagSeparator: (_0 = pathConfig.tagSeparator) !== null && _0 !== void 0 ? _0 : defaultConfig.tagSeparator,
+        pullRequestTitlePattern: (_1 = pathConfig.pullRequestTitlePattern) !== null && _1 !== void 0 ? _1 : defaultConfig.pullRequestTitlePattern,
+        pullRequestHeader: (_2 = pathConfig.pullRequestHeader) !== null && _2 !== void 0 ? _2 : defaultConfig.pullRequestHeader,
+        pullRequestFooter: (_3 = pathConfig.pullRequestFooter) !== null && _3 !== void 0 ? _3 : defaultConfig.pullRequestFooter,
+        componentNoSpace: (_4 = pathConfig.componentNoSpace) !== null && _4 !== void 0 ? _4 : defaultConfig.componentNoSpace,
+        separatePullRequests: (_5 = pathConfig.separatePullRequests) !== null && _5 !== void 0 ? _5 : defaultConfig.separatePullRequests,
+        skipSnapshot: (_6 = pathConfig.skipSnapshot) !== null && _6 !== void 0 ? _6 : defaultConfig.skipSnapshot,
+        initialVersion: (_7 = pathConfig.initialVersion) !== null && _7 !== void 0 ? _7 : defaultConfig.initialVersion,
+        extraLabels: (_8 = pathConfig.extraLabels) !== null && _8 !== void 0 ? _8 : defaultConfig.extraLabels,
+        excludePaths: (_9 = pathConfig.excludePaths) !== null && _9 !== void 0 ? _9 : defaultConfig.excludePaths,
+        dateFormat: (_10 = pathConfig.dateFormat) !== null && _10 !== void 0 ? _10 : defaultConfig.dateFormat,
     };
 }
 /**

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

@@ -43,6 +43,7 @@ export interface BaseStrategyOptions {
     changelogNotes?: ChangelogNotes;
     includeComponentInTag?: boolean;
     includeVInTag?: boolean;
+    includeVInReleaseName?: boolean;
     pullRequestTitlePattern?: string;
     pullRequestHeader?: string;
     pullRequestFooter?: string;
@@ -77,6 +78,7 @@ export declare abstract class BaseStrategy implements Strategy {
     private releaseAs?;
     protected includeComponentInTag: boolean;
     protected includeVInTag: boolean;
+    protected includeVInReleaseName: boolean;
     protected initialVersion?: string;
     readonly pullRequestTitlePattern?: string;
     readonly pullRequestHeader?: string;

package/build/src/strategies/base.js

@@ -37,7 +37,7 @@ const DEFAULT_CHANGELOG_PATH = 'CHANGELOG.md';
  */
 class BaseStrategy {
     constructor(options) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         this.logger = (_a = options.logger) !== null && _a !== void 0 ? _a : logger_1.logger;
         this.path = options.path || manifest_1.ROOT_PROJECT_PATH;
         this.github = options.github;
@@ -60,6 +60,7 @@ class BaseStrategy {
             options.changelogNotes || new default_2.DefaultChangelogNotes(options);
         this.includeComponentInTag = (_b = options.includeComponentInTag) !== null && _b !== void 0 ? _b : true;
         this.includeVInTag = (_c = options.includeVInTag) !== null && _c !== void 0 ? _c : true;
+        this.includeVInReleaseName = (_d = options.includeVInReleaseName) !== null && _d !== void 0 ? _d : true;
         this.pullRequestTitlePattern = options.pullRequestTitlePattern;
         this.pullRequestHeader = options.pullRequestHeader;
         this.pullRequestFooter = options.pullRequestFooter;
@@ -420,9 +421,10 @@ class BaseStrategy {
             return;
         }
         const tag = new tag_name_1.TagName(version, this.includeComponentInTag ? component : undefined, this.tagSeparator, this.includeVInTag);
+        const versionPrefix = this.includeVInReleaseName ? 'v' : '';
         const releaseName = component && this.includeComponentInTag
-            ? `${component}: v${version.toString()}`
-            : `v${version.toString()}`;
+            ? `${component}: ${versionPrefix}${version.toString()}`
+            : `${versionPrefix}${version.toString()}`;
         return {
             name: releaseName,
             tag,

package/build/src/updaters/release-please-config.js

@@ -61,6 +61,7 @@ function releaserConfigToJsonConfig(config) {
         'release-label': (_b = config.releaseLabels) === null || _b === void 0 ? void 0 : _b.join(','),
         'include-component-in-tag': config.includeComponentInTag,
         'include-v-in-tag': config.includeVInTag,
+        'include-v-in-release-name': config.includeVInReleaseName,
         'changelog-type': config.changelogType,
         'changelog-host': config.changelogHost,
         'pull-request-title-pattern': config.pullRequestTitlePattern,

package/build/src/util/coerce-option.js

@@ -18,7 +18,11 @@ const fs_1 = require("fs");
 // if an option looks like a file path, assume it's a
 // path to a key and load it.
 function coerceOption(option) {
-    if (option.match(/[\\/]/)) {
+    // Only check .match if option is a string, to avoid TypeError.
+    // This might happen if the user didn't pass any payload for
+    // the option, or if the payload is empty. Example:
+    // --token $EMPTY_VAR
+    if (typeof option === 'string' && option.match(/[\\/]/)) {
         try {
             const stat = (0, fs_1.statSync)(option);
             if (stat.isDirectory())

package/build/src/versioning-strategies/dependency-manifest.js

@@ -19,6 +19,7 @@ const semver = require("semver");
 const default_1 = require("./default");
 const versioning_strategy_1 = require("../versioning-strategy");
 const DEPENDENCY_UPDATE_REGEX = /^deps: update dependency (.*) to (v[^\s]*)(\s\(#\d+\))?$/m;
+const DEPENDABOT_DEPENDENCY_UPDATE_REGEX = /^(?:chore|build)\(deps\): bump (.*) from [^\s]* to ([^\s]*)(\s\(#\d+\))?$/m;
 /**
  * This VersioningStrategy looks at `deps` type commits and tries to
  * mirror the semantic version bump for that dependency update. For
@@ -73,10 +74,14 @@ class DependencyManifest extends default_1.DefaultVersioningStrategy {
     }
 }
 exports.DependencyManifest = DependencyManifest;
+function matchCommit(commit) {
+    return (commit.message.match(DEPENDENCY_UPDATE_REGEX) ||
+        commit.message.match(DEPENDABOT_DEPENDENCY_UPDATE_REGEX));
+}
 function buildDependencyUpdates(commits) {
     const versionsMap = {};
     for (const commit of commits) {
-        const match = commit.message.match(DEPENDENCY_UPDATE_REGEX);
+        const match = matchCommit(commit);
         if (!match)
             continue;
         const versionString = match[2];

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

@@ -4,6 +4,7 @@ import { ConventionalCommit } from '..';
 import { VersionUpdater } from '../versioning-strategy';
 interface PrereleaseVersioningStrategyOptions extends DefaultVersioningStrategyOptions {
     prereleaseType?: string;
+    prerelease?: boolean;
 }
 /**
  * This versioning strategy will increment the pre-release number for patch
@@ -12,6 +13,7 @@ interface PrereleaseVersioningStrategyOptions extends DefaultVersioningStrategyO
  */
 export declare class PrereleaseVersioningStrategy extends DefaultVersioningStrategy {
     readonly prereleaseType?: string;
+    readonly prerelease: boolean;
     constructor(options?: PrereleaseVersioningStrategyOptions);
     determineReleaseType(version: Version, commits: ConventionalCommit[]): VersionUpdater;
 }

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

@@ -109,6 +109,7 @@ class PrereleaseVersioningStrategy extends default_1.DefaultVersioningStrategy {
     constructor(options = {}) {
         super(options);
         this.prereleaseType = options.prereleaseType;
+        this.prerelease = options.prerelease === true;
     }
     determineReleaseType(version, commits) {
         // iterate through list of commits and find biggest commit type
@@ -128,23 +129,31 @@ class PrereleaseVersioningStrategy extends default_1.DefaultVersioningStrategy {
                 features++;
             }
         }
+        let bumpedVersionUpdater;
         if (breaking > 0) {
             if (version.isPreMajor && this.bumpMinorPreMajor) {
-                return new PrereleaseMinorVersionUpdate(this.prereleaseType);
+                bumpedVersionUpdater = new PrereleaseMinorVersionUpdate(this.prereleaseType);
             }
             else {
-                return new PrereleaseMajorVersionUpdate(this.prereleaseType);
+                bumpedVersionUpdater = new PrereleaseMajorVersionUpdate(this.prereleaseType);
             }
         }
         else if (features > 0) {
             if (version.isPreMajor && this.bumpPatchForMinorPreMajor) {
-                return new PrereleasePatchVersionUpdate(this.prereleaseType);
+                bumpedVersionUpdater = new PrereleasePatchVersionUpdate(this.prereleaseType);
             }
             else {
-                return new PrereleaseMinorVersionUpdate(this.prereleaseType);
+                bumpedVersionUpdater = new PrereleaseMinorVersionUpdate(this.prereleaseType);
             }
         }
-        return new PrereleasePatchVersionUpdate(this.prereleaseType);
+        else {
+            bumpedVersionUpdater = new PrereleasePatchVersionUpdate(this.prereleaseType);
+        }
+        if (!this.prerelease) {
+            const bumpedVersion = bumpedVersionUpdater.bump(version);
+            return new versioning_strategy_1.CustomVersionUpdate(version_1.Version.parse(`${bumpedVersion.major}.${bumpedVersion.minor}.${bumpedVersion.patch}`).toString());
+        }
+        return bumpedVersionUpdater;
     }
 }
 exports.PrereleaseVersioningStrategy = PrereleaseVersioningStrategy;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-please",
-  "version": "17.1.3",
+  "version": "17.2.1",
   "description": "generate release PRs based on the conventionalcommits.org spec",
   "main": "./build/src/index.js",
   "bin": "./build/src/bin/release-please.js",
@@ -48,7 +48,6 @@
     "@types/mocha": "^10.0.0",
     "@types/node": "^18.0.0",
     "@types/npmlog": "^7.0.0",
-    "@types/pino": "^7.0.0",
     "@types/semver": "^7.0.0",
     "@types/sinon": "^17.0.0",
     "@types/xmldom": "^0.1.31",
@@ -82,7 +81,7 @@
     "conventional-changelog-writer": "^6.0.0",
     "conventional-commits-filter": "^3.0.0",
     "detect-indent": "^6.1.0",
-    "diff": "^7.0.0",
+    "diff": "^8.0.3",
     "figures": "^3.0.0",
     "http-proxy-agent": "^7.0.0",
     "https-proxy-agent": "^7.0.0",

package/schemas/config.json

@@ -66,6 +66,10 @@
           "description": "Create the GitHub release in draft mode. Defaults to `false`.",
           "type": "boolean"
         },
+        "force-tag-creation": {
+          "description": "Force the creation of a Git tag for the release. This is particularly useful when `draft` is enabled, because GitHub does not create a Git tag for draft releases until they are published. This 'lazy tag creation' causes release-please to fail to find the previous release, potentially generating incorrect changelogs. Setting this to `true` ensures the tag is created immediately. Defaults to `false`.",
+          "type": "boolean"
+        },
         "prerelease": {
           "description": "Create the GitHub release as prerelease. Defaults to `false`.",
           "type": "boolean"
@@ -83,7 +87,11 @@
           "type": "boolean"
         },
         "include-v-in-tag": {
-          "description": "When tagging a release, include `v` in the tag. Defaults to `false`.",
+          "description": "When tagging a release, include `v` in the tag. Defaults to `true`.",
+          "type": "boolean"
+        },
+        "include-v-in-release-name": {
+          "description": "Include `v` in the GitHub release name. Defaults to `true`.",
           "type": "boolean"
         },
         "changelog-type": {
@@ -464,6 +472,7 @@
     "skip-github-release": true,
     "skip-changelog": true,
     "draft": true,
+    "force-tag-creation": true,
     "prerelease": true,
     "draft-pull-request": true,
     "label": true,
@@ -471,6 +480,7 @@
     "extra-label": true,
     "include-component-in-tag": true,
     "include-v-in-tag": true,
+    "include-v-in-release-name": true,
     "changelog-type": true,
     "changelog-host": true,
     "changelog-path": true,