|
| 1 | +# GitHub Release Instructions for v1.2.1 |
| 2 | + |
| 3 | +## ✅ Prerequisites Completed |
| 4 | +- ✅ Committed all v1.2.1 changes to main branch |
| 5 | +- ✅ Created v1.2.1 tag locally |
| 6 | +- ✅ Release notes prepared in `release-notes-v1.2.1.txt` |
| 7 | + |
| 8 | +## 🚀 Create GitHub Release |
| 9 | + |
| 10 | +### Step 1: Navigate to Releases |
| 11 | +Go to: **https://github.com/xplusplusai/fo-semantic-mcp/releases/new** |
| 12 | + |
| 13 | +### Step 2: Release Configuration |
| 14 | +Fill in the following details: |
| 15 | + |
| 16 | +- **Tag**: `v1.2.1` (create new tag if not yet pushed) |
| 17 | +- **Release title**: `v1.2.1 - Critical Threshold Fix` |
| 18 | +- **Target branch**: `main` |
| 19 | +- **Release type**: ✅ Latest release (checked) |
| 20 | +- **Pre-release**: ❌ Unchecked |
| 21 | + |
| 22 | +### Step 3: Release Description |
| 23 | +Copy the contents from `release-notes-v1.2.1.txt` into the description field. |
| 24 | + |
| 25 | +### Step 4: Upload Release Assets |
| 26 | + |
| 27 | +**Required Files** (upload these individually): |
| 28 | +- `package.json` |
| 29 | +- `package-lock.json` |
| 30 | +- `README.md` |
| 31 | +- `CHANGELOG.md` |
| 32 | +- `LICENSE` |
| 33 | +- `CONTRIBUTING.md` |
| 34 | + |
| 35 | +**Required Folders** (already created as ZIP files): |
| 36 | +- `dist.tar.gz` (contains the entire `dist/` folder) |
| 37 | +- `docs.tar.gz` (contains the entire `docs/` folder) |
| 38 | +- `examples.tar.gz` (contains the entire `examples/` folder) |
| 39 | + |
| 40 | +### Step 5: Complete Release |
| 41 | +1. ✅ Check "Set as the latest release" |
| 42 | +2. ❌ Leave "Set as a pre-release" unchecked |
| 43 | +3. Click **"Publish release"** |
| 44 | + |
| 45 | +## 📋 Release Summary |
| 46 | + |
| 47 | +**What this release fixes:** |
| 48 | +- **Critical Threshold Issue**: Fixed 0.75 threshold filtering out exact foName matches |
| 49 | +- **Better Balance**: 0.5 threshold provides optimal relevance vs. recall balance |
| 50 | +- **Reliable foName Filter**: Exact artifact matching now works consistently |
| 51 | +- **Updated Examples**: All configuration examples use proven 0.5 threshold |
| 52 | +- **Enhanced Documentation**: Clear guidance on threshold usage |
| 53 | + |
| 54 | +**Installation for users:** |
| 55 | +1. Download the release ZIP |
| 56 | +2. Extract to desired location |
| 57 | +3. Update MCP configuration to point to `dist/server.js` |
| 58 | +4. Add `FOINDEX_API_KEY` environment variable |
| 59 | +5. **IMPORTANT**: Set `FO_SEARCH_DEFAULT_THRESHOLD` to `0.5` |
| 60 | + |
| 61 | +## 🔗 Quick Links |
| 62 | + |
| 63 | +- **Repository**: https://github.com/xplusplusai/fo-semantic-mcp |
| 64 | +- **Releases**: https://github.com/xplusplusai/fo-semantic-mcp/releases |
| 65 | +- **API Key Signup**: https://www.xplusplus.ai/ |
| 66 | + |
| 67 | +## ✅ Verification Steps |
| 68 | + |
| 69 | +After publishing the release: |
| 70 | +1. Verify the release appears in the releases list |
| 71 | +2. Check that all assets are downloadable |
| 72 | +3. Test the download and installation process |
| 73 | +4. Confirm the release is marked as "Latest" |
| 74 | +5. Test foName filter with 0.5 threshold works correctly |
| 75 | + |
| 76 | +--- |
| 77 | + |
| 78 | +**The commit is complete and local tag is created. You need to push the tag and create the release through the GitHub web interface using the instructions above.** |
| 79 | + |
| 80 | +### Manual Push Commands (if needed): |
| 81 | +```bash |
| 82 | +cd "C:\Users\tmpsp\OneDrive\Documents\AI Work\FO-Index-MCP\fo-semantic-mcp-release" |
| 83 | +git push origin main |
| 84 | +git push origin v1.2.1 |
| 85 | +``` |
0 commit comments