Commit bc5cf9f
committed
feat(release): implement medium-priority release automation improvements
Completes the remaining medium-priority items from the release agent review.
Adds PR automation, Release Notes Manager agent, and comprehensive scope
parameter documentation.
## Changes
### 1. PR Automation for release-prep.yml (✅ Complete)
**Created: `scripts/create-release-pr.cjs`**
- Automatically creates release PRs from develop to main
- Computes next version based on merged PR labels
- Updates VERSION and CHANGELOG.md files
- Creates release branch (release/vX.Y.Z)
- Generates comprehensive PR description with:
- Changelog summary
- Release checklist
- Version bump information
- Uses gh CLI for PR creation
**Updated: `.github/workflows/release-prep.yml`**
- Added "Create Release PR" step
- Calls create-release-pr.cjs script
- Passes GITHUB_TOKEN for authentication
- Removes TODO comment (now implemented)
**Features:**
- Validates unreleased changes exist before creating PR
- Detects if release branch already exists
- Computes semantic version bumps (major/minor/patch)
- Commits and pushes changes automatically
- Comprehensive error handling and logging
### 2. Release Notes Manager Agent (✅ Complete)
**Created: `.github/agents/release-notes-manager.agent.cjs`**
Comprehensive release notes generation agent that:
- Compiles clean release notes from changelog
- Generates highlights from key sections (Added, Changed, Security)
- Detects and flags breaking changes automatically
- Lists contributors with PR counts
- Groups changes by type with emojis (✨ Added, 🐛 Fixed, etc.)
- Formats output suitable for GitHub releases
- Includes installation instructions
- Links to full changelog comparison
**CLI Usage:**
```bash
# Generate notes for specific version
node .github/agents/release-notes-manager.agent.cjs --version=1.0.0
# Generate notes for latest version
node .github/agents/release-notes-manager.agent.cjs --latest
# Output to file
node .github/agents/release-notes-manager.agent.cjs --version=1.0.0 --output=RELEASE_NOTES.md
```
**Features:**
- ✅ Highlights (top 5 important changes)
- ✅ Breaking changes detection and warnings
- ✅ Grouped sections with emojis
- ✅ Contributor attribution
- ✅ Installation instructions
- ✅ Full changelog links
- ✅ Graceful error handling for missing tags
**Implements spec:** `.github/agents/TODO/release-notes-manager.agents.md`
### 3. Scope Parameter Documentation (✅ Complete)
**Created: `docs/RELEASE-SCOPE-GUIDE.md`**
Comprehensive 400+ line guide covering:
**Overview:**
- What the --scope parameter does
- Semantic versioning primer
- How it affects version bumping
**Detailed Sections:**
- When to use each scope (patch/minor/major)
- Real-world examples for each scope type
- Decision flowchart for scope selection
- Release label system integration
**Examples:**
- Bug fix release (patch)
- New feature release (minor)
- Breaking change release (major)
- Dry-run testing examples
**Best Practices:**
- Validation before release
- Documentation requirements
- Testing procedures
- Communication guidelines
**FAQ:**
- Common questions and answers
- Edge cases and troubleshooting
- Pre-release versions
- Reverting releases
- Monorepo considerations
**Related Documentation:**
- Links to release process guide
- Agent specifications
- External SemVer reference
- Support channels
## Testing
All components tested and working:
✅ **create-release-pr.cjs**
- Script executes without errors
- Validates unreleased changes
- Handles missing tags gracefully
✅ **release-notes-manager.agent.cjs**
- Generates comprehensive release notes for 0.1.0
- Handles missing git tags gracefully
- Formats output with proper markdown
- Includes highlights, breaking changes, grouped sections
- Lists contributors (when available)
✅ **RELEASE-SCOPE-GUIDE.md**
- Well-structured and comprehensive
- Clear examples and use cases
- Proper YAML frontmatter
- Links to related documentation
## Benefits
1. **Automated PR Creation**
- Reduces manual work for maintainers
- Ensures consistent PR format
- Validates changelog before PR creation
- Integrates with existing workflows
2. **Professional Release Notes**
- User-friendly format
- Highlights key changes
- Warns about breaking changes
- Credits contributors
3. **Clear Documentation**
- Removes ambiguity about version bumping
- Provides decision framework
- Real-world examples
- Answers common questions
## Standards Compliance
- ✅ UK English throughout
- ✅ LightSpeed coding standards
- ✅ Comprehensive JSDoc comments
- ✅ YAML frontmatter in documentation
- ✅ Error handling and logging
- ✅ CommonJS compatibility (.cjs extension)
## Related Issues
- Addresses medium-priority item #1: PR automation
- Addresses medium-priority item #2: Release Notes Manager
- Addresses medium-priority item #3: Scope documentation
- Completes TODO in release-prep.yml (line 25)
## Next Steps
The release automation is now feature-complete for MVP:
- ✅ All critical issues resolved
- ✅ All medium-priority items completed
- ⏳ Low-priority polish items remain (optional)
---
**Dependencies:** Requires .cjs scripts from previous commit
**Breaking Changes:** None
**Migration Required:** None1 parent 2fe22c7 commit bc5cf9f
File tree
4 files changed
+1008
-1
lines changed- .github
- agents
- workflows
- docs
- scripts
4 files changed
+1008
-1
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
| 330 | + | |
| 331 | + | |
| 332 | + | |
| 333 | + | |
| 334 | + | |
| 335 | + | |
| 336 | + | |
| 337 | + | |
| 338 | + | |
| 339 | + | |
| 340 | + | |
| 341 | + | |
| 342 | + | |
| 343 | + | |
| 344 | + | |
| 345 | + | |
| 346 | + | |
| 347 | + | |
| 348 | + | |
| 349 | + | |
| 350 | + | |
| 351 | + | |
| 352 | + | |
| 353 | + | |
| 354 | + | |
| 355 | + | |
| 356 | + | |
| 357 | + | |
| 358 | + | |
| 359 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
22 | 22 | | |
23 | 23 | | |
24 | 24 | | |
25 | | - | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
26 | 29 | | |
27 | 30 | | |
28 | 31 | | |
0 commit comments