Skip to content

Collapse the label tables in the changelog labels comment - #4610

Merged
theletterf merged 2 commits into
mainfrom
ccr-8311a0e2-qmcqgm
Oct 27, 2026
Merged

theletterf merged 2 commits into
mainfrom
ccr-8311a0e2-qmcqgm

Conversation

@theletterf

Copy link
Copy Markdown
Member

The "labels needed" changelog comment now collapses the product and area label tables. Authors see the instruction and open a table only when they need it.

Affects: Release notes

Prompt summary: A Kibana engineer found the changelog comment on their pull requests noisy. The ask is to keep the comment short by putting the tables of available labels in an expandable section.

Why

The comment lists every product and area label that changelog.yml maps. Repositories such as Kibana map dozens of these labels, so the tables make the comment long and hard to scan. The author usually needs only the headline and one label.

What

Collapsed label tables

Each product and area table is in a <details> block, with a "Show the product labels" or "Show the area labels" summary. The instruction above each table stays visible. A blank line surrounds the table, because GitHub renders a table inside <details> only with those blank lines.

Type labels stay visible

The type labels are a short inline list, not a table, so they are not collapsed.

Verify

dotnet test tests/Elastic.Changelog.Tests/
# RenderLabelsNeeded_ProductAndAreaMissing_CollapsesEachTable
# RenderLabelsNeeded_TypeMissing_KeepsTypeLabelsVisible

Out of scope: elastic/docs-actions#442 stops the same comment on draft pull requests. The two changes are independent.


Generated by Claude Code

@theletterf
theletterf requested a review from a team as a code owner October 27, 2026 17:04
@theletterf
theletterf requested a review from technige October 27, 2026 17:04
@theletterf theletterf added the enhancement label Oct 27, 2026 — with Claude
@cla-checker-service

cla-checker-service Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

💚 CLA has been signed

Copy link
Copy Markdown
Member Author

@Mpdreamz, here is some context for this PR.

It comes from the same Kibana request as elastic/docs-actions#442. That PR stops the release notes checks and the comment on draft PRs. While we looked at that request, the "labels needed" comment also seemed long for repositories that map many product and area labels, such as Kibana. An example is elastic/kibana#300907.

This PR collapses only the product and area tables, and the instruction above each table stays visible. The type labels are a short inline list, so they stay as they are. The two PRs are independent and can merge in any order.

We could not build or run the tests in the session that made this change, because its network policy blocked the .NET SDK download. CI is the first full check of this change.


Generated by Claude Code

Repositories such as Kibana map dozens of product and area labels, so the
tables made the "labels needed" comment long. Each table now sits in a
collapsed block under a visible instruction. The type labels stay inline.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0198Z15QXfthJ2QgGztrDHtu
@github-actions

Copy link
Copy Markdown
Contributor

Docs preview (local build)

Handbook preview: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/4610/

The `lint` check failed because curb splits a fluent assertion chain over
several lines. This commit applies that format to the new test.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@theletterf
theletterf merged commit fb4e5bc into main Oct 27, 2026
34 checks passed
@theletterf
theletterf deleted the ccr-8311a0e2-qmcqgm branch October 27, 2026 18:23
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