Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
de66dc7
feat: add super-chapters support for grouping chapters by label
miroslavpojer Apr 2, 2026
8895bc2
feat: implement super-chapters functionality with uncategorized fallback
miroslavpojer Apr 2, 2026
b5b068c
fix: improve unclaimed IDs handling and normalize label input in Cust…
miroslavpojer Apr 2, 2026
d9291bc
Fixed review comments.
miroslavpojer Apr 2, 2026
d0250fd
Fix review comments.
miroslavpojer Apr 2, 2026
8679c2a
feat: enhance hierarchy issue rendering logic for open and closed par…
miroslavpojer Apr 2, 2026
30754f3
feat: add super-chapters support for grouping chapters by label
miroslavpojer Apr 2, 2026
203a8cf
Fixed after merge issues.
miroslavpojer Apr 6, 2026
b93b0db
Implemented partial split by super chapter label.
miroslavpojer Apr 6, 2026
abfb0ff
fix: simplify comment in CustomChapters class for clarity
miroslavpojer Apr 6, 2026
20cf902
Merge branch 'master' into fature/99-Super-chapters
miroslavpojer Apr 6, 2026
cd6cadc
refactor: streamline method calls in CustomChapters and HierarchyIssu…
miroslavpojer Apr 6, 2026
bafb0eb
Fixed review comments.
miroslavpojer Apr 6, 2026
583978f
Self-review and reduction of pylint exceptions.
miroslavpojer Apr 6, 2026
69d5b2d
Fixed black.
miroslavpojer Apr 6, 2026
4666b0d
refactor: update type hints in CustomChapters and HierarchyIssueRecor…
miroslavpojer Apr 6, 2026
2514d44
Fix review notes.
miroslavpojer Apr 6, 2026
f72bcc5
Fix review comments.
miroslavpojer Apr 6, 2026
2da077c
Fix review comments.
miroslavpojer Apr 6, 2026
8382e55
Fixed review comments.
miroslavpojer Apr 6, 2026
85774a5
Fixed review comment.
miroslavpojer Apr 6, 2026
bf1d759
Add caching for super-chapters input to optimize parsing
miroslavpojer Apr 7, 2026
d7a11ca
Fixed review comments.
miroslavpojer Apr 7, 2026
a6490c2
Fix review notes.
miroslavpojer Apr 7, 2026
fdd73c9
Fixed review comment.
miroslavpojer Apr 7, 2026
bc4354a
Refactor docstrings to improve parameter descriptions and return valu…
miroslavpojer Apr 7, 2026
ddcc01f
Add section on how release notes are recognized in the README
miroslavpojer Apr 7, 2026
f16b9cc
Enhance validation rules for chapter entries in custom chapters docum…
miroslavpojer Apr 7, 2026
95652ff
Clarify validation warnings for chapter entries in custom chapters do…
miroslavpojer Apr 7, 2026
5de0132
Merge branch 'master' into feature/282-Info-how-a-release-notes-entry…
miroslavpojer Apr 8, 2026
c355abd
Fixed typos found in review notes.
miroslavpojer Apr 9, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Categorize changes, highlight contributors, and maintain consistent release docu
- [Overview](#overview)
- [Motivation](#motivation)
- [Quick Start](#quick-start)
- [How Release Notes Are Recognized](#how-release-notes-are-recognized)
- [Requirements](#requirements)
- [Configuration](#configuration)
- [Example Workflow](#example-workflow)
Expand Down Expand Up @@ -76,6 +77,26 @@ https://github.com/org/repo/compare/v1.1.0...v1.2.0
3. Extract release note text and contributors.
4. Output a Markdown section ready for publishing.

## How Release Notes Are Recognized

The action looks for a section whose heading matches the first regex `[Rr]elease [Nn]otes:` (configurable via `release-notes-title`) in the **issue body**, then in each **linked PR body**. Every bullet line (`-`, `*`, or `+`) immediately below that heading becomes one release note entry.

**Example — issue or PR body:**

```markdown
Some intro text

Release Notes:
- Add user MFA enrollment flow
- Improve cache invalidation logic

Other commentary...
```

Only the first matching section per body is used; content outside it is ignored. If no section is found in any linked PR body and [CodeRabbit Integration](docs/features/coderabbit_integration.md) is enabled, the AI-generated summary is used as a fallback.

For full details — including the configurable title regex, `skip-release-notes-labels`, and edge cases — see [Release Notes Extraction](docs/features/release_notes_extraction.md).

## Requirements

To run this action successfully, make sure your environment meets the following requirements:
Expand Down
7 changes: 5 additions & 2 deletions docs/features/custom_chapters.md
Original file line number Diff line number Diff line change
Expand Up @@ -321,9 +321,12 @@ Feature #2 has no `scope:security` label of its own, but its aggregated set incl
Children within each rendered node are sorted **ascending by issue number**.

### Validation
- Entries missing `title` or `label`/`labels` are skipped with a warning.
- Non-dict entries are skipped with a warning.
- Empty labels after normalization cause the entry to be skipped with a warning.
- A missing `title` key causes the entry to be skipped with a warning.
- A `title` that is not a string or is blank/whitespace-only is skipped with a warning.
- A missing `label`/`labels` key causes the entry to be skipped with a warning.
- An invalid `label`/`labels` type (not a string or list) is treated as empty and causes the entry to be skipped with a warning.
- Labels that are empty after normalization (e.g. only blank tokens) cause the entry to be skipped with a warning.

## Related Features
- [Duplicity Handling](./duplicity_handling.md) – governs multi-chapter visibility.
Expand Down