Skip to content

Add :highlights: and keep-highlight-descriptions to changelog directive - #3803

Merged
lcawl merged 5 commits into
mainfrom
highlights
Aug 7, 2026
Merged

Add :highlights: and keep-highlight-descriptions to changelog directive#3803
lcawl merged 5 commits into
mainfrom
highlights

Conversation

@lcawl

@lcawl lcawl commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Goal

Highlights are a boolean flag (highlight: true), not an entry type.
The changelog directive should stop treating them as a :type: value.
This PR enables authors to put a "Highlights" section on any page that uses the directive (and optionally show their full descriptions even when none of the other sections show them)

Implementation details

  • Adds a new :highlights: option for the changelog directive
  • Adds a new :description-visibility: keep-highlight-descriptions option
  • Removes the highlights value from the :type: option

Code

  • :highlights: boolean on ChangelogBlock via PropBool("highlights"), threaded through ChangelogRenderOptions
  • Removed ChangelogTypeFilter.Highlight; legacy :type: highlight warns and falls back to Default
  • Highlights section gated on HighlightsEnabled (not :type: all); TOC/anchors updated to match
  • Added :description-visibility: keep-highlight-descriptions:
    • Shows record descriptions only in the Highlights section
    • Hides them in all other sections (including the Features copy of a highlighted entry)
    • Without :highlights:, hides descriptions everywhere

Docs / fixtures

Tests

Screenshots

When I add a directive like this in the Cloud Serverless release notes page:

:::{changelog}
:cdn: cloud-serverless
:highlights:
:description-visibility:  keep-highlight-descriptions
:link-visibility: keep-links
:::

The rendered page contains highlight sections like this:

image

And another:

image

Generative AI disclosure

  1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
  • Yes
  • No
  1. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).

Tool(s) and model(s) used: Cursor Grok 4.5

@lcawl
lcawl requested review from a team as code owners August 6, 2026 17:31
@lcawl
lcawl requested a review from cotti August 6, 2026 17:31
@lcawl
lcawl enabled auto-merge (squash) August 7, 2026 12:57
@lcawl
lcawl merged commit 4008738 into main Aug 7, 2026
25 checks passed
@lcawl
lcawl deleted the highlights branch August 7, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants