Implement hidden flag for custom chapters by Copilot · Pull Request #249 · AbsaOSS/generate-release-notes

Copilot · 2026-01-15T10:51:16Z

Overview

Adds support for a hidden boolean flag in custom chapter definitions. Hidden chapters are processed normally (records assigned, tracked) but excluded from final output and don't count toward duplicity detection.

Release Notes

Add hidden: true/false flag to custom chapter definitions for selectively hiding chapters from release notes output
Hidden chapters process records but don't increment duplicity counters, enabling draft workflows without modifying YAML structure

Implementation

Chapter Model

Added hidden: bool = False attribute to Chapter class

YAML Parsing

Accepts boolean values or boolean-like strings ("true", "false", case-insensitive)
Invalid values log warning and default to false
Omitted field defaults to false for backward compatibility

Population Logic

Hidden chapters: to_chapter_row(add_into_chapters=False) → no duplicity count
Visible chapters: to_chapter_row(add_into_chapters=True) → existing behavior
Only visible chapters call add_to_chapter_presence()

Rendering

Override to_string() to filter hidden chapters before output
Hidden chapters excluded regardless of print-empty-chapters setting

Documentation

README.md: Added hidden chapter examples in Manual Release Dispatch workflow
docs/features/custom_chapters.md: Added comprehensive "Hidden Chapters" section with purpose, behavior, examples, validation, and FAQ
docs/configuration_reference.md: Updated Inputs table and Custom Chapters Behavior section with hidden flag details

Tests

Added 21 comprehensive tests covering YAML parsing, validation, population, rendering, duplicity detection, and logging
Removed 2 duplicate tests for cleaner test suite
Enhanced test documentation with detailed docstrings explaining duplicity counter behavior

Example

chapters: |
  - title: "Features 🎉"
    labels: ["feature", "enhancement"]
  
  - title: "Bugfixes 🛠"
    labels: ["bug"]
  
  - title: "Internal Notes 📝"
    labels: ["internal"]
    hidden: true  # Tracked but not rendered

Duplicity behavior:

Record in 1 visible + 1 hidden chapter → duplicity count = 1 (no icon)
Record in 2 visible + 1 hidden chapter → duplicity count = 2 (🔔 icon appears)
Record in 0 visible + 2 hidden chapters → not visible in custom chapters section

Quality Verification

✅ All 301 unit tests pass
✅ Test coverage: 92%
✅ Pylint score: 9.95/10
✅ Mypy: No type errors
✅ Comprehensive documentation added

Custom agent used: Senior Developer
Implements features and fixes with high quality, meeting specs and tests.

Original prompt

Implement issue: #102

Custom agent used: Senior Developer
Implements features and fixes with high quality, meeting specs and tests.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

coderabbitai · 2026-01-15T10:51:25Z

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Note

Other AI code review bot(s) detected

CodeRabbit 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 @coderabbitai help to get the list of available commands and usage tips.}

Co-authored-by: miroslavpojer <109138042+miroslavpojer@users.noreply.github.com>

…iable usage Co-authored-by: miroslavpojer <109138042+miroslavpojer@users.noreply.github.com>

miroslavpojer

@copilot fix following review comments

Missing update of markdown files:

README.md: add example chapter with hidden input - Example - Manual Release Dispatch
custom_chapters.md: add to this file describing custom chapters feature
configuration_reference.md: section Chapters Configuration and in Inputs table

Other review comments to fix:

test_from_yaml_array_legacy_single_label_with_hidden seem to be duplicit
add more comments to tests: test_populate_hidden_chapter_no_duplicity_count, test_populate_visible_chapter_duplicity_count
test test_to_string_hidden_empty_chapter_not_shown seems to be duplcite to test_to_string_all_hidden_returns_empty

Co-authored-by: miroslavpojer <109138042+miroslavpojer@users.noreply.github.com>

Copilot · 2026-01-15T12:42:05Z

@copilot fix following review comments

Missing update of markdown files:...

All review comments addressed in commit 352ff4c:

Documentation Updates:

✅ README.md: Added hidden chapter examples in Manual Release Dispatch section
✅ custom_chapters.md: Added comprehensive "Hidden Chapters" section with purpose, behavior, examples, validation, and FAQ entries
✅ configuration_reference.md: Updated Inputs table and Custom Chapters Behavior section with hidden flag details

Test Improvements:

✅ Removed duplicate test_from_yaml_array_legacy_single_label_with_hidden (covered by test_from_yaml_array_multi_label_with_hidden)
✅ Removed duplicate test_to_string_hidden_empty_chapter_not_shown (merged into test_to_string_all_hidden_returns_empty)
✅ Added detailed docstrings to test_populate_hidden_chapter_no_duplicity_count and test_populate_visible_chapter_duplicity_count explaining duplicity counter behavior

All 301 tests pass.

miroslavpojer

I agree with edits. Small improvements will follow.

… examples

Copilot

Pull request overview

This PR implements a hidden flag for custom chapters, allowing chapters to process records normally while being excluded from release notes output and duplicity detection.

Changes:

Added hidden: bool = False attribute to Chapter model with parsing/validation logic
Modified CustomChapters.populate() to track hidden chapters without incrementing duplicity counters
Overrode CustomChapters.to_string() to filter hidden chapters from final output
Added comprehensive documentation in README.md, docs/features/custom_chapters.md, and docs/configuration_reference.md
Added 21 new unit tests covering parsing, validation, population logic, rendering, and logging behavior

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
release_notes_generator/model/chapter.py	Added `hidden` boolean attribute to Chapter class
release_notes_generator/chapters/custom_chapters.py	Implemented hidden chapter logic in populate() and added to_string() override
tests/unit/release_notes_generator/chapters/test_custom_chapters.py	Added comprehensive test coverage for hidden flag functionality
docs/features/custom_chapters.md	Added "Hidden Chapters" section with purpose, behavior, examples, and FAQ
docs/configuration_reference.md	Updated inputs table and chapters behavior section to document hidden flag
README.md	Added hidden chapter examples in workflow configuration

release_notes_generator/chapters/custom_chapters.py

tests/unit/release_notes_generator/chapters/test_custom_chapters.py

…chapter rows

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

tmikula-dev

I have nothing to add. GJ, it looks good to me.

Initial plan

89b68c1

Copilot AI assigned Copilot and miroslavpojer Jan 15, 2026

Copilot started work on behalf of miroslavpojer January 15, 2026 10:51 View session

Copilot AI and others added 2 commits January 15, 2026 10:57

Implement hidden flag for custom chapters (issue #102)

223c802

Co-authored-by: miroslavpojer <109138042+miroslavpojer@users.noreply.github.com>

Address code review feedback: improve test isolation and simplify var…

5fff3df

…iable usage Co-authored-by: miroslavpojer <109138042+miroslavpojer@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Fix issue with generating release notes~~ Implement hidden flag for custom chapters Jan 15, 2026

Copilot finished work on behalf of miroslavpojer January 15, 2026 11:04

Copilot AI requested a review from miroslavpojer January 15, 2026 11:04

miroslavpojer reviewed Jan 15, 2026

View reviewed changes

Copilot started work on behalf of miroslavpojer January 15, 2026 12:36 View session

Address review feedback: update documentation and improve tests

352ff4c

Co-authored-by: miroslavpojer <109138042+miroslavpojer@users.noreply.github.com>

Copilot AI requested a review from miroslavpojer January 15, 2026 12:43

Copilot finished work on behalf of miroslavpojer January 15, 2026 12:43

miroslavpojer reviewed Jan 15, 2026

View reviewed changes

Refine documentation for hidden chapters: clarify behavior and update…

b67e139

… examples

miroslavpojer marked this pull request as ready for review January 15, 2026 13:02

miroslavpojer requested a review from tmikula-dev as a code owner January 15, 2026 13:02

miroslavpojer requested a review from Copilot January 15, 2026 13:02

Copilot AI reviewed Jan 15, 2026

View reviewed changes

release_notes_generator/chapters/custom_chapters.py Show resolved Hide resolved

tests/unit/release_notes_generator/chapters/test_custom_chapters.py Outdated Show resolved Hide resolved

Enhance hidden validation test: include record population and assert …

4a3d942

…chapter rows

miroslavpojer requested a review from Copilot January 15, 2026 13:15

Copilot AI reviewed Jan 15, 2026

View reviewed changes

tmikula-dev approved these changes Jan 15, 2026

View reviewed changes

miroslavpojer merged commit dd6d36f into master Jan 16, 2026
8 checks passed

miroslavpojer deleted the copilot/fix-issue-102-release-notes branch January 16, 2026 11:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Implement hidden flag for custom chapters#249

Implement hidden flag for custom chapters#249
miroslavpojer merged 6 commits intomasterfrom
copilot/fix-issue-102-release-notes

Copilot AI commented Jan 15, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Jan 15, 2026 •

edited

Loading

Review skipped

Other AI code review bot(s) detected

Uh oh!

miroslavpojer left a comment

Uh oh!

Copilot AI commented Jan 15, 2026

Uh oh!

miroslavpojer left a comment

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

tmikula-dev left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

Conversation

Copilot AI commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Release Notes

Related

Implementation

Example

Quality Verification

Uh oh!

coderabbitai bot commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Other AI code review bot(s) detected

Uh oh!

miroslavpojer left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Jan 15, 2026

Uh oh!

miroslavpojer left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

tmikula-dev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Jan 15, 2026 •

edited

Loading

coderabbitai bot commented Jan 15, 2026 •

edited

Loading