vnxt 1.7.7 → 1.9.0

package/README.md

@@ -1,452 +1,503 @@
-<p>
-  <img src="./docs/logos/vnxt_light_logo.png" alt="vnxt logo" width="200">
-</p>
-
-# vnxt (vx)
-
-A lightweight CLI tool for automated version bumping with changelog generation and git integration.
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Features
-
-- 🚀 Automatic semantic version detection from commit messages
-- 📝 Automatic CHANGELOG.md generation
-- 🏷️ Git tag annotation
-- 🔍 Pre-flight checks for clean working directory
-- 🔬 Dry-run mode to preview changes
-- 📋 Release notes generation
-- ⚙️ Project-level configuration support
-- 💬 Interactive mode when no arguments provided
-- 🎨 Colored terminal output for better readability
-- 🤫 Quiet mode for CI/CD environments
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Installation
-
-### Global Installation
-
-**Bash/PowerShell:**
-```bash
-npm install -g vnxt
-```
-
-After installation, you can use either `vnxt` or the shorter alias `vx`:
-```bash
-vnxt --help
-vx --help  # Same thing, shorter!
-```
-
-### Local Installation (from source)
-
-**Bash/macOS/Linux:**
-```bash
-# Clone the repository
-git clone https://github.com/n-orrow/vnxt.git
-cd vnxt
-
-# Install globally via npm link
-chmod +x vnxt.js
-npm link
-```
-
-**PowerShell/Windows:**
-```powershell
-# Clone the repository
-git clone https://github.com/n-orrow/vnxt.git
-cd vnxt
-
-# Install globally via npm link
-npm link
-```
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Usage
-
-### Basic Examples
-
-**Bash/PowerShell:**
-```bash
-# Simple version bump (auto-detects patch from "fix:")
-vnxt -m "fix: resolve RFID reader bug"
-# or use the shorter alias:
-vx -m "fix: resolve RFID reader bug"
-
-# Feature addition (auto-detects minor from "feat:")
-vx -m "feat: add heatmap visualization"
-
-# Breaking change (auto-detects major from "BREAKING")
-vx -m "BREAKING: redesign API structure"
-
-# With changelog and push to remote
-vx -m "feat: add new dashboard" -c -p
-
-# Interactive mode (prompts for input)
-vx
-```
-
-### Command Line Options
-
-All options work with both `vnxt` and `vx`:
-
-```
--m, --message <msg>      Commit message (required unless using interactive mode)
--t, --type <type>        Version type: patch, minor, major (auto-detected from message)
--v, --version <ver>      Set specific version (e.g., 2.0.0-beta.1)
--V, --version            Show vnxt version
--p, --push              Push to remote with tags
--dnp, --no-push          Prevent auto-push (overrides config)
--c, --changelog         Update CHANGELOG.md
--d, --dry-run           Show what would happen without making changes
--a, --all [mode]        Stage files before versioning (prompts if no mode)
-                        Modes: tracked, all, interactive (i), patch (p)
--r, --release           Generate release notes file
--q, --quiet             Minimal output (errors only)
--h, --help              Show help message
-```
-
-### Automatic Version Detection
-
-vnxt automatically detects the version bump type from your commit message:
-
-- `major:` → **major** version bump
-- `minor:` → **minor** version bump
-- `patch:` → **patch** version bump
-- `feat:` or `feature:` → **minor** version bump
-- `fix:` → **patch** version bump
-- `BREAKING:` or contains `BREAKING` → **major** version bump
-
-You can override this with the `-t` flag.
-
-### Dry Run
-
-Preview what will happen without making changes:
-
-**Bash/PowerShell:**
-```bash
-vx -m "feat: new feature" -d
-```
-
-Output:
-```
-🔬 DRY RUN MODE - No changes will be made
-
-Would perform the following actions:
-  1. Bump minor version
-  2. Commit with message: "feat: new feature"
-  3. Create git tag with annotation
-  4. (Skipping push - use --push to enable)
-
-✓ Dry run complete. Use without -d to apply changes.
-```
-
-### Custom Versions
-
-Set a specific version number (useful for pre-releases):
-
-**Bash/PowerShell:**
-```bash
-vx -v 2.0.0-beta.1 -m "beta: initial release candidate"
-vx -v 1.5.0-rc.2 -m "release candidate 2"
-```
-
-### Changelog Generation
-
-Automatically update CHANGELOG.md with version history:
-
-**Bash/PowerShell:**
-```bash
-vx -m "feat: add user authentication" -c
-```
-
-Creates/updates CHANGELOG.md:
-```markdown
-# Changelog
-
-## [1.2.0] - 2024-02-10
-- feat: add user authentication
-
-## [1.1.0] - 2024-02-09
-- feat: add dashboard
-```
-
-### Release Notes
-
-Generate a formatted release notes file:
-
-**Bash/PowerShell:**
-```bash
-vx -m "feat: major feature release" -r
-```
-
-Creates `release-notes-v1.2.0.md`:
-```markdown
-# Release v1.2.0
-
-Released: 2024-02-10
-
-## Changes
-feat: major feature release
-
-## Installation
-npm install your-package@1.2.0
-```
-
-### File Staging Options
-
-vnxt offers flexible file staging with the `-a` flag:
-
-**Bash/PowerShell:**
-```bash
-# Interactive prompt (asks which mode to use)
-vx -m "chore: update" -a
-
-# Specific modes
-vx -m "fix: bug" -a tracked      # Stage tracked files only (git add -u)
-vx -m "feat: new" -a all         # Stage all changes (git add -A)
-vx -m "refactor: code" -a i      # Interactive selection (git add -i)
-vx -m "fix: typo" -a p           # Patch mode (git add -p)
-```
-
-**Staging Modes:**
-- `tracked` - Only staged tracked files that have been modified/deleted (default)
-- `all` - Stages all changes, respects `.gitignore` for new files
-- `interactive` or `i` - Opens git's interactive staging mode
-- `patch` or `p` - Opens patch mode for selective staging
-
-**Note:** If you run `vx` without any files staged and without the `-a` flag, vnxt will prompt you interactively to choose a staging mode.
-
-### Quiet Mode
-
-Minimize terminal output for CI/CD environments:
-
-**Bash/PowerShell:**
-```bash
-vx -m "feat: new feature" -q
-```
-
-In quiet mode:
-- ✅ Errors still display
-- ❌ Progress messages hidden
-- ❌ Summary stats hidden
-- ❌ Git diff output hidden
-
-Perfect for automated workflows where you only want to see failures.
-
-### Check Version
-
-Display the installed vnxt version:
-
-**Bash/PowerShell:**
-```bash
-vx -V
-# or
-vnxt --version
-```
-
-Output:
-```
-vnxt v1.7.0
-```
-
-### Complete Workflow Example
-
-**Bash/PowerShell:**
-```bash
-# Make changes to your code
-# ...
-
-# Dry run to preview
-vx -m "feat: add new API endpoint" -d
-
-# Execute with changelog, release notes, and push
-vx -m "feat: add new API endpoint" -c -r -p
-```
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Configuration
-
-Create a `.vnxtrc.json` file in your project root to set defaults:
-```json
-{
-  "autoChangelog": true,
-  "defaultType": "patch",
-  "requireCleanWorkingDir": false,
-  "autoPush": true,
-  "defaultStageMode": "tracked",
-  "tagPrefix": "v",
-  "colors": true
-}
-```
-
-### Configuration Options
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `autoChangelog` | boolean | `true` | Automatically update CHANGELOG.md on every bump |
-| `defaultType` | string | `"patch"` | Default version bump type if not auto-detected |
-| `requireCleanWorkingDir` | boolean | `false` | Require clean git working directory before bumping |
-| `autoPush` | boolean | `true` | Automatically push to remote after bumping |
-| `defaultStageMode` | string | `"tracked"` | Default staging mode when using `-a` flag |
-| `tagPrefix` | string | `"v"` | Prefix for git tags (e.g., "v1.2.3") |
-| `colors` | boolean | `true` | Enable colored terminal output |
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Pre-flight Checks
-
-vnxt performs several checks before making changes:
-
-- ✅ Verifies no uncommitted changes (unless using `-a`)
-- ✅ Warns if not on main/master branch
-- ✅ Checks for remote repository (if pushing)
-
-Example output:
-```
-🔍 Running pre-flight checks...
-
-⚠️  Warning: You're on branch 'feature/new-dashboard', not main/master
-✅ Pre-flight checks passed
-```
-
-## Interactive Mode
-
-Run `vnxt` (or `vx`) without arguments for guided prompts:
-
-**Bash/PowerShell:**
-```bash
-vx
-```
-
-Output:
-```
-🤔 Interactive mode
-
-Commit message: feat: add new feature
-Version type (patch/minor/major) [patch]: minor
-
-📝 Auto-detected: minor version bump (feature)
-
-🔍 Running pre-flight checks...
-...
-```
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Workflow Examples
-
-### Quick Fix
-
-**Bash/PowerShell:**
-```bash
-vx -m "fix: resolve login bug"
-```
-
-### Feature Release
-
-**Bash/PowerShell:**
-```bash
-vx -m "feat: add dashboard analytics" -c -p
-```
-
-### Major Release with Full Documentation
-
-**Bash/PowerShell:**
-```bash
-vx -m "BREAKING: new API structure" -c -r -p
-```
-
-### Local Development (No Push)
-
-**Bash/PowerShell:**
-```bash
-vx -m "chore: refactor code" -a
-```
-
-### CI/CD Pipeline
-
-**Bash/PowerShell:**
-```bash
-# Quiet mode - only shows errors
-vx -m "chore: automated update" -q
-```
-
-### Check Installed Version
-
-**Bash/PowerShell:**
-```bash
-vx -V
-```
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Troubleshooting
-
-### Not a Git Repository
-
-If you see this error:
-```
-❌ Not a git repository. Run `git init` first.
-```
-
-You're trying to use vnxt in a directory that isn't a git repository. Initialize git first:
-
-**Bash/PowerShell:**
-```bash
-git init
-```
-
-### Permission Denied (Windows PowerShell)
-
-If you get execution policy errors:
-```powershell
-Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
-```
-
-### Uncommitted Changes Error
-
-Either commit your changes first, or use the `-a` flag to stage all changes:
-
-**Bash/PowerShell:**
-```bash
-vx -m "your message" -a
-```
-
-### Command Not Found After Installation
-
-Make sure npm's global bin directory is in your PATH:
-
-**Bash:**
-```bash
-npm config get prefix
-# Add the bin subdirectory to your PATH
-```
-
-**PowerShell:**
-```powershell
-npm config get prefix
-# Add the bin subdirectory to your PATH in System Environment Variables
-```
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Requirements
-
-- Node.js 12.x or higher
-- npm 6.x or higher
-- Git installed and configured
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Version Management
-
-This project uses [vnxt](https://vnxt.dev) for version bumping with the following configuration:
-
-- Auto-push enabled (`autoPush: true`)
-- Auto-changelog enabled (`autoChangelog: true`)
-- Clean working directory not required (`requireCleanWorkingDir: false`)
-
-See `.vnxtrc.json` for full configuration.
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Author
-
-Nate Orrow - Software Developer
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> License
-
-MIT License - see [LICENSE](LICENSE) file for details
-
-## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Contributing
-
-Contributions are welcome! Please feel free to submit a Pull Request.
-
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feature/amazing-feature`)
-3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
-4. Push to the branch (`git push origin feature/amazing-feature`)
+<p>
+  <img src="./docs/logos/vnxt_light_logo.png" alt="vnxt logo" width="200">
+</p>
+
+# vnxt (vx)
+
+A lightweight CLI tool for automated version bumping with changelog generation and git integration.
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Features
+
+- 🚀 Automatic semantic version detection from commit messages
+- 📝 Automatic CHANGELOG.md generation
+- 🏷️ Git tag annotation with configurable prefix
+- 🔍 Pre-flight checks for clean working directory
+- 🔬 Dry-run mode to preview changes
+- 📋 Release notes generation
+- ⚙️ Project-level configuration support
+- 💬 Interactive mode when no arguments provided
+- 🎨 Colored terminal output for better readability
+- 🤫 Quiet mode for CI/CD environments
+- 📦 Automated npm publishing via GitHub Actions Trusted Publishing
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Installation
+
+### Global Installation
+
+**Bash/PowerShell:**
+```bash
+npm install -g vnxt
+```
+
+After installation, you can use either `vnxt` or the shorter alias `vx`:
+```bash
+vnxt --help
+vx --help  # Same thing, shorter!
+```
+
+### Local Installation (from source)
+
+**Bash/macOS/Linux:**
+```bash
+# Clone the repository
+git clone https://github.com/n-orrow/vnxt.git
+cd vnxt
+
+# Install globally via npm link
+chmod +x vnxt.js
+npm link
+```
+
+**PowerShell/Windows:**
+```powershell
+# Clone the repository
+git clone https://github.com/n-orrow/vnxt.git
+cd vnxt
+
+# Install globally via npm link
+npm link
+```
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Usage
+
+### Basic Examples
+
+**Bash/PowerShell:**
+```bash
+# Simple version bump (auto-detects patch from "fix:")
+vnxt -m "fix: resolve RFID reader bug"
+# or use the shorter alias:
+vx -m "fix: resolve RFID reader bug"
+
+# Feature addition (auto-detects minor from "feat:")
+vx -m "feat: add heatmap visualization"
+
+# Breaking change (auto-detects major from "BREAKING")
+vx -m "BREAKING: redesign API structure"
+
+# With changelog and push to remote
+vx -m "feat: add new dashboard" -c -p
+
+# Interactive mode (prompts for input)
+vx
+```
+
+### Command Line Options
+
+All options work with both `vnxt` and `vx`:
+
+```
+-m, --message <msg>      Commit message (required unless using interactive mode)
+-t, --type <type>        Version type: patch, minor, major (auto-detected from message)
+-v, --version <ver>      Set specific version (e.g., 2.0.0-beta.1)
+-V, --version            Show vnxt version
+-p, --push              Push to remote with tags
+-dnp, --no-push          Prevent auto-push (overrides config)
+--publish               Push and trigger npm publish via GitHub Actions
+-c, --changelog         Update CHANGELOG.md
+-d, --dry-run           Show what would happen without making changes
+-a, --all [mode]        Stage files before versioning (prompts if no mode)
+                        Modes: tracked, all, interactive (i), patch (p)
+-r, --release           Generate release notes file
+-q, --quiet             Minimal output (errors only)
+-h, --help              Show help message
+```
+
+### Automatic Version Detection
+
+vnxt automatically detects the version bump type from your commit message:
+
+- `major:` → **major** version bump
+- `minor:` → **minor** version bump
+- `patch:` → **patch** version bump
+- `feat:` or `feature:` → **minor** version bump
+- `fix:` → **patch** version bump
+- `BREAKING:` or contains `BREAKING` → **major** version bump
+
+You can override this with the `-t` flag.
+
+### Dry Run
+
+Preview what will happen without making changes:
+
+**Bash/PowerShell:**
+```bash
+vx -m "feat: new feature" -d
+```
+
+Output:
+```
+🔬 DRY RUN MODE - No changes will be made
+
+Would perform the following actions:
+  1. Bump minor version
+  2. Commit with message: "feat: new feature"
+  3. Create git tag with annotation
+  4. (Skipping push - use --push to enable)
+
+✓ Dry run complete. Use without -d to apply changes.
+```
+
+### Custom Versions
+
+Set a specific version number (useful for pre-releases):
+
+**Bash/PowerShell:**
+```bash
+vx -v 2.0.0-beta.1 -m "beta: initial release candidate"
+vx -v 1.5.0-rc.2 -m "release candidate 2"
+```
+
+### Changelog Generation
+
+Automatically update CHANGELOG.md with version history:
+
+**Bash/PowerShell:**
+```bash
+vx -m "feat: add user authentication" -c
+```
+
+Creates/updates CHANGELOG.md:
+```markdown
+# Changelog
+
+## [1.2.0] - 2024-02-10
+- feat: add user authentication
+
+## [1.1.0] - 2024-02-09
+- feat: add dashboard
+```
+
+### Release Notes
+
+Generate a formatted release notes file:
+
+**Bash/PowerShell:**
+```bash
+vx -m "feat: major feature release" -r
+```
+
+Creates `release-notes-v1.2.0.md`:
+```markdown
+# Release v1.2.0
+
+Released: 2024-02-10
+
+## Changes
+feat: major feature release
+
+## Installation
+npm install your-package@1.2.0
+```
+
+### File Staging Options
+
+vnxt offers flexible file staging with the `-a` flag:
+
+**Bash/PowerShell:**
+```bash
+# Interactive prompt (asks which mode to use)
+vx -m "chore: update" -a
+
+# Specific modes
+vx -m "fix: bug" -a tracked      # Stage tracked files only (git add -u)
+vx -m "feat: new" -a all         # Stage all changes (git add -A)
+vx -m "refactor: code" -a i      # Interactive selection (git add -i)
+vx -m "fix: typo" -a p           # Patch mode (git add -p)
+```
+
+**Staging Modes:**
+- `tracked` - Only staged tracked files that have been modified/deleted (default)
+- `all` - Stages all changes, respects `.gitignore` for new files
+- `interactive` or `i` - Opens git's interactive staging mode
+- `patch` or `p` - Opens patch mode for selective staging
+
+**Note:** If you run `vx` without any files staged and without the `-a` flag, vnxt will prompt you interactively to choose a staging mode.
+
+### Quiet Mode
+
+Minimize terminal output for CI/CD environments:
+
+**Bash/PowerShell:**
+```bash
+vx -m "feat: new feature" -q
+```
+
+In quiet mode:
+- ✅ Errors still display
+- ❌ Progress messages hidden
+- ❌ Summary stats hidden
+- ❌ Git diff output hidden
+
+Perfect for automated workflows where you only want to see failures.
+
+### Check Version
+
+Display the installed vnxt version:
+
+**Bash/PowerShell:**
+```bash
+vx -V
+# or
+vnxt --version
+```
+
+Output:
+```
+vnxt v1.8.0
+```
+
+### npm Publish
+
+Trigger an automated npm publish via GitHub Actions using Trusted Publishing (OIDC):
+
+**Bash/PowerShell:**
+```bash
+vx -m "feat: new feature" --publish
+```
+
+This will:
+1. Bump the version and commit
+2. Push with a standard `v*` tag
+3. Push an additional `publish/v*` tag
+4. GitHub Actions detects the `publish/v*` tag and publishes to npm automatically
+
+This means you can batch up multiple changes without publishing to npm each time:
+```bash
+vx -m "feat: add something"         # bump only
+vx -m "fix: fix something"          # bump only
+vx -m "feat: final thing" --publish # bump + publish everything
+```
+
+**Note:** `--publish` implies `--push`, so `-p` is not required.
+
+### Custom Tag Prefix
+
+Control the prefix used for git tags via `.vnxtrc.json`:
+
+```json
+{
+  "tagPrefix": "v"
+}
+```
+
+**Options:**
+- `"v"` → `v1.8.0` (default)
+- `""` → `1.8.0` (no prefix)
+- `"release-"` → `release-1.8.0` (useful in monorepos)
+
+### Complete Workflow Example
+
+**Bash/PowerShell:**
+```bash
+# Make changes to your code
+# ...
+
+# Dry run to preview
+vx -m "feat: add new API endpoint" -d
+
+# Execute with changelog, release notes, and push
+vx -m "feat: add new API endpoint" -c -r -p
+```
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Configuration
+
+Create a `.vnxtrc.json` file in your project root to set defaults:
+```json
+{
+  "autoChangelog": true,
+  "defaultType": "patch",
+  "requireCleanWorkingDir": false,
+  "autoPush": true,
+  "defaultStageMode": "tracked",
+  "tagPrefix": "v",
+  "colors": true
+}
+```
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `autoChangelog` | boolean | `true` | Automatically update CHANGELOG.md on every bump |
+| `defaultType` | string | `"patch"` | Default version bump type if not auto-detected |
+| `requireCleanWorkingDir` | boolean | `false` | Require clean git working directory before bumping |
+| `autoPush` | boolean | `true` | Automatically push to remote after bumping |
+| `defaultStageMode` | string | `"tracked"` | Default staging mode when using `-a` flag |
+| `tagPrefix` | string | `"v"` | Prefix for git tags (e.g., "v1.2.3") |
+| `colors` | boolean | `true` | Enable colored terminal output |
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Pre-flight Checks
+
+vnxt performs several checks before making changes:
+
+- ✅ Verifies no uncommitted changes (unless using `-a`)
+- ✅ Warns if not on main/master branch
+- ✅ Checks for remote repository (if pushing)
+
+Example output:
+```
+🔍 Running pre-flight checks...
+
+⚠️  Warning: You're on branch 'feature/new-dashboard', not main/master
+✅ Pre-flight checks passed
+```
+
+## Interactive Mode
+
+Run `vnxt` (or `vx`) without arguments for guided prompts:
+
+**Bash/PowerShell:**
+```bash
+vx
+```
+
+Output:
+```
+🤔 Interactive mode
+
+Commit message: feat: add new feature
+Version type (patch/minor/major) [patch]: minor
+
+📝 Auto-detected: minor version bump (feature)
+
+🔍 Running pre-flight checks...
+...
+```
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Workflow Examples
+
+### Quick Fix
+
+**Bash/PowerShell:**
+```bash
+vx -m "fix: resolve login bug"
+```
+
+### Feature Release
+
+**Bash/PowerShell:**
+```bash
+vx -m "feat: add dashboard analytics" -c -p
+```
+
+### Major Release with Full Documentation
+
+**Bash/PowerShell:**
+```bash
+vx -m "BREAKING: new API structure" -c -r -p
+```
+
+### Local Development (No Push)
+
+**Bash/PowerShell:**
+```bash
+vx -m "chore: refactor code" -a
+```
+
+### CI/CD Pipeline
+
+**Bash/PowerShell:**
+```bash
+# Quiet mode - only shows errors
+vx -m "chore: automated update" -q
+```
+
+### Publish to npm
+
+**Bash/PowerShell:**
+```bash
+# Batch changes then publish when ready
+vx -m "feat: add feature one"
+vx -m "fix: fix something"
+vx -m "feat: final feature" --publish
+```
+
+### Check Installed Version
+
+**Bash/PowerShell:**
+```bash
+vx -V
+```
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Troubleshooting
+
+### Not a Git Repository
+
+If you see this error:
+```
+❌ Not a git repository. Run `git init` first.
+```
+
+You're trying to use vnxt in a directory that isn't a git repository. Initialize git first:
+
+**Bash/PowerShell:**
+```bash
+git init
+```
+
+### Permission Denied (Windows PowerShell)
+
+If you get execution policy errors:
+```powershell
+Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
+```
+
+### Uncommitted Changes Error
+
+Either commit your changes first, or use the `-a` flag to stage all changes:
+
+**Bash/PowerShell:**
+```bash
+vx -m "your message" -a
+```
+
+### Command Not Found After Installation
+
+Make sure npm's global bin directory is in your PATH:
+
+**Bash:**
+```bash
+npm config get prefix
+# Add the bin subdirectory to your PATH
+```
+
+**PowerShell:**
+```powershell
+npm config get prefix
+# Add the bin subdirectory to your PATH in System Environment Variables
+```
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Requirements
+
+- Node.js 12.x or higher
+- npm 6.x or higher
+- Git installed and configured
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Version Management
+
+This project uses [vnxt](https://vnxt.dev) for version bumping with the following configuration:
+
+- Auto-push enabled (`autoPush: true`)
+- Auto-changelog enabled (`autoChangelog: true`)
+- Clean working directory not required (`requireCleanWorkingDir: false`)
+
+See `.vnxtrc.json` for full configuration.
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Author
+
+Nate Orrow - Software Developer
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> License
+
+MIT License - see [LICENSE](LICENSE) file for details
+
+## <img src="./docs/logos/caret-38x38.png" width="24" align="center"> Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
 5. Open a Pull Request

package/package.json

@@ -1,46 +1,46 @@
-{
-  "name": "vnxt",
-  "version": "1.7.7",
-  "description": "Version incrementation CLI tool with built in git commit, push and changelog generation",
-  "main": "vnxt.js",
-  "bin": {
-    "vnxt": "./vnxt.js",
-    "vx": "./vnxt.js"
-  },
-  "scripts": {
-    "test": "jest",
-    "release": "vnxt -m 'release' -c -p"
-  },
-  "keywords": [
-    "version",
-    "bump",
-    "semver",
-    "git",
-    "changelog",
-    "cli",
-    "release",
-    "npm"
-  ],
-  "author": "Nate Orrow | Nate@Orrow.uk",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/n-orrow/vnxt.git"
-  },
-  "bugs": {
-    "url": "https://github.com/n-orrow/vnxt/issues"
-  },
-  "homepage": "https://vnxt.dev",
-  "engines": {
-    "node": ">=12.0.0"
-  },
-  "files": [
-    "vnxt.js",
-    ".vnxtrc.json",
-    "README.md",
-    "LICENSE"
-  ],
-  "devDependencies": {
-    "jest": "^29.7.0"
-  }
-}
+{
+  "name": "vnxt",
+  "version": "1.9.0",
+  "description": "Version incrementation CLI tool with built in git commit, push and changelog generation",
+  "main": "vnxt.js",
+  "bin": {
+    "vnxt": "vnxt.js",
+    "vx": "vnxt.js"
+  },
+  "scripts": {
+    "test": "jest",
+    "release": "vnxt -m 'release' -c -p"
+  },
+  "keywords": [
+    "version",
+    "bump",
+    "semver",
+    "git",
+    "changelog",
+    "cli",
+    "release",
+    "npm"
+  ],
+  "author": "Nate Orrow | Nate@Orrow.uk",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/n-orrow/vnxt.git"
+  },
+  "bugs": {
+    "url": "https://github.com/n-orrow/vnxt/issues"
+  },
+  "homepage": "https://vnxt.dev",
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "files": [
+    "vnxt.js",
+    ".vnxtrc.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "jest": "^29.7.0"
+  }
+}

package/vnxt.js

@@ -9,7 +9,7 @@ const colors = {
     reset: '\x1b[0m',
     bright: '\x1b[1m',
     dim: '\x1b[2m',
-    
+
     // Foreground colors
     red: '\x1b[31m',
     green: '\x1b[32m',
@@ -97,7 +97,8 @@ let type = getFlag('--type', '-t') || config.defaultType;
 let customVersion = getFlag('--version', '-v');
 let dryRun = hasFlag('--dry-run', '-d');
 let noPush = hasFlag('--no-push', '-dnp');
-let push = noPush ? false : (hasFlag('--push', '-p') || config.autoPush);
+let publishToNpm = hasFlag('--publish');
+let push = noPush ? false : (hasFlag('--push', '-p') || publishToNpm || config.autoPush);
 let generateChangelog = hasFlag('--changelog', '-c') || config.autoChangelog;
 const addAllFlag = getFlag('--all', '-a');
 let addMode = null;
@@ -196,6 +197,22 @@ async function main() {
             process.exit(1);
         }
 
+        // AUTO-REQUIRE RELEASE NOTES for --publish
+        let releaseNotesContext = '';
+        const requireReleaseNotes = !generateReleaseNotes && publishToNpm;
+        if (requireReleaseNotes) {
+            generateReleaseNotes = true;
+            if (!quietMode) {
+                log(`\n📋 Release notes required for --publish.`, 'yellow');
+                releaseNotesContext = await prompt('   Add context (press Enter to skip): ');
+                if (releaseNotesContext) log('');
+            }
+        } else if (generateReleaseNotes && !quietMode) {
+            // -r flag was passed explicitly - still offer context prompt
+            releaseNotesContext = await prompt('\n📋 Add context to release notes (press Enter to skip): ');
+            if (releaseNotesContext) log('');
+        }
+
         // PRE-FLIGHT CHECKS
         log('\n🔍 Running pre-flight checks...\n', 'cyan');
 
@@ -364,12 +381,24 @@ async function main() {
         // GENERATE RELEASE NOTES
         if (generateReleaseNotes) {
             log('📋 Generating release notes...', 'cyan');
+
+            const date = new Date();
+            const timestamp = date.toISOString().replace('T', ' ').split('.')[0] + ' UTC';
+            const dateShort = date.toISOString().split('T')[0];
+
+            let author = '';
+            try {
+                author = execSync('git config user.name', {stdio: 'pipe'}).toString().trim();
+            } catch {
+                author = '';
+            }
+
             const releaseNotes = `# Release ${config.tagPrefix}${newVersion}
 
-Released: ${new Date().toISOString().split('T')[0]}
+Released: ${dateShort} at ${timestamp.split(' ')[1]}${author ? `\nAuthor: ${author}` : ''}
 
 ## Changes
-${message}
+${message}${releaseNotesContext ? `\n\n## Release Notes\n${releaseNotesContext}` : ''}
 
 ## Installation
 \`\`\`bash
@@ -389,6 +418,14 @@ See [CHANGELOG.md](./CHANGELOG.md) for complete version history.
         if (push) {
             log('🚀 Pushing to remote...', 'cyan');
             execSync('git push --follow-tags', {stdio: quietMode ? 'pipe' : 'inherit'});
+
+            // If --publish flag, also push a publish/v* tag to trigger npm workflow
+            if (publishToNpm) {
+                log('📦 Pushing publish tag to trigger npm release...', 'cyan');
+                const publishTag = `publish/${config.tagPrefix}${newVersion}`;
+                execSync(`git tag ${publishTag}`, {stdio: 'pipe'});
+                execSync(`git push origin ${publishTag}`, {stdio: quietMode ? 'pipe' : 'inherit'});
+            }
         }
 
         // STATS/SUMMARY
@@ -410,6 +447,9 @@ See [CHANGELOG.md](./CHANGELOG.md) for complete version history.
 
         if (push) {
             log(`🚀 Remote: Pushed with tags`, 'green');
+            if (publishToNpm) {
+                log(`📦 npm: Publishing triggered (publish/${config.tagPrefix}${newVersion})`, 'green');
+            }
         } else {
             log(`📍 Remote: Not pushed (use --push to enable)`, 'gray');
         }
@@ -446,6 +486,7 @@ Options:
   -V, --version            Show vnxt version
   -p, --push               Push to remote with tags
   -dnp, --no-push          Prevent auto-push (overrides config)
+  --publish                Push and trigger npm publish via GitHub Actions
   -c, --changelog          Update CHANGELOG.md
   -d, --dry-run            Show what would happen without making changes
   -a, --all [mode]         Stage files before versioning
@@ -488,10 +529,11 @@ Examples:
   vx -m "fix: bug" -a i                   # Interactive git add
   vx -m "fix: bug" -a p                   # Patch mode
   vx -m "fix: bug" -q                     # Quiet mode (minimal output)
+  vx -m "feat: new feature" --publish     # Bump, push and trigger npm publish
   vx                                      # Interactive mode
 `);
     process.exit(0);
 }
 
 // Run main function
-main();
+main();