feat: add generate-release-notes Claude skill#10123
Conversation
… file management instructions
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive Claude skill for generating release notes from git commits and pull requests, along with supporting scripts, guidelines, and historical release notes examples.
Key changes:
- New Claude skill with detailed workflow for generating release notes
- Shell scripts for fetching and filtering commits between releases
- Comprehensive guideline documentation for consistent release note formatting
- Historical release notes from v1.6.50 to v1.12.158 serving as reference examples
Reviewed changes
Copilot reviewed 34 out of 35 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
.claude/skills/generate-release-notes/SKILL.md |
Detailed workflow documentation for the Claude skill to generate release notes, including commit fetching, filtering, categorization, and formatting steps |
releases-docs/scripts/get-release-commits.sh |
Shell script to fetch commits between releases using GitHub API, handles both annotated and lightweight git tags |
releases-docs/scripts/filter-commits.sh |
Shell script to filter out uninteresting commits (version bumps, CI changes, merge commits) from release notes |
releases-docs/guideline.md |
Comprehensive guidelines for writing consistent release notes, including section order, formatting rules, and examples |
releases-docs/releases/*.md |
26 historical release note files (v1.6.50 to v1.12.158) serving as reference examples for the skill |
.gitignore |
Updated to exclude Claude code files but preserve skills directory, and exclude temporary release note files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Fix an issue where `bit start` spinners abstracted errors (#9287) | ||
| - Fix an error where outdated local index caused Bit to fail communicating with remote server (#9242) | ||
|
|
||
| ## Internal |
There was a problem hiding this comment.
Inconsistent section header levels: Line 44 uses ## (H2) while the surrounding sections use ### (H3). According to line 50 of the guideline, ### is preferred for consistency. Should be changed to ### Internal to match the rest of the document.
| ## Internal | |
| ### Internal |
| immutable: false | ||
| author: GiladShoham | ||
| created: 2025-03-18T09:19:12Z | ||
| published: 2025-03-17T13:13:45Z |
There was a problem hiding this comment.
The date format shows the published date (2025-03-17T13:13:45Z) is actually earlier than the created date (2025-03-18T09:19:12Z). This is logically inconsistent - a release cannot be published before it was created.
| published: 2025-03-17T13:13:45Z | |
| published: 2025-03-18T09:19:12Z |
| url: https://github.com/teambit/bit/releases/tag/v1.8.127 | ||
| -- | ||
|
|
||
| ## Improvements |
There was a problem hiding this comment.
Inconsistent section header levels: Line 12 uses ## (H2) while most other sections in the document use ### (H3). According to line 50, ### is preferred for consistency. Should be changed to ### Improvements to match the rest of the document.
| ## Improvements | |
| ### Improvements |
|
|
||
| ``` |
There was a problem hiding this comment.
The guideline shows a code block for JSON configuration but the markdown code fence is not properly closed. After line 91, there should be three backticks (```) to close the code block before the next bullet point starts at line 93.
| ``` |
| - Introduce a new `bit blame` command to show a per-line information on when it was last modified and by whom (#9271, #9272) | ||
| - UI, CLI, error messages, outputs and various Dev-Ex improvements (#9297, #9217, #9311, #9275, #9260, #9293, #9283, #9245, #9291, #9238, #9302, #9288, #9248, #9294, #9284, #9241, #9316, #9250) | ||
|
|
||
| ## Bug Fixes |
There was a problem hiding this comment.
Inconsistent section header levels: Line 24 uses ## (H2) while the surrounding sections use ### (H3). According to line 50 of the guideline, ### is preferred for consistency. Should be changed to ### Bug Fixes to match the rest of the document.
| ## Bug Fixes | |
| ### Bug Fixes |
| - Fix an issue where API-reference didn't pick up on exported types (#9512) | ||
| - Fix an issue where config-writer throws an error about `failed generating config files` after deleting `node_modules` (#9508) | ||
| - Fix an issue where `bit server-forever` failed on Windows (#9499) | ||
| - Fix and issue where plugin resolution path was incorrect and led to "file not found" errors (#9561) |
There was a problem hiding this comment.
Spelling error: "Fix and issue where" should be "Fix an issue where". The article "an" is missing before "issue".
| ### Bug Fixes | ||
|
|
||
| - Fix an issue where `+` sign was saved to component's `package.json` instead of actual resolved version (#9685) | ||
| - Fix an issue where preview content height was nto calculated correctly (#9684) |
There was a problem hiding this comment.
Typo: "Fix an issue where preview content height was nto calculated correctly" contains "nto" which should be "not".
| - Fix an issue where preview content height was nto calculated correctly (#9684) | |
| - Fix an issue where preview content height was not calculated correctly (#9684) |
Adds a new Claude skill for generating comprehensive release notes from git commits and pull requests.