Reorder service chapters: place "Closed Issues without User Defined Labels" immediately after user-defined chapters #248
Conversation
|
Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Comment |
- Modified ServiceChapters.to_string() to support excluding specific chapters - Added ServiceChapters.get_chapter_string() to retrieve individual chapter strings - Updated ReleaseNotesBuilder.build() to place "Closed Issues without User Defined Labels" chapter immediately after user-defined chapters - Updated all test expectations to reflect the new chapter ordering - All tests passing, Black formatted, Pylint 9.97/10, mypy clean Co-authored-by: miroslavpojer <[email protected]>
- Updated service_chapters.md to document the new ordering with "Closed Issues without User Defined Labels" appearing first - Updated example output files to reflect the new chapter order - Added explicit note about chapter ordering in the Service Chapter Set section Co-authored-by: miroslavpojer <[email protected]>
miroslavpojer
left a comment
miroslavpojer
left a comment
There was a problem hiding this comment.
- pulled
- code check
- Added chapter_order list in ServiceChapters.__init__ to define rendering sequence - Updated to_string() to iterate through chapter_order instead of self.chapters.values() - Removed special handling from ReleaseNotesBuilder - ordering is now self-contained - This approach is more maintainable and flexible for future chapter order changes Addresses review feedback from @miroslavpojer Co-authored-by: miroslavpojer <[email protected]>
miroslavpojer
left a comment
miroslavpojer
left a comment
There was a problem hiding this comment.
I like this change.
There was a problem hiding this comment.
Pull request overview
This PR reorders service chapters in generated release notes to place "Closed Issues without User Defined Labels chapter_order list within the ServiceChapters class for maintainable and flexible chapter ordering.
Changes:
- Added
chapter_orderlist toServiceChapters.__init__()to define rendering sequence - Updated
ServiceChapters.to_string()to iterate throughchapter_orderinstead of dictionary values - Updated test fixtures to reflect new chapter order
- Updated documentation and example outputs to show new service chapter ordering
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| release_notes_generator/chapters/service_chapters.py | Implemented chapter ordering logic with chapter_order list and updated to_string() method |
| tests/unit/release_notes_generator/builder/test_release_notes_builder.py | Updated test fixtures to reflect new service chapter order |
| docs/features/service_chapters.md | Updated documentation to reflect new chapter ordering with explicit numbered list |
| examples/output_example_with_hierarchy.md | Updated example output to show new chapter order |
| examples/output_example_no_hierarchy.md | Updated example output to show new chapter order |
Overview
Service chapters now render in logical priority order: "Closed Issues without User Defined Labels" appears immediately after user-defined chapters, followed by remaining service chapters. This surfaces unlabeled-but-closed issues more prominently in release notes.
The implementation uses an internally defined chapter order within the
ServiceChaptersclass, making the solution maintainable and flexible for future chapter reordering.Release Notes
Related
Closes #75
Changes
Chapter Ordering (Internally Defined)
ServiceChapters.__init__(): addedchapter_orderlist to define rendering sequenceServiceChapters.to_string(): updated to iterate throughchapter_orderinstead of dictionary valuesServiceChapters- no special handling needed in builderArchitecture Benefits:
Before:
After:
Documentation
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.