chore: update changelog tooling [skip-line-limit]#1314
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
📝 WalkthroughWalkthroughThis change migrates the project from conventional-changelog-cli to auto-changelog for changelog generation, removes obsolete CHANGELOG entries across multiple packages, and updates the version-bumping script to use the new tool with improved error handling. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
scripts/bump-versions.ts (1)
279-304:⚠️ Potential issue | 🟠 MajorBug: duplicate log messages and false success on failure path.
Three issues in
generateChangelog():
- Line 288 duplicates the "Generating changelog…" message already printed at Line 280.
- Line 299 (
✓ Changelog generated successfully) executes unconditionally after the innertry/catch, so it prints even when the innercatchon Line 295 fires — giving a misleading success message after a failure warning.- On the happy path, the success message prints twice (Lines 294 and 299).
Proposed fix — clean up the nested try/catch and remove duplicates
private generateChangelog(): void { console.log('\n📝 Generating changelog...') try { execSync('pnpm auto-changelog --help', { stdio: 'ignore', cwd: this.rootDir, }) - console.log('\n📝 Generating changelog...') - try { - execSync('pnpm auto-changelog -o CHANGELOG.md --commit-limit false --tag-prefix v', { - cwd: this.rootDir, - stdio: 'inherit', - }) - console.log(' ✓ Changelog generated successfully') - } catch (error) { - console.warn(' ⚠️ Could not generate changelog:', error) - } + execSync('pnpm auto-changelog -o CHANGELOG.md --commit-limit false --tag-prefix v', { + cwd: this.rootDir, + stdio: 'inherit', + }) console.log(' ✓ Changelog generated successfully') } catch (error) { console.warn(' ⚠️ Could not generate changelog:', error) console.log(' Continuing without changelog...') } }
fix #1313
Summary by CodeRabbit