package-versioner 0.5.1 → 0.5.3

package/README.md

@@ -87,7 +87,7 @@ Customize behavior by creating a `version.config.json` file in your project root
   "versionPrefix": "v",
   "tagTemplate": "${prefix}${version}",
   "packageTagTemplate": "${packageName}@${prefix}${version}",
-  "commitMessage": "chore(release): {{currentTag}} [skip ci]",
+  "commitMessage": "chore(release): ${version}",
   "monorepo": {
     "synced": true,
     "skip": [
@@ -99,7 +99,10 @@ Customize behavior by creating a `version.config.json` file in your project root
 }
 ```
 
-**Note:** Options like `synced`, `packages`, and `updateInternalDependencies` enable monorepo-specific behaviours. The `tagTemplate` and `packageTagTemplate` allow you to customize how Git tags are formatted for releases.
+**Notes:** 
+- Options like `synced`, `packages`, and `updateInternalDependencies` enable monorepo-specific behaviours.
+- The `tagTemplate` and `packageTagTemplate` allow you to customize how Git tags are formatted for releases.
+- The `commitMessage` template can include CI skip tokens like `[skip ci]` if you want to prevent CI runs after version commits (e.g., `"commitMessage": "chore(release): ${version} [skip ci]"`). See [CI/CD Integration](./docs/CI_CD_INTEGRATION.md) for more details.
 
 ## How Versioning Works
 

package/dist/index.cjs

@@ -334,7 +334,7 @@ function formatTag(version, versionPrefix, packageName, tagTemplate = "${prefix}
   const template = packageName ? packageTagTemplate : tagTemplate;
   return createTemplateString(template, variables);
 }
-function formatTagPrefix(versionPrefix, scope) {
+function formatVersionPrefix(versionPrefix, scope) {
   if (!versionPrefix) return "";
   const cleanPrefix = versionPrefix.replace(/\/$/, "");
   if (scope) {
@@ -395,12 +395,12 @@ async function lastMergeBranchName(branches, baseBranch) {
     return null;
   }
 }
-async function getLatestTagForPackage(packageName, tagPrefix) {
+async function getLatestTagForPackage(packageName, versionPrefix) {
   try {
     const allTags = await (0, import_git_semver_tags.getSemverTags)({
-      tagPrefix
+      tagPrefix: versionPrefix
     });
-    const packageTagPattern = tagPrefix ? new RegExp(`^${escapeRegExp(tagPrefix)}${escapeRegExp(packageName)}@`) : new RegExp(`^${escapeRegExp(packageName)}@`);
+    const packageTagPattern = versionPrefix ? new RegExp(`^${escapeRegExp(versionPrefix)}${escapeRegExp(packageName)}@`) : new RegExp(`^${escapeRegExp(packageName)}@`);
     const packageTags = allTags.filter((tag) => packageTagPattern.test(tag));
     return packageTags[0] || "";
   } catch (error) {
@@ -446,11 +446,11 @@ var import_node_process3 = require("process");
 var import_conventional_recommended_bump = require("conventional-recommended-bump");
 var import_semver = __toESM(require("semver"), 1);
 var STANDARD_BUMP_TYPES = ["major", "minor", "patch"];
-async function calculateVersion(config, options, forcedType, configPrereleaseIdentifier) {
+async function calculateVersion(config, options) {
   const { latestTag, type, path: pkgPath, name, branchPattern } = options;
   const { preset } = config;
-  const tagPrefix = options.versionPrefix || config.versionPrefix || "v";
-  const prereleaseIdentifier = options.prereleaseIdentifier || configPrereleaseIdentifier;
+  const originalPrefix = options.versionPrefix || "";
+  const prereleaseIdentifier = options.prereleaseIdentifier || config.prereleaseIdentifier;
   const initialVersion = prereleaseIdentifier ? `0.0.1-${prereleaseIdentifier}` : "0.0.1";
   const hasNoTags = !latestTag || latestTag === "";
   function determineTagSearchPattern(packageName, prefix) {
@@ -459,9 +459,9 @@ async function calculateVersion(config, options, forcedType, configPrereleaseIde
     }
     return prefix;
   }
-  const tagSearchPattern = determineTagSearchPattern(name, tagPrefix);
+  const tagSearchPattern = determineTagSearchPattern(name, originalPrefix);
   const escapedTagPattern = escapeRegExp(tagSearchPattern);
-  const specifiedType = forcedType || type;
+  const specifiedType = type;
   if (specifiedType) {
     if (hasNoTags) {
       return getPackageVersionFallback(
@@ -681,7 +681,7 @@ var PackageProcessor = class {
     for (const pkg of pkgsToConsider) {
       const name = pkg.packageJson.name;
       const pkgPath = pkg.dir;
-      const formattedPrefix = formatTagPrefix(this.versionPrefix);
+      const formattedPrefix = formatVersionPrefix(this.versionPrefix);
       let latestTagResult = "";
       try {
         latestTagResult = await getLatestTagForPackage(name, this.versionPrefix);
@@ -713,7 +713,7 @@ var PackageProcessor = class {
         branchPattern: this.config.branchPattern,
         baseBranch: this.config.baseBranch,
         prereleaseIdentifier: this.config.prereleaseIdentifier,
-        type: this.config.forceType
+        type: this.config.type
       });
       if (!nextVersion) {
         continue;
@@ -758,7 +758,6 @@ var PackageProcessor = class {
     } else {
       commitMessage = `chore(release): ${packageNames} ${representativeVersion}`;
     }
-    commitMessage += " [skip-ci]";
     setCommitMessage(commitMessage);
     if (!this.dryRun) {
       try {
@@ -810,14 +809,15 @@ function createSyncedStrategy(config) {
         dryRun,
         skipHooks
       } = config;
-      const formattedPrefix = formatTagPrefix(versionPrefix || "v");
+      const formattedPrefix = formatVersionPrefix(versionPrefix || "v");
       const latestTag = await getLatestTag();
       const nextVersion = await calculateVersion(config, {
         latestTag,
         versionPrefix: formattedPrefix,
         branchPattern,
         baseBranch,
-        prereleaseIdentifier
+        prereleaseIdentifier,
+        type: config.type
       });
       if (!nextVersion) {
         log("No version change needed", "info");
@@ -888,7 +888,7 @@ function createSingleStrategy(config) {
         throw createVersionError("PACKAGE_NOT_FOUND" /* PACKAGE_NOT_FOUND */, packageName);
       }
       const pkgPath = pkg.dir;
-      const formattedPrefix = formatTagPrefix(versionPrefix || "v");
+      const formattedPrefix = formatVersionPrefix(versionPrefix || "v");
       let latestTagResult = await getLatestTagForPackage(packageName, formattedPrefix);
       if (!latestTagResult) {
         const globalTagResult = await getLatestTag();
@@ -901,7 +901,8 @@ function createSingleStrategy(config) {
           latestTag,
           versionPrefix: formattedPrefix,
           path: pkgPath,
-          name: packageName
+          name: packageName,
+          type: config.type
         });
       } catch (error) {
         const errorMessage = error instanceof Error ? error.message : String(error);
@@ -958,11 +959,12 @@ function createAsyncStrategy(config) {
     skipHooks: config.skipHooks || false,
     getLatestTag: dependencies.getLatestTag,
     fullConfig: config,
+    // Extract common version configuration properties
     config: {
       branchPattern: config.branchPattern || [],
       baseBranch: config.baseBranch || "main",
       prereleaseIdentifier: config.prereleaseIdentifier,
-      forceType: config.forceType
+      type: config.type
     }
   };
   const packageProcessor = new PackageProcessor(processorOptions);
@@ -1093,7 +1095,7 @@ async function run() {
   ).version(process.env.npm_package_version || "0.0.0").option(
     "-c, --config <path>",
     "Path to config file (defaults to version.config.json in current directory)"
-  ).option("-d, --dry-run", "Dry run (no changes made)", false).option("-b, --bump <type>", "Force specific bump type (patch|minor|major)").option("-p, --prerelease [identifier]", "Create prerelease version").option("-s, --synced", "Force synchronized versioning across all packages").option("-j, --json", "Output results as JSON", false).option("-t, --target <packages>", "Comma-delimited list of package names to target").parse(process.argv);
+  ).option("-d, --dry-run", "Dry run (no changes made)", false).option("-b, --bump <type>", "Specify bump type (patch|minor|major)").option("-p, --prerelease [identifier]", "Create prerelease version").option("-s, --synced", "Use synchronized versioning across all packages").option("-j, --json", "Output results as JSON", false).option("-t, --target <packages>", "Comma-delimited list of package names to target").parse(process.argv);
   const options = program.opts();
   if (options.json) {
     enableJsonOutput(options.dryRun);
@@ -1103,7 +1105,7 @@ async function run() {
     log(`Loaded configuration from ${options.config || "version.config.json"}`, "info");
     if (options.dryRun) config.dryRun = true;
     if (options.synced) config.synced = true;
-    if (options.bump) config.forceType = options.bump;
+    if (options.bump) config.type = options.bump;
     if (options.prerelease)
       config.prereleaseIdentifier = options.prerelease === true ? "rc" : options.prerelease;
     const cliTargets = options.target ? options.target.split(",").map((t) => t.trim()) : [];

package/dist/index.js

@@ -311,7 +311,7 @@ function formatTag(version, versionPrefix, packageName, tagTemplate = "${prefix}
   const template = packageName ? packageTagTemplate : tagTemplate;
   return createTemplateString(template, variables);
 }
-function formatTagPrefix(versionPrefix, scope) {
+function formatVersionPrefix(versionPrefix, scope) {
   if (!versionPrefix) return "";
   const cleanPrefix = versionPrefix.replace(/\/$/, "");
   if (scope) {
@@ -372,12 +372,12 @@ async function lastMergeBranchName(branches, baseBranch) {
     return null;
   }
 }
-async function getLatestTagForPackage(packageName, tagPrefix) {
+async function getLatestTagForPackage(packageName, versionPrefix) {
   try {
     const allTags = await getSemverTags({
-      tagPrefix
+      tagPrefix: versionPrefix
     });
-    const packageTagPattern = tagPrefix ? new RegExp(`^${escapeRegExp(tagPrefix)}${escapeRegExp(packageName)}@`) : new RegExp(`^${escapeRegExp(packageName)}@`);
+    const packageTagPattern = versionPrefix ? new RegExp(`^${escapeRegExp(versionPrefix)}${escapeRegExp(packageName)}@`) : new RegExp(`^${escapeRegExp(packageName)}@`);
     const packageTags = allTags.filter((tag) => packageTagPattern.test(tag));
     return packageTags[0] || "";
   } catch (error) {
@@ -422,11 +422,11 @@ import { cwd as cwd3 } from "node:process";
 import { Bumper } from "conventional-recommended-bump";
 import semver from "semver";
 var STANDARD_BUMP_TYPES = ["major", "minor", "patch"];
-async function calculateVersion(config, options, forcedType, configPrereleaseIdentifier) {
+async function calculateVersion(config, options) {
   const { latestTag, type, path: pkgPath, name, branchPattern } = options;
   const { preset } = config;
-  const tagPrefix = options.versionPrefix || config.versionPrefix || "v";
-  const prereleaseIdentifier = options.prereleaseIdentifier || configPrereleaseIdentifier;
+  const originalPrefix = options.versionPrefix || "";
+  const prereleaseIdentifier = options.prereleaseIdentifier || config.prereleaseIdentifier;
   const initialVersion = prereleaseIdentifier ? `0.0.1-${prereleaseIdentifier}` : "0.0.1";
   const hasNoTags = !latestTag || latestTag === "";
   function determineTagSearchPattern(packageName, prefix) {
@@ -435,9 +435,9 @@ async function calculateVersion(config, options, forcedType, configPrereleaseIde
     }
     return prefix;
   }
-  const tagSearchPattern = determineTagSearchPattern(name, tagPrefix);
+  const tagSearchPattern = determineTagSearchPattern(name, originalPrefix);
   const escapedTagPattern = escapeRegExp(tagSearchPattern);
-  const specifiedType = forcedType || type;
+  const specifiedType = type;
   if (specifiedType) {
     if (hasNoTags) {
       return getPackageVersionFallback(
@@ -657,7 +657,7 @@ var PackageProcessor = class {
     for (const pkg of pkgsToConsider) {
       const name = pkg.packageJson.name;
       const pkgPath = pkg.dir;
-      const formattedPrefix = formatTagPrefix(this.versionPrefix);
+      const formattedPrefix = formatVersionPrefix(this.versionPrefix);
       let latestTagResult = "";
       try {
         latestTagResult = await getLatestTagForPackage(name, this.versionPrefix);
@@ -689,7 +689,7 @@ var PackageProcessor = class {
         branchPattern: this.config.branchPattern,
         baseBranch: this.config.baseBranch,
         prereleaseIdentifier: this.config.prereleaseIdentifier,
-        type: this.config.forceType
+        type: this.config.type
       });
       if (!nextVersion) {
         continue;
@@ -734,7 +734,6 @@ var PackageProcessor = class {
     } else {
       commitMessage = `chore(release): ${packageNames} ${representativeVersion}`;
     }
-    commitMessage += " [skip-ci]";
     setCommitMessage(commitMessage);
     if (!this.dryRun) {
       try {
@@ -786,14 +785,15 @@ function createSyncedStrategy(config) {
         dryRun,
         skipHooks
       } = config;
-      const formattedPrefix = formatTagPrefix(versionPrefix || "v");
+      const formattedPrefix = formatVersionPrefix(versionPrefix || "v");
       const latestTag = await getLatestTag();
       const nextVersion = await calculateVersion(config, {
         latestTag,
         versionPrefix: formattedPrefix,
         branchPattern,
         baseBranch,
-        prereleaseIdentifier
+        prereleaseIdentifier,
+        type: config.type
       });
       if (!nextVersion) {
         log("No version change needed", "info");
@@ -864,7 +864,7 @@ function createSingleStrategy(config) {
         throw createVersionError("PACKAGE_NOT_FOUND" /* PACKAGE_NOT_FOUND */, packageName);
       }
       const pkgPath = pkg.dir;
-      const formattedPrefix = formatTagPrefix(versionPrefix || "v");
+      const formattedPrefix = formatVersionPrefix(versionPrefix || "v");
       let latestTagResult = await getLatestTagForPackage(packageName, formattedPrefix);
       if (!latestTagResult) {
         const globalTagResult = await getLatestTag();
@@ -877,7 +877,8 @@ function createSingleStrategy(config) {
           latestTag,
           versionPrefix: formattedPrefix,
           path: pkgPath,
-          name: packageName
+          name: packageName,
+          type: config.type
         });
       } catch (error) {
         const errorMessage = error instanceof Error ? error.message : String(error);
@@ -934,11 +935,12 @@ function createAsyncStrategy(config) {
     skipHooks: config.skipHooks || false,
     getLatestTag: dependencies.getLatestTag,
     fullConfig: config,
+    // Extract common version configuration properties
     config: {
       branchPattern: config.branchPattern || [],
       baseBranch: config.baseBranch || "main",
       prereleaseIdentifier: config.prereleaseIdentifier,
-      forceType: config.forceType
+      type: config.type
     }
   };
   const packageProcessor = new PackageProcessor(processorOptions);
@@ -1069,7 +1071,7 @@ async function run() {
   ).version(process.env.npm_package_version || "0.0.0").option(
     "-c, --config <path>",
     "Path to config file (defaults to version.config.json in current directory)"
-  ).option("-d, --dry-run", "Dry run (no changes made)", false).option("-b, --bump <type>", "Force specific bump type (patch|minor|major)").option("-p, --prerelease [identifier]", "Create prerelease version").option("-s, --synced", "Force synchronized versioning across all packages").option("-j, --json", "Output results as JSON", false).option("-t, --target <packages>", "Comma-delimited list of package names to target").parse(process.argv);
+  ).option("-d, --dry-run", "Dry run (no changes made)", false).option("-b, --bump <type>", "Specify bump type (patch|minor|major)").option("-p, --prerelease [identifier]", "Create prerelease version").option("-s, --synced", "Use synchronized versioning across all packages").option("-j, --json", "Output results as JSON", false).option("-t, --target <packages>", "Comma-delimited list of package names to target").parse(process.argv);
   const options = program.opts();
   if (options.json) {
     enableJsonOutput(options.dryRun);
@@ -1079,7 +1081,7 @@ async function run() {
     log(`Loaded configuration from ${options.config || "version.config.json"}`, "info");
     if (options.dryRun) config.dryRun = true;
     if (options.synced) config.synced = true;
-    if (options.bump) config.forceType = options.bump;
+    if (options.bump) config.type = options.bump;
     if (options.prerelease)
       config.prereleaseIdentifier = options.prerelease === true ? "rc" : options.prerelease;
     const cliTargets = options.target ? options.target.split(",").map((t) => t.trim()) : [];

package/docs/CI_CD_INTEGRATION.md

@@ -156,6 +156,24 @@ git push origin "v$NEW_VERSION"
 - `NO_COLOR=1`: Disables colored output in logs (automatically detected in CI environments)
 - `CI=true`: Most CI environments set this automatically, which helps the tool adjust its output behavior
 
+## Skipping CI for Version Commits
+
+If you want to prevent additional CI runs when version commits are made, you can include CI skip flags in your commit message template in `version.config.json`:
+
+```json
+{
+  "commitMessage": "chore(release): ${version} [skip ci]",
+  // other configuration options...
+}
+```
+
+Common CI skip patterns include:
+- `[skip ci]` or `[ci skip]` - Works in GitHub Actions, GitLab CI, CircleCI
+- `[skip-ci]` - Alternative format supported by some CI systems
+- `[no ci]` - Another variant 
+
+Each CI system might have slightly different syntax, so check your CI provider's documentation for the exact skip token to use.
+
 ## Tips for Reliable CI/CD Integration
 
 1. **Always use `--json`** in CI/CD pipelines for consistent output parsing

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "package-versioner",
   "description": "A lightweight yet powerful CLI tool for automated semantic versioning based on Git history and conventional commits.",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",