package-versioner 0.5.1 → 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -87,7 +87,7 @@ Customize behavior by creating a `version.config.json` file in your project root
87
87
  "versionPrefix": "v",
88
88
  "tagTemplate": "${prefix}${version}",
89
89
  "packageTagTemplate": "${packageName}@${prefix}${version}",
90
- "commitMessage": "chore(release): {{currentTag}} [skip ci]",
90
+ "commitMessage": "chore(release): ${version}",
91
91
  "monorepo": {
92
92
  "synced": true,
93
93
  "skip": [
@@ -99,7 +99,10 @@ Customize behavior by creating a `version.config.json` file in your project root
99
99
  }
100
100
  ```
101
101
 
102
- **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.
102
+ **Notes:**
103
+ - Options like `synced`, `packages`, and `updateInternalDependencies` enable monorepo-specific behaviours.
104
+ - The `tagTemplate` and `packageTagTemplate` allow you to customize how Git tags are formatted for releases.
105
+ - 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.
103
106
 
104
107
  ## How Versioning Works
105
108
 
package/dist/index.cjs CHANGED
@@ -758,7 +758,6 @@ var PackageProcessor = class {
758
758
  } else {
759
759
  commitMessage = `chore(release): ${packageNames} ${representativeVersion}`;
760
760
  }
761
- commitMessage += " [skip-ci]";
762
761
  setCommitMessage(commitMessage);
763
762
  if (!this.dryRun) {
764
763
  try {
package/dist/index.js CHANGED
@@ -734,7 +734,6 @@ var PackageProcessor = class {
734
734
  } else {
735
735
  commitMessage = `chore(release): ${packageNames} ${representativeVersion}`;
736
736
  }
737
- commitMessage += " [skip-ci]";
738
737
  setCommitMessage(commitMessage);
739
738
  if (!this.dryRun) {
740
739
  try {
@@ -156,6 +156,24 @@ git push origin "v$NEW_VERSION"
156
156
  - `NO_COLOR=1`: Disables colored output in logs (automatically detected in CI environments)
157
157
  - `CI=true`: Most CI environments set this automatically, which helps the tool adjust its output behavior
158
158
 
159
+ ## Skipping CI for Version Commits
160
+
161
+ 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`:
162
+
163
+ ```json
164
+ {
165
+ "commitMessage": "chore(release): ${version} [skip ci]",
166
+ // other configuration options...
167
+ }
168
+ ```
169
+
170
+ Common CI skip patterns include:
171
+ - `[skip ci]` or `[ci skip]` - Works in GitHub Actions, GitLab CI, CircleCI
172
+ - `[skip-ci]` - Alternative format supported by some CI systems
173
+ - `[no ci]` - Another variant
174
+
175
+ Each CI system might have slightly different syntax, so check your CI provider's documentation for the exact skip token to use.
176
+
159
177
  ## Tips for Reliable CI/CD Integration
160
178
 
161
179
  1. **Always use `--json`** in CI/CD pipelines for consistent output parsing
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "package-versioner",
3
3
  "description": "A lightweight yet powerful CLI tool for automated semantic versioning based on Git history and conventional commits.",
4
- "version": "0.5.1",
4
+ "version": "0.5.2",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
7
7
  "module": "./dist/index.mjs",