Skip to content

[Enhancement]: Omit empty sections in generated release notes #3368

@lcawl

Description

@lcawl

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

The changelog directive currently generates empty sections when there is no content. For example, in https://www.elastic.co/docs/release-notes/cloud-hosted/known-issues

Image

This gets quite noisy for products that have a lot of releases (e.g. in Cloud Serverless tests like elastic/docs-content#6599)

Proposed Solution

Ideally the directive should only generate output if there are relevant entries.
If necessary, we could make this configurable with a new option (akin to the :dropdowns: and :subsections: options).

Examples and Research

No response

Alternative Solutions

No response

Additional Context

No response

How important is this feature to you?

Nice to have

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions