Hiddenden/openrabbit
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects 1 Releases Wiki Activity

Feature: PR Changelog Generator #12

New Issue
Closed
opened 2025-12-28 19:22:15 +00:00 by Latte · 5 comments
Latte commented 2025-12-28 19:22:15 +00:00
Owner
Copy Link

📝 Feature: PR Changelog Generator

Priority: MEDIUM
Effort: 3-4 hours
Value: MEDIUM
Labels: feature, milestone-2, automation, changelog

Description

Implement @codebot changelog command that generates human-readable changelog entries from PR changes for release notes and CHANGELOG.md files.

Use Cases

  • Automated release note generation
  • CHANGELOG.md maintenance
  • Version documentation
  • Customer-facing release announcements

Tasks

Days 1-2: Core Implementation

  • Design changelog output format (Keep a Changelog style)
  • Implement _command_changelog() method in PRAgent
  • Add command to tools/ai-review/config.yml
  • Parse PR commits and extract meaningful changes
  • Categorize changes (Added, Changed, Fixed, etc.)

Day 3: Enhancement

  • Detect breaking changes automatically
  • Extract technical details (files changed, LOC)
  • Group related changes together
  • Filter out noise (formatting, typos, etc.)

Days 4-5: Testing & Polish

  • Test with various PR types
  • Validate changelog format
  • Add configuration options (format, verbosity)
  • Documentation
  • Deploy to production

Files to Modify

tools/ai-review/
├── config.yml
├── agents/pr_agent.py
└── prompts/changelog.md (new)

Expected Output Format

**Changelog for PR #123:**

### Added
- User authentication system with JWT tokens
- Password reset functionality via email

### Changed
- Updated database schema for user table
- Refactored login endpoint for better error handling

### Fixed
- Session timeout bug causing premature logouts
- Security vulnerability in password validation

### Technical Details
- 15 files changed, 450 insertions, 120 deletions
- Main components: auth/, api/users/, database/

Acceptance Criteria

  • Command responds to @codebot changelog
  • Follows Keep a Changelog format
  • Categorizes changes correctly (Added/Changed/Fixed/etc.)
  • Detects breaking changes
  • Includes technical summary
  • Output is ready for copy-paste to CHANGELOG.md
  • Generation completes within 30 seconds

Success Metrics

  • Changelog generation time reduced by 80%
  • 90%+ of changelogs accurate and useful
  • Used on 50%+ of releases within first month

Testing Checklist

  • Test with feature PRs
  • Test with bugfix PRs
  • Test with mixed PRs (features + fixes)
  • Test with breaking changes
  • Validate against existing changelogs

Related Issues

  • Parent: #1 (Milestone 2 Epic)
  • Related: #2 (Code Diff Explainer)
## 📝 Feature: PR Changelog Generator **Priority:** MEDIUM **Effort:** 3-4 hours **Value:** MEDIUM **Labels:** `feature`, `milestone-2`, `automation`, `changelog` ### Description Implement `@codebot changelog` command that generates human-readable changelog entries from PR changes for release notes and CHANGELOG.md files. ### Use Cases - Automated release note generation - CHANGELOG.md maintenance - Version documentation - Customer-facing release announcements ### Tasks **Days 1-2: Core Implementation** - [ ] Design changelog output format (Keep a Changelog style) - [ ] Implement `_command_changelog()` method in `PRAgent` - [ ] Add command to `tools/ai-review/config.yml` - [ ] Parse PR commits and extract meaningful changes - [ ] Categorize changes (Added, Changed, Fixed, etc.) **Day 3: Enhancement** - [ ] Detect breaking changes automatically - [ ] Extract technical details (files changed, LOC) - [ ] Group related changes together - [ ] Filter out noise (formatting, typos, etc.) **Days 4-5: Testing & Polish** - [ ] Test with various PR types - [ ] Validate changelog format - [ ] Add configuration options (format, verbosity) - [ ] Documentation - [ ] Deploy to production ### Files to Modify ``` tools/ai-review/ ├── config.yml ├── agents/pr_agent.py └── prompts/changelog.md (new) ``` ### Expected Output Format ```markdown **Changelog for PR #123:** ### Added - User authentication system with JWT tokens - Password reset functionality via email ### Changed - Updated database schema for user table - Refactored login endpoint for better error handling ### Fixed - Session timeout bug causing premature logouts - Security vulnerability in password validation ### Technical Details - 15 files changed, 450 insertions, 120 deletions - Main components: auth/, api/users/, database/ ``` ### Acceptance Criteria - [ ] Command responds to `@codebot changelog` - [ ] Follows Keep a Changelog format - [ ] Categorizes changes correctly (Added/Changed/Fixed/etc.) - [ ] Detects breaking changes - [ ] Includes technical summary - [ ] Output is ready for copy-paste to CHANGELOG.md - [ ] Generation completes within 30 seconds ### Success Metrics - [ ] Changelog generation time reduced by 80% - [ ] 90%+ of changelogs accurate and useful - [ ] Used on 50%+ of releases within first month ### Testing Checklist - [ ] Test with feature PRs - [ ] Test with bugfix PRs - [ ] Test with mixed PRs (features + fixes) - [ ] Test with breaking changes - [ ] Validate against existing changelogs ### Related Issues - Parent: #1 (Milestone 2 Epic) - Related: #2 (Code Diff Explainer)
Latte added this to the Milestone 2: PR Workflow Enhancement milestone 2025-12-28 19:22:15 +00:00
Latte commented 2025-12-28 19:22:46 +00:00
Author
Owner
Copy Link

@codebot help

@codebot help
Bartender commented 2025-12-28 19:22:53 +00:00
Owner
Copy Link

@user

Note: This review was generated by an AI assistant. While it aims to be accurate and helpful, it may contain mistakes or miss important issues. Please verify all findings before taking action.

Available @codebot Commands

Issue Triage & Analysis

  • @codebot triage - Full issue triage with auto-labeling and priority assignment
  • @codebot summarize - Generate 2-3 sentence summary of the issue
  • @codebot explain - Detailed explanation of what the issue is about
  • @codebot suggest - Solution suggestions or next steps
  • @codebot security - Security-focused analysis of the issue

Interactive Chat

  • @codebot [question] - Ask questions about the codebase (uses search & file reading tools)
    • Example: @codebot how does authentication work?
    • Example: @codebot find all API endpoints

Setup & Utility

  • @codebot help - Show this help message
  • @codebot setup-labels - Auto-create/map repository labels for auto-labeling

Pull Request Analysis

PR reviews run automatically when you open or update a pull request. The bot provides:

  • Inline code review comments
  • Security vulnerability scanning
  • Approval or change-request recommendations

Manual re-review:

  • @codebot review-again - Re-run AI review on current PR state (in PR comments)
    • Shows diff from previous review (resolved/new issues)
    • Updates labels and recommendations
    • Useful after addressing feedback or updating config

Quick Examples

Triage an issue:

@codebot triage

Get help understanding:

@codebot explain

Ask about the codebase:

@codebot how does the authentication system work?

Setup repository labels:

@codebot setup-labels

For full documentation, see the README

@user **Note:** This review was generated by an AI assistant. While it aims to be accurate and helpful, it may contain mistakes or miss important issues. Please verify all findings before taking action. ## Available @codebot Commands ### Issue Triage & Analysis - `@codebot triage` - Full issue triage with auto-labeling and priority assignment - `@codebot summarize` - Generate 2-3 sentence summary of the issue - `@codebot explain` - Detailed explanation of what the issue is about - `@codebot suggest` - Solution suggestions or next steps - `@codebot security` - Security-focused analysis of the issue ### Interactive Chat - `@codebot [question]` - Ask questions about the codebase (uses search & file reading tools) - Example: `@codebot how does authentication work?` - Example: `@codebot find all API endpoints` ### Setup & Utility - `@codebot help` - Show this help message - `@codebot setup-labels` - Auto-create/map repository labels for auto-labeling ### Pull Request Analysis PR reviews run automatically when you open or update a pull request. The bot provides: - Inline code review comments - Security vulnerability scanning - Approval or change-request recommendations **Manual re-review:** - `@codebot review-again` - Re-run AI review on current PR state (in PR comments) - Shows diff from previous review (resolved/new issues) - Updates labels and recommendations - Useful after addressing feedback or updating config --- ### Quick Examples **Triage an issue:** ``` @codebot triage ``` **Get help understanding:** ``` @codebot explain ``` **Ask about the codebase:** ``` @codebot how does the authentication system work? ``` **Setup repository labels:** ``` @codebot setup-labels ``` --- *For full documentation, see the [README](https://github.com/YourOrg/OpenRabbit/blob/main/README.md)*
Bartender commented 2025-12-28 19:23:27 +00:00
Owner
Copy Link

Note: This review was generated by an AI assistant. While it aims to be accurate and helpful, it may contain mistakes or miss important issues. Please verify all findings before taking action.

AI Issue Triage

Field Value
Type Feature
Priority Medium
Confidence 100%

Summary: Implement a PR changelog generator command for automated release notes

Components: tools/ai-review, pr_agent.py, changelog.md

The issue clearly requests a new functionality to generate changelogs from PRs, describing detailed tasks and acceptance criteria. It is not a bug or support request, and the priority is medium as it is a valuable but non-blocking feature.

<!-- AI_ISSUE_TRIAGE --> **Note:** This review was generated by an AI assistant. While it aims to be accurate and helpful, it may contain mistakes or miss important issues. Please verify all findings before taking action. ## AI Issue Triage | Field | Value | |-------|--------| | **Type** | Feature | | **Priority** | Medium | | **Confidence** | 100% | **Summary:** Implement a PR changelog generator command for automated release notes **Components:** tools/ai-review, pr_agent.py, changelog.md --- *The issue clearly requests a new functionality to generate changelogs from PRs, describing detailed tasks and acceptance criteria. It is not a bug or support request, and the priority is medium as it is a valuable but non-blocking feature.*
Latte commented 2025-12-28 19:23:32 +00:00
Author
Owner
Copy Link

@codebot triage

@codebot triage
Bartender commented 2025-12-28 19:23:45 +00:00
Owner
Copy Link

@user

Note: This review was generated by an AI assistant. While it aims to be accurate and helpful, it may contain mistakes or miss important issues. Please verify all findings before taking action.

AI Issue Triage

Field Value
Type Feature
Priority Medium
Confidence 100%

Summary: Implement a PR changelog generator command for automated release notes and changelog maintenance

Components: tools/ai-review, pr_agent.py, config.yml, prompts/changelog.md

The issue clearly requests a new functionality to generate changelogs from PRs, describing detailed tasks, acceptance criteria, and success metrics. It is not a bug or support request, and the priority is medium as it is a valuable but non-blocking feature.

@user **Note:** This review was generated by an AI assistant. While it aims to be accurate and helpful, it may contain mistakes or miss important issues. Please verify all findings before taking action. ## AI Issue Triage | Field | Value | |-------|--------| | **Type** | Feature | | **Priority** | Medium | | **Confidence** | 100% | **Summary:** Implement a PR changelog generator command for automated release notes and changelog maintenance **Components:** tools/ai-review, pr_agent.py, config.yml, prompts/changelog.md --- *The issue clearly requests a new functionality to generate changelogs from PRs, describing detailed tasks, acceptance criteria, and success metrics. It is not a bug or support request, and the priority is medium as it is a valuable but non-blocking feature.*
Latte added this to the Development Roadmap project 2025-12-29 09:54:50 +00:00
Latte moved this to In Progress in Development Roadmap on 2025-12-29 10:43:33 +00:00
Latte added reference feature/pr-changelog-generator 2025-12-29 11:51:05 +00:00
Latte closed this issue 2025-12-29 11:55:19 +00:00
Latte moved this to Done in Development Roadmap on 2025-12-29 11:55:23 +00:00
Sign in to join this conversation.
feature/pr-changelog-generator
Branches Tags
Labels
Clear labels
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Question
Further information is requested
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status/Ai Approved
AI review approved this PR
 Status/Ai Changes Required
AI review found issues requiring changes
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
Compat/Breaking
Breaking change that won't be backward compatible
 Kind/Bug
Something is not working
 Kind/Documentation
Documentation changes
 Kind/Enhancement
Improve existing functionality
 Kind/Feature
New functionality
 Kind/Security
This is security issue
 Kind/Testing
Issue or pull request related to testing
Priority
Critical
1
The priority is critical
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
No Label
Milestone
No items
No Milestone Milestone 2: PR Workflow Enhancement
Projects
Clear projects
No project Development Roadmap
Assignees
Clear assignees
Bartender Latte
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Hiddenden/openrabbit#12
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?