@programinglive/commiter 1.2.8 → 1.2.12

package/docs/CREATE_RELEASES.md

@@ -1,103 +1,103 @@
-# Creating GitHub Releases
-
-This guide explains how to populate your GitHub releases page with releases from your tags.
-
-## Problem
-
-You have tags in your repository (v1.0.0, v1.1.9, etc.) but the GitHub releases page is empty. GitHub doesn't automatically create releases from tags - you need to create them manually.
-
-## Solution Options
-
-### Option 1: Use the Automated Script (Recommended)
-
-We've created a script that will automatically create releases for all your tags using the content from CHANGELOG.md.
-
-#### Prerequisites
-1. Create a GitHub Personal Access Token:
-   - Go to https://github.com/settings/tokens
-   - Click "Generate new token" → "Generate new token (classic)"
-   - Give it a name like "Commiter Releases"
-   - Select scope: `repo` (Full control of private repositories)
-   - Click "Generate token"
-   - **Copy the token immediately** (you won't see it again!)
-
-#### Steps
-1. Set your GitHub token as an environment variable:
-   ```powershell
-   # Windows PowerShell
-   $env:GITHUB_TOKEN="your_token_here"
-   ```
-
-2. Run the script:
-   ```bash
-   node scripts/create-releases.js
-   ```
-
-3. The script will:
-   - Read all your local tags
-   - Parse CHANGELOG.md for release notes
-   - Create GitHub releases for each tag
-   - Skip tags that already have releases
-
-### Option 2: Create Releases Manually
-
-If you prefer to create releases manually or just want to create the latest release:
-
-1. Go to https://github.com/programinglive/commiter/releases
-2. Click "Draft a new release"
-3. Click "Choose a tag" and select `v1.1.9`
-4. Set the release title to `v1.1.9`
-5. Copy the release notes from CHANGELOG.md (lines 5-10):
-   ```markdown
-   ### 🐛 Bug Fixes
-
-   * convert release scripts to CJS to support ESM projects ([842da02](https://github.com/programinglive/commiter/commit/842da0298f1c4df7aa93b43ca8698e3669ef6450))
-   ```
-6. Click "Publish release"
-7. Repeat for other versions if needed
-
-### Option 3: Use GitHub CLI (if installed)
-
-If you have GitHub CLI installed (`gh`):
-
-```bash
-# Create release for v1.1.9
-gh release create v1.1.9 \
-  --title "v1.1.9" \
-  --notes "### 🐛 Bug Fixes
-
-* convert release scripts to CJS to support ESM projects"
-
-# Or create from CHANGELOG
-gh release create v1.1.9 --notes-file CHANGELOG.md
-```
-
-## After Creating Releases
-
-Once releases are created, they will appear on:
-- https://github.com/programinglive/commiter/releases
-- The right sidebar of your repository
-- In the repository's release feed
-
-## Automating Future Releases
-
-To automatically create GitHub releases during your release process, you can:
-
-1. **Add to your release script** - Modify `scripts/release.cjs` to create GitHub releases
-2. **Use GitHub Actions** - Set up a workflow that creates releases when tags are pushed
-3. **Use the script** - Run `scripts/create-releases.js` after each release
-
-## Troubleshooting
-
-### "GITHUB_TOKEN not set"
-Make sure you've set the environment variable in your current terminal session.
-
-### "API rate limit exceeded"
-GitHub API has rate limits. The script waits 1 second between requests to avoid this. If you hit the limit, wait an hour and try again.
-
-### "Resource not accessible by integration"
-Your token doesn't have the right permissions. Make sure you selected the `repo` scope when creating the token.
-
-## Security Note
-
-**Never commit your GitHub token to the repository!** Always use environment variables or secure secret management.
+# Creating GitHub Releases
+
+This guide explains how to populate your GitHub releases page with releases from your tags.
+
+## Problem
+
+You have tags in your repository (v1.0.0, v1.1.9, etc.) but the GitHub releases page is empty. GitHub doesn't automatically create releases from tags - you need to create them manually.
+
+## Solution Options
+
+### Option 1: Use the Automated Script (Recommended)
+
+We've created a script that will automatically create releases for all your tags using the content from CHANGELOG.md.
+
+#### Prerequisites
+1. Create a GitHub Personal Access Token:
+   - Go to https://github.com/settings/tokens
+   - Click "Generate new token" → "Generate new token (classic)"
+   - Give it a name like "Commiter Releases"
+   - Select scope: `repo` (Full control of private repositories)
+   - Click "Generate token"
+   - **Copy the token immediately** (you won't see it again!)
+
+#### Steps
+1. Set your GitHub token as an environment variable:
+   ```powershell
+   # Windows PowerShell
+   $env:GITHUB_TOKEN="your_token_here"
+   ```
+
+2. Run the script:
+   ```bash
+   node scripts/create-releases.js
+   ```
+
+3. The script will:
+   - Read all your local tags
+   - Parse CHANGELOG.md for release notes
+   - Create GitHub releases for each tag
+   - Skip tags that already have releases
+
+### Option 2: Create Releases Manually
+
+If you prefer to create releases manually or just want to create the latest release:
+
+1. Go to https://github.com/programinglive/commiter/releases
+2. Click "Draft a new release"
+3. Click "Choose a tag" and select `v1.1.9`
+4. Set the release title to `v1.1.9`
+5. Copy the release notes from CHANGELOG.md (lines 5-10):
+   ```markdown
+   ### 🐛 Bug Fixes
+
+   * convert release scripts to CJS to support ESM projects ([842da02](https://github.com/programinglive/commiter/commit/842da0298f1c4df7aa93b43ca8698e3669ef6450))
+   ```
+6. Click "Publish release"
+7. Repeat for other versions if needed
+
+### Option 3: Use GitHub CLI (if installed)
+
+If you have GitHub CLI installed (`gh`):
+
+```bash
+# Create release for v1.1.9
+gh release create v1.1.9 \
+  --title "v1.1.9" \
+  --notes "### 🐛 Bug Fixes
+
+* convert release scripts to CJS to support ESM projects"
+
+# Or create from CHANGELOG
+gh release create v1.1.9 --notes-file CHANGELOG.md
+```
+
+## After Creating Releases
+
+Once releases are created, they will appear on:
+- https://github.com/programinglive/commiter/releases
+- The right sidebar of your repository
+- In the repository's release feed
+
+## Automating Future Releases
+
+To automatically create GitHub releases during your release process, you can:
+
+1. **Add to your release script** - Modify `scripts/release.cjs` to create GitHub releases
+2. **Use GitHub Actions** - Set up a workflow that creates releases when tags are pushed
+3. **Use the script** - Run `scripts/create-releases.js` after each release
+
+## Troubleshooting
+
+### "GITHUB_TOKEN not set"
+Make sure you've set the environment variable in your current terminal session.
+
+### "API rate limit exceeded"
+GitHub API has rate limits. The script waits 1 second between requests to avoid this. If you hit the limit, wait an hour and try again.
+
+### "Resource not accessible by integration"
+Your token doesn't have the right permissions. Make sure you selected the `repo` scope when creating the token.
+
+## Security Note
+
+**Never commit your GitHub token to the repository!** Always use environment variables or secure secret management.

package/docs/QUICK_RELEASE_GUIDE.md

@@ -1,101 +1,101 @@
-# Quick Guide: Create GitHub Release for v1.1.9
-
-Follow these simple steps to create your first GitHub release:
-
-## Step 1: Navigate to New Release Page
-1. Make sure you're logged into GitHub
-2. Go to: https://github.com/programinglive/commiter/releases/new
-
-## Step 2: Fill in the Form
-
-### Choose a tag
-- Click "Choose a tag"
-- Type: `v1.1.9`
-- Click "Create new tag: v1.1.9 on publish"
-
-### Release title
-- Type: `v1.1.9`
-
-### Describe this release
-Copy and paste this content:
-
-```markdown
-### 🐛 Bug Fixes
-
-* convert release scripts to CJS to support ESM projects ([842da02](https://github.com/programinglive/commiter/commit/842da0298f1c4df7aa93b43ca8698e3669ef6450))
-```
-
-## Step 3: Publish
-- Click the green "Publish release" button
-
-## Done! ✅
-
-Your release will now appear at: https://github.com/programinglive/commiter/releases
-
----
-
-## Create More Releases (Optional)
-
-If you want to create releases for older versions, here's the content for each:
-
-### v1.1.8
-**Title:** `v1.1.8`  
-**Description:**
-```markdown
-### 🐛 Bug Fixes
-
-* update installation script to copy missing files and update gitignore ([5d56259](https://github.com/programinglive/commiter/commit/5d562592fe35b684fa12bd89748b24551ae28a66))
-```
-
-### v1.1.7
-**Title:** `v1.1.7`  
-**Description:**
-```markdown
-### 📝 Documentation
-
-* recommend dev workflow mcp server ([58a5054](https://github.com/programinglive/commiter/commit/58a5054fafd627ef23c448fd93b1383518590ad2))
-```
-
-### v1.1.6
-**Title:** `v1.1.6`  
-**Description:**
-```markdown
-### 🐛 Bug Fixes
-
-* revert to simple release notes staging to avoid git ref conflicts ([2f6a40e](https://github.com/programinglive/commiter/commit/2f6a40ed7259cffdb0b1de1633af3e43df475044))
-```
-
-### v1.1.5
-**Title:** `v1.1.5`  
-**Description:**
-```markdown
-### ✨ Features
-
-* include release notes in release commit via amendment ([3f2afa8](https://github.com/programinglive/commiter/commit/3f2afa8bd0bd264d047df06ae791384e74dc827e))
-
-### 📝 Documentation
-
-* update release notes for v1.1.5 ([cb3dbe6](https://github.com/programinglive/commiter/commit/cb3dbe62a85a174bfb074e3d2526a005fc83d0d7))
-```
-
-### v1.1.1
-**Title:** `v1.1.1`  
-**Description:**
-```markdown
-### 🐛 Bug Fixes
-
-* remove fs.F_OK deprecation warning ([1b0652b](https://github.com/programinglive/commiter/commit/1b0652b88d1b095e1045994948f75ce8194f9d3a))
-```
-
-### v1.0.12
-**Title:** `v1.0.12`  
-**Description:**
-```markdown
-### ✨ Features
-
-* auto-detect test command during release ([602e30e](https://github.com/programinglive/commiter/commit/602e30e94ff7c58b35f8c54bd495c0334352c72c))
-```
-
----
-
-**Tip:** You only need to create releases for the major versions (1.1.9, 1.1.8, 1.1.7, etc.). You can skip the older patch versions if you want to save time.
+# Quick Guide: Create GitHub Release for v1.1.9
+
+Follow these simple steps to create your first GitHub release:
+
+## Step 1: Navigate to New Release Page
+1. Make sure you're logged into GitHub
+2. Go to: https://github.com/programinglive/commiter/releases/new
+
+## Step 2: Fill in the Form
+
+### Choose a tag
+- Click "Choose a tag"
+- Type: `v1.1.9`
+- Click "Create new tag: v1.1.9 on publish"
+
+### Release title
+- Type: `v1.1.9`
+
+### Describe this release
+Copy and paste this content:
+
+```markdown
+### 🐛 Bug Fixes
+
+* convert release scripts to CJS to support ESM projects ([842da02](https://github.com/programinglive/commiter/commit/842da0298f1c4df7aa93b43ca8698e3669ef6450))
+```
+
+## Step 3: Publish
+- Click the green "Publish release" button
+
+## Done! ✅
+
+Your release will now appear at: https://github.com/programinglive/commiter/releases
+
+---
+
+## Create More Releases (Optional)
+
+If you want to create releases for older versions, here's the content for each:
+
+### v1.1.8
+**Title:** `v1.1.8`  
+**Description:**
+```markdown
+### 🐛 Bug Fixes
+
+* update installation script to copy missing files and update gitignore ([5d56259](https://github.com/programinglive/commiter/commit/5d562592fe35b684fa12bd89748b24551ae28a66))
+```
+
+### v1.1.7
+**Title:** `v1.1.7`  
+**Description:**
+```markdown
+### 📝 Documentation
+
+* recommend dev workflow mcp server ([58a5054](https://github.com/programinglive/commiter/commit/58a5054fafd627ef23c448fd93b1383518590ad2))
+```
+
+### v1.1.6
+**Title:** `v1.1.6`  
+**Description:**
+```markdown
+### 🐛 Bug Fixes
+
+* revert to simple release notes staging to avoid git ref conflicts ([2f6a40e](https://github.com/programinglive/commiter/commit/2f6a40ed7259cffdb0b1de1633af3e43df475044))
+```
+
+### v1.1.5
+**Title:** `v1.1.5`  
+**Description:**
+```markdown
+### ✨ Features
+
+* include release notes in release commit via amendment ([3f2afa8](https://github.com/programinglive/commiter/commit/3f2afa8bd0bd264d047df06ae791384e74dc827e))
+
+### 📝 Documentation
+
+* update release notes for v1.1.5 ([cb3dbe6](https://github.com/programinglive/commiter/commit/cb3dbe62a85a174bfb074e3d2526a005fc83d0d7))
+```
+
+### v1.1.1
+**Title:** `v1.1.1`  
+**Description:**
+```markdown
+### 🐛 Bug Fixes
+
+* remove fs.F_OK deprecation warning ([1b0652b](https://github.com/programinglive/commiter/commit/1b0652b88d1b095e1045994948f75ce8194f9d3a))
+```
+
+### v1.0.12
+**Title:** `v1.0.12`  
+**Description:**
+```markdown
+### ✨ Features
+
+* auto-detect test command during release ([602e30e](https://github.com/programinglive/commiter/commit/602e30e94ff7c58b35f8c54bd495c0334352c72c))
+```
+
+---
+
+**Tip:** You only need to create releases for the major versions (1.1.9, 1.1.8, 1.1.7, etc.). You can skip the older patch versions if you want to save time.