@programinglive/commiter 1.2.18 → 1.2.20

package/.github/workflows/publish.yml

@@ -19,7 +19,7 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: '20'
+          node-version: '24'
 
       - name: Update npm and configure registry
         run: |

package/CHANGELOG.md

@@ -2,6 +2,31 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.2.20](https://github.com/programinglive/commiter/compare/v1.2.19...v1.2.20) (2026-01-01)
+
+
+### 📝 Documentation
+
+* update release notes for v1.2.19 📋 ([87759c1](https://github.com/programinglive/commiter/commit/87759c13f3c2f76b8e381c0b2f3ab3338f07f422))
+
+
+### ✅ Tests
+
+* add comment for complete release test ([b87d0f5](https://github.com/programinglive/commiter/commit/b87d0f5c12e1d2ff18ec791d3f7acbfa121a26a8))
+
+### [1.2.19](https://github.com/programinglive/commiter/compare/v1.2.18...v1.2.19) (2026-01-01)
+
+
+### 📝 Documentation
+
+* finalize v1.2.18 release notes and website update ([034faa5](https://github.com/programinglive/commiter/commit/034faa5dcae1294b57fbaf2773ce14a085259724))
+* update README, restore PRD, and enhance website features ([451ef7b](https://github.com/programinglive/commiter/commit/451ef7bf0fff925e3589fa7a6c7dbe8e76c3e93d))
+
+
+### ✨ Features
+
+* enhance release process with clear git operation guidance and auto-commit option ([91171e2](https://github.com/programinglive/commiter/commit/91171e2d426650a2e74250b6b9a3c9a9b8bb875e))
+
 ### [1.2.18](https://github.com/programinglive/commiter/compare/v1.2.17...v1.2.18) (2026-01-01)
 
 

package/README.md

@@ -14,6 +14,8 @@ A standardized commit convention and release management tool for your repository
 - 📝 **Changelog Generation** - Automatic CHANGELOG.md with icons
 - 🔒 **Git Hooks** - Pre-commit and commit-msg validation via Husky
 - 🎨 **Icon Support** - Each commit type has a dedicated icon in releases
+- 🎯 **Enhanced Release Process** - Clear console guidance and optional auto-commit for release notes
+- 🤖 **AI-Optimized Workflow** - Built-in guidance for AI assistants with clear next steps and automated git operations
 
 ## Installation
 
@@ -116,6 +118,20 @@ For breaking changes:
 npm run release:major
 ```
 
+### Complete Release (Auto-commit & Push)
+
+For fully automated release with git operations:
+
+```bash
+npm run release:complete
+```
+
+This command:
+- Runs the standard release process
+- Automatically commits release notes with versioned message
+- Pushes changes to remote
+- Provides success confirmation
+
 ### Automatic Release
 
 Let `standard-version` determine the version bump based on commits:
@@ -124,6 +140,8 @@ Let `standard-version` determine the version bump based on commits:
 npm run release
 ```
 
+**Note**: This command shows clear guidance for git operations needed after release notes generation.
+
 ## What Happens During Release?
 
 1. 🧪 **Runs tests** - Detects your package manager and runs the `test` script automatically (tests only run during release, not on commit)
@@ -131,17 +149,49 @@ npm run release
 3. 📘 **Verifies documentation** – Warns if `docs/PRD.md` is missing so every project keeps an up-to-date PRD
 4. 🔢 **Bumps version** - Updates version in `package.json`
 5. 📝 **Updates changelog** - Generates `CHANGELOG.md` with icons
-6. 🏷️ **Creates tag** - Creates a git tag for the release
-7. 💾 **Commits release** - Commits changes with format: `chore(release): v1.2.3 🚀`
+6. 📋 **Generates release notes** - Creates and stages release notes entry
+7. 🏷️ **Creates tag** - Creates a git tag for the release
+8. 💾 **Commits release** - Commits changes with format: `chore(release): v1.2.3 🚀`
+9. 🎯 **Shows next steps** - Provides clear guidance for git operations needed
+
+## Release Notes Management
+
+### Standard Release (Manual Git Operations)
+
+When using `npm run release`, the tool provides clear console guidance:
+
+```
+🎯 Release notes generated and staged successfully!
+
+📋 NEXT STEPS REQUIRED:
+   ✅ Release notes have been staged for commit
+   🔄 You need to commit and push the release notes:
+      git commit -m "docs: update release notes for version"
+      git push
+
+💡 AI ASSISTANCE:
+   🤖 Use the dev-workflow MCP server to handle the commit and push automatically
+   📝 The release notes are now staged and ready for commit
+```
+
+### Complete Release (Automated Git Operations)
+
+Use `npm run release:complete` for full automation:
+- ✅ Release completed
+- ✅ Release notes generated
+- ✅ Changes committed
+- ✅ Changes pushed
 
 ## Push Your Release
 
-After running a release command, push to remote:
+After running a standard release command, push to remote:
 
 ```bash
 git push --follow-tags origin main
 ```
 
+For complete releases, pushing is handled automatically.
+
 ## Pre-commit Hooks
 
 The following hooks are automatically enforced:

package/docs/PRD.md

@@ -1,18 +1,44 @@
-# PRD: Usage Clarification and Automated Testing
+# PRD: Enhanced Release Process and AI-Optimized Workflow
 
 ## Overview
-Prevent users and AI assistants from misusing `@programinglive/commiter` as a generic git commit tool. Guide AI assistants toward the correct tool (@programinglive/dev-workflow-mcp-server) and ensure these safeguards are verified by automated tests.
+Enhance the release process with clear console guidance for git operations and optional auto-commit functionality. Improve AI assistant workflow with explicit next steps and automated git operations for release notes management.
 
 ## Problem
-AI assistants sometimes assume `@programinglive/commiter` is for committing files (e.g., `commiter "message"`). This fails because the tool is meant for setup and release orchestration. Automated verification of these safeguards was initially missing.
+After running `npm run release`, release notes are generated but users and AI assistants don't understand that manual git operations (add, commit, push) are required. The process needs clear console output to guide the next steps and optional automation for complete releases.
 
 ## Requirements
-- Display a warning banner if arguments are passed to `node index.js`.
-- Suggest standard `git commit` commands.
-- Provide a tip to use the MCP dev-workflow for AI assistants.
-- Update release script error messages to include the same tip.
-- **[NEW]** Implement automated tests to verify the above behavior across `index.js` and `scripts/release.cjs`.
+- Enhanced standard release script with clear console guidance for git operations
+- New complete release script that handles git operations automatically
+- AI-friendly workflow with explicit next steps and MCP server guidance
+- Clear visual indicators and structured console output
+- Version-aware commit messages for release notes
+- Error handling and fallback options
+
+## Features Added
+
+### Enhanced Standard Release (`npm run release`)
+- Clear console output showing release notes generation status
+- Structured "NEXT STEPS REQUIRED" section
+- Exact git commands needed for manual operations
+- AI assistance guidance with MCP server recommendations
+- Visual indicators with emojis for better readability
+
+### Complete Release (`npm run release:complete`)
+- Full automation of release process including git operations
+- Automatic detection of staged release notes changes
+- Version-aware commit messages (e.g., "docs: update release notes for v1.2.20 📋")
+- Automatic push to remote repository
+- Success confirmation with detailed status
+
+### AI-Optimized Workflow
+- Built-in guidance for AI assistants
+- Clear instructions for manual vs automated workflows
+- MCP server integration recommendations
+- Prevents confusion about required git operations
 
 ## Verification
-- Automated tests in `test/usage-warning.test.js`.
-- Manual verification of CLI output.
+- Manual testing of both release workflows
+- Verification of console output clarity and accuracy
+- Testing of complete release automation
+- Validation of AI-friendly guidance messages
+- Error handling verification for git operation failures

package/docs/release-notes/RELEASE_NOTES.md

@@ -4,7 +4,9 @@ This document summarizes every published version of `@programinglive/commiter`.
 
 | Version | Date | Highlights |
 |---------|------|------------|
-| 1.2.18 | 2026-01-01 | **release-notes:** add 1.2.17 entry (0a79779) |
+| 1.2.20 | 2026-01-01 | update release notes for v1.2.19 📋 (87759c1) |
+| 1.2.19 | 2026-01-01 | finalize v1.2.18 release notes and website update (034faa5) |
+| 1.2.18 | 2026-01-01 | Add usage safety warnings and MCP workflow tips |
 | 1.2.17 | 2025-12-26 | **web:** update homepage for v1.2.16 release (c4ba36e) |
 | 1.2.16 | 2025-12-13 | upgrade to node 20 and update npm for OIDC (5f7d9a0) |
 | 1.2.15 | 2025-12-13 | remove registry-url to fix OIDC auth conflict (c49b6e8) |
@@ -77,6 +79,23 @@ This document summarizes every published version of `@programinglive/commiter`.
 
 
 
+
+
+
+## 1.2.20 – 📝 Documentation
+
+Released on **2026-01-01**.
+
+- update release notes for v1.2.19 📋 (87759c1)
+- add comment for complete release test (b87d0f5)
+
+## 1.2.19 – 📝 Documentation
+
+Released on **2026-01-01**.
+
+- finalize v1.2.18 release notes and website update (034faa5)
+- update README, restore PRD, and enhance website features (451ef7b)
+- enhance release process with clear git operation guidance and auto-commit option (91171e2)
 
 ## 1.2.18 – 📝 Documentation
 

package/index.js

@@ -210,3 +210,4 @@ if (require.main === module) {
 }
 
 module.exports = { setupCommiter, ensureSafeTestScript };
+// Test change for complete release

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@programinglive/commiter",
-  "version": "1.2.18",
+  "version": "1.2.20",
   "description": "Commiter keeps repositories release-ready by enforcing conventional commits, generating icon-rich changelog entries, and orchestrating semantic version bumps without manual toil. It bootstraps Husky hooks, commitlint rules, and release scripts that inspect history, detect framework-specific test commands, run them automatically, tag git releases, coordinate npm publishing, surface release metrics, enforce project-specific checks, and give maintainers observability across distributed teams. Plus!",
   "main": "index.js",
   "bin": {
@@ -14,6 +14,7 @@
     "release:minor": "node scripts/release.cjs minor",
     "release:patch": "node scripts/release.cjs patch",
     "release:first": "node scripts/release.cjs --first-release",
+    "release:complete": "node scripts/release-complete.cjs",
     "web": "npx serve web"
   },
   "keywords": [
@@ -88,8 +89,8 @@
     ]
   },
   "devDependencies": {
-    "@commitlint/cli": "^20.2.0",
-    "@commitlint/config-conventional": "^20.2.0",
+    "@commitlint/cli": "^20.5.3",
+    "@commitlint/config-conventional": "^20.5.3",
     "husky": "^9.1.7",
     "standard-version": "^9.5.0"
   }

package/scripts/release-complete.cjs

@@ -0,0 +1,115 @@
+#!/usr/bin/env node
+
+const { spawnSync } = require('child_process');
+const path = require('path');
+const fs = require('fs');
+
+const { runRelease } = require('./release.cjs');
+
+function runCompleteRelease({
+  argv = process.argv,
+  cwd = process.cwd(),
+  spawn = spawnSync
+} = {}) {
+  console.log('🚀 Starting complete release process...');
+  console.log('   This will run the release and automatically commit/push release notes\n');
+
+  // Run the standard release process
+  const releaseResult = runRelease({ argv, cwd, spawn });
+  
+  if (releaseResult && typeof releaseResult.status === 'number' && releaseResult.status !== 0) {
+    console.error('❌ Release failed. Aborting complete release process.');
+    return releaseResult;
+  }
+
+  // Get the current version for commit message
+  const packageJsonPath = path.join(cwd, 'package.json');
+  let version = 'unknown';
+  
+  try {
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+    version = packageJson.version;
+  } catch (error) {
+    console.warn('⚠️  Could not read version from package.json');
+  }
+
+  // Check if there are staged changes to commit
+  const statusResult = spawn('git', ['status', '--porcelain'], { 
+    cwd, 
+    encoding: 'utf8' 
+  });
+
+  if (statusResult.error || (statusResult.status !== 0)) {
+    console.warn('⚠️  Could not check git status. Please commit manually.');
+    return releaseResult;
+  }
+
+  const stagedChanges = statusResult.stdout.split('\n').filter(line => 
+    line.trim() && line.startsWith('A ') || line.startsWith('M ')
+  );
+
+  if (stagedChanges.length === 0) {
+    console.log('✅ No release notes changes to commit. Release complete!');
+    return releaseResult;
+  }
+
+  console.log(`📝 Found ${stagedChanges.length} staged change(s) to commit:`);
+  stagedChanges.forEach(change => {
+    const [status, ...filePathParts] = change.trim().split(' ');
+    const filePath = filePathParts.join(' ');
+    console.log(`   ${status} ${filePath}`);
+  });
+
+  // Commit the staged changes
+  const commitMessage = `docs: update release notes for v${version} 📋`;
+  console.log(`\n🔄 Committing with message: "${commitMessage}"`);
+  
+  const commitResult = spawn('git', ['commit', '-m', commitMessage], { 
+    stdio: 'inherit', 
+    cwd 
+  });
+
+  if (commitResult.status !== 0) {
+    console.error('❌ Failed to commit release notes. Please commit manually.');
+    return commitResult;
+  }
+
+  console.log('✅ Release notes committed successfully!');
+
+  // Push the changes
+  console.log('\n📤 Pushing changes to remote...');
+  const pushResult = spawn('git', ['push'], { 
+    stdio: 'inherit', 
+    cwd 
+  });
+
+  if (pushResult.status !== 0) {
+    console.error('❌ Failed to push changes. Please push manually.');
+    return pushResult;
+  }
+
+  console.log('\n🎉 Complete release process finished successfully!');
+  console.log('   ✅ Release completed');
+  console.log('   ✅ Release notes generated');
+  console.log('   ✅ Changes committed');
+  console.log('   ✅ Changes pushed');
+  console.log(`\n📦 Version ${version} is now live!`);
+
+  return pushResult;
+}
+
+if (require.main === module) {
+  try {
+    const result = runCompleteRelease();
+    if (result.status !== 0) {
+      process.exit(result.status ?? 1);
+    }
+  } catch (error) {
+    console.error(`❌ Complete release failed: ${error.message}`);
+    process.exit(1);
+  }
+}
+
+module.exports = {
+  runCompleteRelease
+};

package/scripts/release.cjs

@@ -202,6 +202,17 @@ function runRelease({
     const gitAddResult = spawnSync('git', ['add', releaseNotesPath], { stdio: 'inherit', cwd });
     if (!gitAddResult || typeof gitAddResult.status !== 'number' || gitAddResult.status !== 0) {
       console.warn('⚠️  Release notes updated but failed to stage. Please add manually: git add ' + releaseNotesPath);
+    } else {
+      console.log('\n🎯 Release notes generated and staged successfully!');
+      console.log('\n📋 NEXT STEPS REQUIRED:');
+      console.log('   ✅ Release notes have been staged for commit');
+      console.log('   🔄 You need to commit and push the release notes:');
+      console.log('      git commit -m "docs: update release notes for version"');
+      console.log('      git push');
+      console.log('\n💡 AI ASSISTANCE:');
+      console.log('   🤖 Use the dev-workflow MCP server to handle the commit and push automatically');
+      console.log('   📝 The release notes are now staged and ready for commit');
+      console.log('');
     }
   }
 

package/web/index.html

@@ -66,7 +66,7 @@
             <div class="hero-content">
                 <div class="hero-badge">
                     <span class="badge-dot"></span>
-                    <span>v1.2.17 - Latest Release</span>
+                    <span>v1.2.20 - Latest Release</span>
                 </div>
                 <h1 class="hero-title">
                     Ship Releases with <span class="gradient-text">Confidence</span>
@@ -90,7 +90,7 @@
                 </div>
                 <div class="hero-stats">
                     <div class="stat-item">
-                        <div class="stat-value">1.2.17</div>
+                        <div class="stat-value">1.2.20</div>
                         <div class="stat-label">Latest Version</div>
                     </div>
                     <div class="stat-item">
@@ -121,9 +121,9 @@
                         <div class="code-line output success">🎉 Setup complete! Ready to release.</div>
                         <div class="code-line"><span class="prompt">$</span> npm run release:patch</div>
                         <div class="code-line output">✓ Running tests...</div>
-                        <div class="code-line output">✓ Bumping version to 1.2.17...</div>
+                        <div class="code-line output">✓ Bumping version to 1.2.18...</div>
                         <div class="code-line output">✓ Updating CHANGELOG.md...</div>
-                        <div class="code-line output success">🚀 Release v1.2.17 ready!</div>
+                        <div class="code-line output success">🚀 Release v1.2.20 ready!</div>
                         <div class="code-line cursor">_</div>
                     </div>
                 </div>
@@ -167,11 +167,21 @@
                     <h3>Test Integration</h3>
                     <p>Automatically runs your test suite before releasing to prevent broken releases</p>
                 </div>
+                <div class="feature-card">
+                    <div class="feature-icon">🎯</div>
+                    <h3>Enhanced Release Process</h3>
+                    <p>Clear console guidance and optional auto-commit for release notes with AI-friendly workflow</p>
+                </div>
                 <div class="feature-card">
                     <div class="feature-icon">⚡</div>
                     <h3>Zero Config</h3>
                     <p>One command setup with sensible defaults. Works with npm, yarn, and pnpm out of the box</p>
                 </div>
+                <div class="feature-card">
+                    <div class="feature-icon">🤖</div>
+                    <h3>AI-Optimized Workflow</h3>
+                    <p>Built-in guidance for AI assistants with clear next steps and automated git operations</p>
+                </div>
             </div>
         </div>
     </section>
@@ -275,6 +285,9 @@
                     <div class="step-content">
                         <h3>Release Your Changes</h3>
                         <p>Run the appropriate release command based on your changes</p>
+                        <div class="code-block">
+                            <code>npm run release        # Standard release with git guidance</code>
+                        </div>
                         <div class="code-block">
                             <code>npm run release:first   # New project → 0.0.1</code>
                         </div>
@@ -287,6 +300,9 @@
                         <div class="code-block">
                             <code>npm run release:major  # 1.0.0 → 2.0.0</code>
                         </div>
+                        <div class="code-block">
+                            <code>npm run release:complete  # Auto-commit & push release notes</code>
+                        </div>
                     </div>
                 </div>
             </div>
@@ -388,6 +404,18 @@
                 <!-- RELEASES_TIMELINE:START -->
                 <div class="release-item">
                     <div class="release-badge">Latest</div>
+                    <div class="release-version">v1.2.20</div>
+                    <div class="release-date">January 01, 2026</div>
+                    <div class="release-type">✨ Features</div>
+                    <p class="release-description">Enhance release process with clear git operation guidance and auto-commit option</p>
+                </div>
+                <div class="release-item">
+                    <div class="release-version">v1.2.19</div>
+                    <div class="release-date">January 01, 2026</div>
+                    <div class="release-type">📝 Documentation</div>
+                    <p class="release-description">Update release notes for version 1.2.19</p>
+                </div>
+                <div class="release-item">
                     <div class="release-version">v1.2.17</div>
                     <div class="release-date">December 26, 2025</div>
                     <div class="release-type">📝 Documentation</div>