Skip to content

Feature/55 chapter line formatting authors final #188

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 7, 2025
Merged

Feature/55 chapter line formatting authors final #188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7f7f250
#55 - Chapter line formatting - authors
miroslavpojer Oct 7, 2025
ba21bba
Fixed typo and checkers.
miroslavpojer Oct 7, 2025
c1618e5
Fixed rabbit review comments.
miroslavpojer Oct 7, 2025
7ab01f3
Fixed rabbit review comments.
miroslavpojer Oct 7, 2025
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
40 changes: 20 additions & 20 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,26 +41,26 @@ Generate Release Notes action is dedicated to enhance the quality and organizati

## Inputs

| Name | Description | Required | Default |
|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------------------------------------------------|
| `GITHUB_TOKEN` | Your GitHub token for authentication. Store it as a secret and reference it in the workflow file as secrets.GITHUB_TOKEN. | Yes | |
| `tag-name` | The name of the tag for which you want to generate release notes. This should be the same as the tag name used in the release workflow. | Yes | |
| `from-tag-name` | The name of the tag from which you want to generate release notes. | No | '' |
| `chapters` | An YAML array defining chapters and corresponding labels for categorization. Each chapter should have a title and a label matching your GitHub issues and PRs. | Yes | |
| `hierarchy` | Set to true to enable issue hierarchy handling. When enabled, the action will organize issues based on their hierarchical relationships (e.g., Epics and their child issues). This is useful for projects that use issue types to represent different levels of work. | No | false |
| `row-format-hierarchy-issue` | The format of the row for the hierarchy issue in the release notes. Placeholders: `type`, `number`, `title` (case-sensitive). | No | `"{type}: _{title}_ {number}"` |
| `row-format-issue` | The format of the row for the issue in the release notes. The format can contain placeholders for the issue `type`, `number`, `title`, and issues `pull-requests`. The placeholders are case-sensitive. | No | `"{type}: {number} _{title}_ in {pull-requests}"` |
| `row-format-pr` | The format of the row for the PR in the release notes. The format can contain placeholders for the PR `number`, and `title`. The placeholders are case-sensitive. | No | `"{number} _{title}_"` |
| `row-format-link-pr` | If defined `true`, the PR row will begin with a `"PR: "` string. Otherwise, no prefix will be added. | No | true |
| `duplicity-scope` | Set to `custom` to allow duplicity issue lines to be shown only in custom chapters. Options: `custom`, `service`, `both`, `none`. | No | `both` |
| `duplicity-icon` | The icon used to indicate duplicity issue lines in the release notes. Icon will be placed at the beginning of the line. | No | `🔔` |
| `published-at` | Set to true to enable the use of the `published-at` timestamp as the reference point for searching closed issues and PRs, instead of the `created-at` date of the latest release. If first release, repository creation date is used. | No | false |
| `skip-release-notes-labels` | List labels used for detection if issues or pull requests are ignored in the Release Notes generation process. Example: `skip-release-notes, question`. | No | `skip-release-notes` |
| `verbose` | Set to true to enable verbose logging for detailed output during the action's execution. | No | false |
| `release-notes-title` | The title of the release notes section in the PR description. | No | `[Rr]elease [Nn]otes:` |
| `coderabbit-support-active` | Enable CodeRabbit support. If true, the action will use CodeRabbit to generate release notes. | No | false |
| `coderabbit-release-notes-title` | The title of the CodeRabbit summary in the PR body. Value supports regex. | No | `Summary by CodeRabbit` |
| `coderabbit-summary-ignore-groups` | List of "group names" to be ignored by release notes detection logic. Example: `Documentation, Tests, Chores, Bug Fixes`. | No | '' |
| Name | Description | Required | Default |
|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-----------------------------------------------------------------------------|
| `GITHUB_TOKEN` | Your GitHub token for authentication. Store it as a secret and reference it in the workflow file as secrets.GITHUB_TOKEN. | Yes | |
| `tag-name` | The name of the tag for which you want to generate release notes. This should be the same as the tag name used in the release workflow. | Yes | |
| `from-tag-name` | The name of the tag from which you want to generate release notes. | No | '' |
| `chapters` | An YAML array defining chapters and corresponding labels for categorization. Each chapter should have a title and a label matching your GitHub issues and PRs. | Yes | |
| `hierarchy` | Set to true to enable issue hierarchy handling. When enabled, the action will organize issues based on their hierarchical relationships (e.g., Epics and their child issues). This is useful for projects that use issue types to represent different levels of work. | No | false |
| `row-format-hierarchy-issue` | The format of the row for the hierarchy issue in the release notes. Placeholders: `type`, `number`, `title`, `author`, `assignees`, `developers` (case-sensitive). | No | `"{type}: _{title}_ {number}"` |
| `row-format-issue` | The format of the row for the issue in the release notes. The format can contain placeholders for the issue `type`, `number`, `title`, `author`, `assignees`, `developers`, and issues `pull-requests`. The placeholders are case-sensitive. | No | `"{type}: {number} _{title}_ developed by {developers} in {pull-requests}"` |
| `row-format-pr` | The format of the row for the PR in the release notes. The format can contain placeholders for the PR `number`, `author`, `assignees`, `developers`, and `title`. The placeholders are case-sensitive. | No | `"{number} _{title}_ developed by {developers}"` |
| `row-format-link-pr` | If defined `true`, the PR row will begin with a `"PR: "` string. Otherwise, no prefix will be added. | No | true |
| `duplicity-scope` | Set to `custom` to allow duplicity issue lines to be shown only in custom chapters. Options: `custom`, `service`, `both`, `none`. | No | `both` |
| `duplicity-icon` | The icon used to indicate duplicity issue lines in the release notes. Icon will be placed at the beginning of the line. | No | `🔔` |
| `published-at` | Set to true to enable the use of the `published-at` timestamp as the reference point for searching closed issues and PRs, instead of the `created-at` date of the latest release. If first release, repository creation date is used. | No | false |
| `skip-release-notes-labels` | List labels used for detection if issues or pull requests are ignored in the Release Notes generation process. Example: `skip-release-notes, question`. | No | `skip-release-notes` |
| `verbose` | Set to true to enable verbose logging for detailed output during the action's execution. | No | false |
| `release-notes-title` | The title of the release notes section in the PR description. | No | `[Rr]elease [Nn]otes:` |
| `coderabbit-support-active` | Enable CodeRabbit support. If true, the action will use CodeRabbit to generate release notes. | No | false |
| `coderabbit-release-notes-title` | The title of the CodeRabbit summary in the PR body. Value supports regex. | No | `Summary by CodeRabbit` |
| `coderabbit-summary-ignore-groups` | List of "group names" to be ignored by release notes detection logic. Example: `Documentation, Tests, Chores, Bug Fixes`. | No | '' |

> **Notes**
> - `skip-release-notes-labels`
Expand Down
10 changes: 5 additions & 5 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,17 @@ inputs:
required: false
default: ''
row-format-hierarchy-issue:
description: 'Format of the hierarchy issue in the release notes. Available placeholders: {type}, {number}, {title}. Placeholders are case-insensitive.'
description: 'Format of the hierarchy issue in the release notes. Available placeholders: {type}, {number}, {title}, {author}, {assignees}, {developers}. Placeholders are case-insensitive.'
required: false
default: '{type}: _{title}_ {number}'
row-format-issue:
description: 'Format of the issue row in the release notes. Available placeholders: {type}, {number}, {title}, {pull-requests}. Placeholders are case-insensitive.'
description: 'Format of the issue row in the release notes. Available placeholders: {type}, {number}, {title}, {author}, {assignees}, {developers}, {pull-requests}. Placeholders are case-insensitive.'
required: false
default: '{type}: {number} _{title}_ in {pull-requests}'
default: '{type}: {number} _{title}_ developed by {developers} in {pull-requests}'
row-format-pr:
description: 'Format of the pr row in the release notes. Available placeholders: {number}, {title}. Placeholders are case-insensitive.'
description: 'Format of the pr row in the release notes. Available placeholders: {number}, {title}, {developers}. Placeholders are case-insensitive.'
required: false
default: '{number} _{title}_'
default: '{number} _{title}_ developed by {developers}'
row-format-link-pr:
description: 'Add prefix "PR:" before link to PR when not linked an Issue.'
required: false
Expand Down
6 changes: 4 additions & 2 deletions release_notes_generator/action_inputs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,7 +326,7 @@ def get_row_format_issue() -> str:
if ActionInputs._row_format_issue is None:
ActionInputs._row_format_issue = ActionInputs._detect_row_format_invalid_keywords(
get_action_input(
ROW_FORMAT_ISSUE, "{type}: {number} _{title}_ in {pull-requests}"
ROW_FORMAT_ISSUE, "{type}: {number} _{title}_ developed by {developers} in {pull-requests}"
).strip(), # type: ignore[union-attr]
clean=True,
# mypy: string is returned as default
Expand All @@ -340,7 +340,9 @@ def get_row_format_pr() -> str:
"""
if ActionInputs._row_format_pr is None:
ActionInputs._row_format_pr = ActionInputs._detect_row_format_invalid_keywords(
get_action_input(ROW_FORMAT_PR, "{number} _{title}_").strip(), # type: ignore[union-attr]
get_action_input(
ROW_FORMAT_PR, "{number} _{title}_ developed by {developers}"
).strip(), # type: ignore[union-attr]
row_type=ActionInputs.ROW_TYPE_PR,
clean=True,
# mypy: string is returned as default
Expand Down
2 changes: 1 addition & 1 deletion release_notes_generator/builder/builder.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@

from release_notes_generator.action_inputs import ActionInputs
from release_notes_generator.chapters.custom_chapters import CustomChapters
from release_notes_generator.model.record import Record
from release_notes_generator.chapters.service_chapters import ServiceChapters
from release_notes_generator.model.record.record import Record

logger = logging.getLogger(__name__)

Expand Down
2 changes: 1 addition & 1 deletion release_notes_generator/chapters/base_chapters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
from datetime import datetime

from release_notes_generator.model.chapter import Chapter
from release_notes_generator.model.record import Record
from release_notes_generator.model.record.record import Record


class BaseChapters(ABC):
Expand Down
4 changes: 2 additions & 2 deletions release_notes_generator/chapters/custom_chapters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@
from release_notes_generator.action_inputs import ActionInputs
from release_notes_generator.chapters.base_chapters import BaseChapters
from release_notes_generator.model.chapter import Chapter
from release_notes_generator.model.commit_record import CommitRecord
from release_notes_generator.model.record import Record
from release_notes_generator.model.record.commit_record import CommitRecord
from release_notes_generator.model.record.record import Record
from release_notes_generator.utils.enums import DuplicityScopeEnum

logger = logging.getLogger(__name__)
Expand Down
8 changes: 4 additions & 4 deletions release_notes_generator/chapters/service_chapters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@
from release_notes_generator.action_inputs import ActionInputs
from release_notes_generator.chapters.base_chapters import BaseChapters
from release_notes_generator.model.chapter import Chapter
from release_notes_generator.model.commit_record import CommitRecord
from release_notes_generator.model.issue_record import IssueRecord
from release_notes_generator.model.pull_request_record import PullRequestRecord
from release_notes_generator.model.record import Record
from release_notes_generator.model.record.commit_record import CommitRecord
from release_notes_generator.model.record.issue_record import IssueRecord
from release_notes_generator.model.record.pull_request_record import PullRequestRecord
from release_notes_generator.model.record.record import Record
from release_notes_generator.utils.constants import (
CLOSED_ISSUES_WITHOUT_PULL_REQUESTS,
CLOSED_ISSUES_WITHOUT_USER_DEFINED_LABELS,
Expand Down
Loading
Loading