Skip to content

Stop Impact and Action extraction at any heading - #4637

Open
theletterf wants to merge 1 commit into
mainfrom
fix/impact-action-stop-at-any-heading
Open

theletterf wants to merge 1 commit into
mainfrom
fix/impact-action-stop-at-any-heading

Conversation

@theletterf

Copy link
Copy Markdown
Member

Impact and Action sections scraped from a PR body now end at the next heading of any level. The Kibana PR template's ### Checklist and ### Identify risks blocks no longer ride along inside an entry's action field.

Affects: Release notes

Prompt summary: Stop the Impact and Action extraction from swallowing the PR template that follows them. The 2026-10-29 Kibana serverless bundle published a contributor checklist and an internal risk assessment as customer guidance, and the bundler should carry only the prose the author wrote under those headings.

Why

ReleaseNotesExtractor.FindSection reads a heading section until the next heading of the same or a higher level. The Kibana PR template puts ### Checklist, ### Identify risks and a generated-by footer after the author's ## Action, so every Kibana PR with an Action section drags that template into its entry. In elastic/docs-internal-workflows#1143 the entry for elastic/kibana#299837 published about 2,800 characters of checklist, backport instructions and risk notes as its action. Libra flagged it and the field was trimmed by hand.

What

Section boundary

A heading of any level now ends an Impact or Action section. The deeper-heading exemption is gone: a ### after a ## Action is the next section, not a child of it. Fenced code blocks and the cross-stop between Impact and Action behave as before.

Reference docs

The evaluate-pr page states the new boundary: a section under a heading runs until the next heading of any level, so notes that are not part of Impact or Action belong under their own heading.

Regression test

A test rebuilds the shape of elastic/kibana#299837: ## Impact, ## Action with bullets, then the template's ### sections and footer. It asserts the action ends after the author's last bullet. It fails on the previous code.

Verify

dotnet test tests/Elastic.Changelog.Tests/
# FindAction_TemplateSectionsOneLevelDeeper_EndTheSection — the kibana#299837 body shape

Out of scope: a footer that follows an Action section with no heading between them, such as a generated-by line, still becomes part of the section.

Related to https://github.com/elastic/docs-eng-team/issues/984

🤖 Generated with Claude Code

https://claude.ai/code/session_01RyiyHmDHcUFt8rjMNR8TBm

A heading section used to run until the next heading of the same or a
higher level. The Kibana PR template puts `### Checklist` and
`### Identify risks` after the author's `## Action`, so every Kibana
entry with an Action carried the template into its `action` field.

Related to elastic/docs-eng-team#984

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01RyiyHmDHcUFt8rjMNR8TBm
@theletterf

Copy link
Copy Markdown
Member Author

@Mpdreamz This should be fixed.

@github-actions

Copy link
Copy Markdown
Contributor

Docs preview (local build)

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

Sample changed pages:

This branch was successfully deployed

2 active deployments
docs-preview — 0c307e10 Deployed Oct 29, 2026 by github-actions[bot]
assembler-preview — 0c307e10 Deployed Oct 29, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants