package-versioner 0.6.4 → 0.7.1

package/README.md

@@ -5,7 +5,7 @@
   <img src="https://img.shields.io/npm/v/package-versioner" /></a>
 <a href="https://www.npmjs.com/package/package-versioner" alt="NPM Downloads">
   <img src="https://img.shields.io/npm/dw/package-versioner" /></a>
-
+<br/><br/>
 A lightweight yet powerful CLI tool for automated semantic versioning based on Git history and conventional commits. Supports both single package projects and monorepos with flexible versioning strategies.
 
 ## Features
@@ -18,6 +18,8 @@ A lightweight yet powerful CLI tool for automated semantic versioning based on G
 - Customizable through a `version.config.json` file or CLI options
 - Automatically updates `package.json` or `Cargo.toml` version
 - Creates appropriate Git tags for releases
+- Automatically generates and maintains changelogs in Keep a Changelog or Angular format
+- Integrates commit messages, breaking changes, and issue references into well-structured changelogs
 - CI/CD friendly with JSON output support
 
 ## Supporting JavaScript and Rust Projects
@@ -98,15 +100,16 @@ 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): ${version}",
-  "monorepo": {
-    "synced": true,
-    "skip": [
-      "docs",
-      "e2e"
-    ],
-    "packagePath": "packages"
-  },
+  "commitMessage": "chore: release ${packageName}@${version} [skip ci]",
+  "updateChangelog": true,
+  "changelogFormat": "keep-a-changelog",
+  "synced": true,
+  "skip": [
+    "docs",
+    "e2e"
+  ],
+  "packages": ["packages/*"],
+  "mainPackage": "primary-package",
   "cargo": {
     "enabled": true,
     "paths": ["src/", "crates/"]
@@ -114,13 +117,28 @@ Customize behavior by creating a `version.config.json` file in your project root
 }
 ```
 
-**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.
-- The `cargo` options can help when working with Rust projects:
-  - `enabled` (default: `true`): Set to `false` to disable Cargo.toml version handling
-  - `paths` (optional): Specify directories to search for Cargo.toml files
+### Configuration Options
+
+#### General Options (All Projects)
+- `preset`: Conventional commits preset to use for version calculation (default: "angular")
+- `versionPrefix`: Prefix for version numbers in tags (default: "v")
+- `tagTemplate`: Template for Git tags (default: "${prefix}${version}")
+- `commitMessage`: Template for commit messages (default: "chore(release): ${version}")
+- `updateChangelog`: Whether to automatically update changelogs (default: true)
+- `changelogFormat`: Format for changelogs - "keep-a-changelog" or "angular" (default: "keep-a-changelog")
+- `cargo`: Options for Rust projects:
+  - `enabled`: Whether to handle Cargo.toml files (default: true)
+  - `paths`: Directories to search for Cargo.toml files (optional)
+
+#### Monorepo-Specific Options
+- `synced`: Whether all packages should be versioned together (default: true)
+- `skip`: Array of package names to exclude from versioning
+- `packages`: Glob patterns for package discovery (e.g., ["packages/*"])
+- `mainPackage`: Package name whose commit history should drive version determination
+- `packageTagTemplate`: Template for package-specific Git tags (default: "${packageName}@${prefix}${version}")
+- `updateInternalDependencies`: How to update internal dependencies ("patch", "minor", "major", or "inherit")
+
+For more details on CI/CD integration and advanced usage, see [CI/CD Integration](./docs/CI_CD_INTEGRATION.md).
 
 ## How Versioning Works
 
@@ -129,12 +147,13 @@ Customize behavior by creating a `version.config.json` file in your project root
 1.  **Conventional Commits:** Analyzes commit messages (like `feat:`, `fix:`, `BREAKING CHANGE:`) since the last tag.
 2.  **Branch Pattern:** Determines the bump based on the current or recently merged branch name matching predefined patterns.
 
-For a detailed explanation of these concepts and monorepo modes (Synced vs. Async), see [Versioning Strategies and Concepts](./docs/VERSIONING_STRATEGIES.md).
+For a detailed explanation of these concepts and monorepo modes (Synced vs. Async), see [Versioning Strategies and Concepts](./docs/versioning.md).
 
 ## Documentation
 
-- [Versioning Strategies and Concepts](./docs/VERSIONING_STRATEGIES.md) - Detailed explanation of versioning approaches
-- [CI/CD Integration](./docs/CI_CD_INTEGRATION.md) - Guide for integrating with CI/CD pipelines
+- [Versioning Strategies and Concepts](./docs/versioning.md) - Detailed explanation of versioning approaches
+- [CI/CD Integration](./docs/ci_cd_integration.md) - Guide for integrating with CI/CD pipelines
+- [Changelog Generation](./docs/changelogs.md) - How changelogs are automatically generated and maintained
 
 For more details on available CLI options, run:
 
@@ -148,4 +167,4 @@ This project was originally forked from and inspired by [`jucian0/turbo-version`
 
 ## License
 
-MIT
+MIT