chore(release): update changelog and readme

- Improved table formatting in README
- Removed redundant lines in workflow
- Added docstrings to ChangelogService
- Updated README table structure
- Minor README and workflow cleanup

Author: taj54

.github/workflows/version-bump.yaml

@@ -17,8 +17,6 @@ on:
           - minor
           - major
 
-
-
 jobs:
   bump:
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -320,4 +320,4 @@ All notable changes for each version of the Ambient Music extension.
 - CI: Keep the versions up-to-date.
 - Updated.
 - Build: Update build script.
-- Updated readme.
+- Updated readme.

README.md

@@ -14,14 +14,14 @@ This action will automatically detect the version file and bump the version acco
 
 The action will first try to detect the platform of the project by looking for common version files in the root directory. The following files are supported:
 
-| Platform | Version File |
-| --- | --- |
-| Docker | `Dockerfile` |
-| Go | `go.mod` |
-| Node | `package.json` |
-| PHP | `composer.json` |
-| Python | `pyproject.toml`, `setup.py` |
-| Rust | `Cargo.toml` |
+| Platform | Version File                 |
+| -------- | ---------------------------- |
+| Docker   | `Dockerfile`                 |
+| Go       | `go.mod`                     |
+| Node     | `package.json`               |
+| PHP      | `composer.json`              |
+| Python   | `pyproject.toml`, `setup.py` |
+| Rust     | `Cargo.toml`                 |
 
 If a version file is found, the action will bump the version in that file. If no version file is found, the action will fail.
 
@@ -64,19 +64,19 @@ To explicitly target a platform, use the `target_platform` input:
 
 ## Inputs
 
-| Name | Description | Default |
-| --- | --- | --- |
-| `release_type` | Select the version bump type (patch, minor, major) | `patch` |
-| `git_tag` | Whether to create a Git tag after bump | `true` |
-| `target_platform` | Explicitly specify the platform to update (e.g., `node`, `python`). If not provided, the platform will be detected automatically. | `''` |
-| `target_path` | The target path where the version bump should be applied. If not provided, the action will run in the root directory. | `.` |
+| Name              | Description                                                                                                                       | Default |
+| ----------------- | --------------------------------------------------------------------------------------------------------------------------------- | ------- |
+| `release_type`    | Select the version bump type (patch, minor, major)                                                                                | `patch` |
+| `git_tag`         | Whether to create a Git tag after bump                                                                                            | `true`  |
+| `target_platform` | Explicitly specify the platform to update (e.g., `node`, `python`). If not provided, the platform will be detected automatically. | `''`    |
+| `target_path`     | The target path where the version bump should be applied. If not provided, the action will run in the root directory.             | `.`     |
 
 ## Outputs
 
-| Name | Description |
-| --- | --- |
-| `new_version` | The new bumped version |
-| `tag` | The created Git tag (if enabled) |
+| Name          | Description                      |
+| ------------- | -------------------------------- |
+| `new_version` | The new bumped version           |
+| `tag`         | The created Git tag (if enabled) |
 
 ## Example Workflow
 
@@ -100,8 +100,6 @@ on:
           - minor
           - major
 
-
-
 jobs:
   bump:
     runs-on: ubuntu-latest
@@ -118,7 +116,6 @@ jobs:
           git_tag: false
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
 ```
 
 ## Development
@@ -135,4 +132,4 @@ This project is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).
 
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

dist/index.js

@@ -6,7 +6,7 @@
  * Author: Taj <[email protected]>
  * Homepage: https://github.com/taj54/universal-version-bump#readme
  * License: MIT
- * Generated on Tue, 26 Aug 2025 08:40:56 GMT
+ * Generated on Tue, 26 Aug 2025 10:10:42 GMT
  */
 require('./sourcemap-register.js');/******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
@@ -32918,10 +32918,17 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.ChangelogService = void 0;
 const exec = __importStar(__nccwpck_require__(8872));
+/**
+ * Service for managing the changelog file.
+ */
 class ChangelogService {
     constructor(fileHandler) {
         this.fileHandler = fileHandler;
     }
+    /**
+     * Get the latest git tag.
+     * @returns The latest tag as a string.
+     */
     async getLatestTag() {
         let latestTag = '';
         const options = {
@@ -32934,6 +32941,11 @@ class ChangelogService {
         await exec.exec('git', ['describe', '--tags', '--abbrev=0'], options);
         return latestTag.trim();
     }
+    /**
+     * Get the commits since a specific tag.
+     * @param tag The tag to get commits since.
+     * @returns An array of commit messages.
+     */
     async getCommitsSinceTag(tag) {
         let commits = '';
         const options = {
@@ -32946,20 +32958,28 @@ class ChangelogService {
         await exec.exec('git', ['log', `${tag}..HEAD`, '--oneline'], options);
         return commits.split('\n').filter(Boolean);
     }
+    /**
+     * Generate a changelog from the given commits.
+     * @param commits The list of commits to include in the changelog.
+     * @param newVersion The new version number.
+     * @returns The generated changelog as a string.
+     */
     generateChangelog(commits, newVersion) {
         const changelogDate = new Date().toISOString().split('T')[0];
         let changelogContent = `## v${newVersion} ${changelogDate}\n\n`;
         const categorizedCommits = { Added: [], Changed: [], Fixed: [] };
         for (const commit of commits) {
             const commitMessage = commit.split(' ').slice(1).join(' ');
+            const messageParts = commitMessage.split(':');
+            const message = messageParts.length > 1 ? messageParts.slice(1).join(':').trim() : commitMessage;
             if (commitMessage.startsWith('feat') || commitMessage.startsWith('Added')) {
-                categorizedCommits.Added.push(`- ${commitMessage}`);
+                categorizedCommits.Added.push(`- ${message}`);
             }
             else if (commitMessage.startsWith('fix') || commitMessage.startsWith('Fixed')) {
-                categorizedCommits.Fixed.push(`- ${commitMessage}`);
+                categorizedCommits.Fixed.push(`- ${message}`);
             }
             else {
-                categorizedCommits.Changed.push(`- ${commitMessage}`);
+                categorizedCommits.Changed.push(`- ${message}`);
             }
         }
         for (const category in categorizedCommits) {
@@ -32970,6 +32990,10 @@ class ChangelogService {
         }
         return changelogContent;
     }
+    /**
+     * Update the changelog file with the new content.
+     * @param changelogContent The new changelog content to add.
+     */
     async updateChangelog(changelogContent) {
         const changelogPath = 'CHANGELOG.md';
         const existingChangelog = await this.fileHandler.readFile(changelogPath);

dist/index.js.map

@@ -53,4 +53,4 @@
     "vitest": "^3.2.4",
     "yaml": "^2.8.1"
   }
-}
+}