Skip to content

Comments

chore: enhance release note command with grouping and context#4795

Merged
yomybaby merged 1 commit intomainfrom
chore/improve-release-note-command
Dec 10, 2025
Merged

chore: enhance release note command with grouping and context#4795
yomybaby merged 1 commit intomainfrom
chore/improve-release-note-command

Conversation

@yomybaby
Copy link
Member

@yomybaby yomybaby commented Dec 10, 2025

Summary

Enhanced the /improve-release-note slash command to provide better-structured and more contextual release notes.

Changes

New Analysis Step

  • Added Step 2 to analyze PRs and group related changes before formatting
  • Introduced PR description and Jira issue review process
  • Added guidance to use gh pr view for detailed PR information

Enhanced Formatting Requirements

  • Grouping: Related changes are now grouped within each category (e.g., "AI & Development", "File Management")
  • Context: Each group includes 1-2 sentence descriptions explaining changes and their impact
  • Professional tone: Added guideline to avoid exaggerated claims (like "5x faster", "60% reduction")
  • Language: Standardized output to English only
  • Example format: Added concrete example showing the grouped structure

Updated Workflow

  • Renumbered steps to accommodate the new analysis step
  • Step 2: Analyze and Group Related Changes (new)
  • Step 3: Format According to Guidelines (enhanced)
  • Step 4: Show Preview and Confirm (unchanged)
  • Step 5: Update Release (unchanged)

Benefits

  • Better readability: Grouped changes make it easier for users to understand what changed
  • More context: Descriptions help users quickly grasp the impact of changes
  • Professional quality: Avoids marketing-style exaggerations in technical documentation
  • Consistency: Standardized English output for international teams

Test Plan

  • Tested with v25.18.0-rc.1 release notes
  • Verified PR analysis and grouping works correctly
  • Confirmed contextual descriptions are generated
  • Validated that exaggerated claims are avoided

Checklist:

  • Documentation - Updated command instructions
  • Minimum required manager version - N/A (command-only change)
  • Specific setting for review - N/A
  • Minimum requirements to check during review - Test the command with a recent release
  • Test case(s) to demonstrate the difference - Tested with v25.18.0-rc.1

@github-actions github-actions bot added the size:M 30~100 LoC label Dec 10, 2025
Copy link
Member Author


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • flow:merge-queue - adds this PR to the back of the merge queue
  • flow:hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has required the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@yomybaby yomybaby marked this pull request as ready for review December 10, 2025 04:32
Copilot AI review requested due to automatic review settings December 10, 2025 04:32
@yomybaby yomybaby merged commit fd15e6d into main Dec 10, 2025
13 checks passed
@yomybaby yomybaby deleted the chore/improve-release-note-command branch December 10, 2025 04:32
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR enhances the /improve-release-note slash command to generate more structured and contextual GitHub release notes. The changes add an analysis step for grouping related PRs and provide clearer formatting guidelines with examples.

Key Changes:

  • Added Step 2 to analyze and group related PRs before formatting, including guidance on reviewing PR descriptions and Jira issues
  • Enhanced formatting requirements with grouping instructions, contextual descriptions, and professional language guidelines
  • Added a concrete example demonstrating the grouped format with contextual descriptions

### AI & Development Experience Enhancements
Enhanced integration with Claude Code and AI development tools. Added Backend.AI platform documentation skill for Claude Code and upgraded AI SDK to v5 with improved message handling.

- **FR-1697**: add a claude skill references the backend.ai docs by @nowgnuesLee in [#4669](...)
Copy link

Copilot AI Dec 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spelling error: "references" should be "reference" (singular form). The phrase should read "add a claude skill that references" or "add a claude skill referencing".

Suggested change
- **FR-1697**: add a claude skill references the backend.ai docs by @nowgnuesLee in [#4669](...)
- **FR-1697**: add a claude skill that references the backend.ai docs by @nowgnuesLee in [#4669](...)

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:M 30~100 LoC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant