|
| 1 | +# ObjectQL v4.0.3 Release Guide |
| 2 | + |
| 3 | +## 📦 Release Prepared |
| 4 | + |
| 5 | +This branch contains ObjectQL version **4.0.3**, ready for release. |
| 6 | + |
| 7 | +## ✅ Pre-Release Checklist |
| 8 | + |
| 9 | +- [x] Version bumped from 4.0.2 to 4.0.3 |
| 10 | +- [x] All 14 packages synchronized at 4.0.3 |
| 11 | +- [x] CHANGELOGs updated for all packages |
| 12 | +- [x] Build successful (19 packages) |
| 13 | +- [x] Tests passing (318 tests) |
| 14 | +- [x] Version consistency verified |
| 15 | +- [x] Release notes created |
| 16 | +- [x] Code review completed (no issues) |
| 17 | +- [x] Security scan completed (no issues) |
| 18 | + |
| 19 | +## 🚀 How to Release |
| 20 | + |
| 21 | +### Option 1: Automated Release via GitHub (Recommended) |
| 22 | + |
| 23 | +1. **Merge this PR to `main`** |
| 24 | + ```bash |
| 25 | + # The PR will be merged through GitHub UI |
| 26 | + ``` |
| 27 | + |
| 28 | +2. **GitHub Actions automatically:** |
| 29 | + - Builds all packages |
| 30 | + - Runs test suites |
| 31 | + - Publishes to npm registry |
| 32 | + - Creates git tag `v4.0.3` |
| 33 | + - Generates GitHub release |
| 34 | + |
| 35 | +### Option 2: Manual Release |
| 36 | + |
| 37 | +If you need to release manually: |
| 38 | + |
| 39 | +```bash |
| 40 | +# 1. Ensure you're on the release branch |
| 41 | +git checkout copilot/release-new-version |
| 42 | + |
| 43 | +# 2. Build all packages |
| 44 | +pnpm run build |
| 45 | + |
| 46 | +# 3. Login to npm (if not already logged in) |
| 47 | +npm login |
| 48 | + |
| 49 | +# 4. Publish all packages |
| 50 | +pnpm changeset publish |
| 51 | + |
| 52 | +# 5. Push tags to GitHub |
| 53 | +git push --follow-tags |
| 54 | +``` |
| 55 | + |
| 56 | +## 📚 Documentation |
| 57 | + |
| 58 | +- **[RELEASE_NOTES_4.0.3.md](./RELEASE_NOTES_4.0.3.md)** - User-facing release notes |
| 59 | +- **[VERSION_4.0.3_SUMMARY.md](./VERSION_4.0.3_SUMMARY.md)** - Technical release summary |
| 60 | + |
| 61 | +## 🔍 What Changed |
| 62 | + |
| 63 | +### Version Updates |
| 64 | +All packages updated from `4.0.2` to `4.0.3`: |
| 65 | + |
| 66 | +```json |
| 67 | +{ |
| 68 | + "dependencies": { |
| 69 | + "@objectql/core": "^4.0.3", |
| 70 | + "@objectql/driver-sql": "^4.0.3", |
| 71 | + "@objectql/cli": "^4.0.3" |
| 72 | + } |
| 73 | +} |
| 74 | +``` |
| 75 | + |
| 76 | +### Improvements |
| 77 | +- Enhanced metadata handling and object retrieval logic |
| 78 | +- Improved package configurations across all drivers |
| 79 | +- Infrastructure improvements and maintenance updates |
| 80 | +- Bug fixes and performance optimizations |
| 81 | + |
| 82 | +## 🧪 Test Results |
| 83 | + |
| 84 | +``` |
| 85 | +✅ @objectql/types: 36 tests passed |
| 86 | +✅ @objectql/core: 282 tests passed |
| 87 | +✅ Total: 318 tests passed |
| 88 | +``` |
| 89 | + |
| 90 | +## 📦 Packages Included |
| 91 | + |
| 92 | +| Package | Version | Status | |
| 93 | +|---------|---------|--------| |
| 94 | +| @objectql/types | 4.0.3 | ✅ Ready | |
| 95 | +| @objectql/core | 4.0.3 | ✅ Ready | |
| 96 | +| @objectql/platform-node | 4.0.3 | ✅ Ready | |
| 97 | +| @objectql/driver-sql | 4.0.3 | ✅ Ready | |
| 98 | +| @objectql/driver-mongo | 4.0.3 | ✅ Ready | |
| 99 | +| @objectql/driver-redis | 4.0.3 | ✅ Ready | |
| 100 | +| @objectql/driver-fs | 4.0.3 | ✅ Ready | |
| 101 | +| @objectql/driver-memory | 4.0.3 | ✅ Ready | |
| 102 | +| @objectql/driver-localstorage | 4.0.3 | ✅ Ready | |
| 103 | +| @objectql/driver-excel | 4.0.3 | ✅ Ready | |
| 104 | +| @objectql/sdk | 4.0.3 | ✅ Ready | |
| 105 | +| @objectql/server | 4.0.3 | ✅ Ready | |
| 106 | +| @objectql/cli | 4.0.3 | ✅ Ready | |
| 107 | +| @objectql/create | 4.0.3 | ✅ Ready | |
| 108 | + |
| 109 | +## 🔐 Security |
| 110 | + |
| 111 | +- ✅ Code review: No issues found |
| 112 | +- ✅ CodeQL analysis: No vulnerabilities detected |
| 113 | +- ✅ No dependencies with known vulnerabilities |
| 114 | + |
| 115 | +## 📝 Migration Guide |
| 116 | + |
| 117 | +This is a backward-compatible patch release. To upgrade: |
| 118 | + |
| 119 | +```bash |
| 120 | +# Update package.json |
| 121 | +npm install @objectql/core@^4.0.3 |
| 122 | + |
| 123 | +# Or with pnpm |
| 124 | +pnpm add @objectql/core@^4.0.3 |
| 125 | +``` |
| 126 | + |
| 127 | +No code changes required. |
| 128 | + |
| 129 | +## 🎯 Post-Release Verification |
| 130 | + |
| 131 | +After publishing, verify the release: |
| 132 | + |
| 133 | +```bash |
| 134 | +# Check npm registry |
| 135 | +npm view @objectql/core version |
| 136 | +# Should show: 4.0.3 |
| 137 | + |
| 138 | +# Check git tags |
| 139 | +git tag -l "v4.0.3" |
| 140 | +# Should exist |
| 141 | + |
| 142 | +# Verify installation |
| 143 | +npm install @objectql/core@4.0.3 |
| 144 | +``` |
| 145 | + |
| 146 | +## 📞 Support |
| 147 | + |
| 148 | +If you encounter any issues with this release: |
| 149 | +- Check [RELEASE_NOTES_4.0.3.md](./RELEASE_NOTES_4.0.3.md) |
| 150 | +- Review [VERSION_4.0.3_SUMMARY.md](./VERSION_4.0.3_SUMMARY.md) |
| 151 | +- Open an issue on GitHub |
| 152 | + |
| 153 | +--- |
| 154 | + |
| 155 | +**Release Prepared By:** ObjectQL Lead Architect |
| 156 | +**Release Date:** January 28, 2026 |
| 157 | +**Release Type:** Patch Release |
| 158 | +**Status:** ✅ Ready for Production |
0 commit comments