Context
The Release Notes Onboarding RFC (docs-eng-team#698) specifies that the git-ref bundling mode (--start-git-ref/--end-git-ref) should prefer a checked-in S3 changelog entry and fall back to changelog add-style PR-body extraction (reading the release_notes: block from the PR description).
The existing gh-release mode (changelog gh-release) currently produces entries with only title + PR link — it does not extract the release_notes: block from PR bodies. This creates a content fidelity gap: products using the On-release GitHub Release path (APM agents, Beats agents, etc.) get lower-quality release notes than serverless products using the git-ref path.
Required change
Update GitHubReleaseChangelogService to apply the same extraction precedence as the git-ref mode:
- If a checked-in S3 changelog entry exists for the PR (already synced via
changelog-upload), use it.
- Otherwise, attempt PR-body extraction (
Extract.ReleaseNotes / the same path used by changelog add).
- Fall back to title/link-only only if neither source is available.
This normalises release-note quality across all On-release trigger shapes.
Related
Context
The Release Notes Onboarding RFC (docs-eng-team#698) specifies that the git-ref bundling mode (
--start-git-ref/--end-git-ref) should prefer a checked-in S3 changelog entry and fall back tochangelog add-style PR-body extraction (reading therelease_notes:block from the PR description).The existing
gh-releasemode (changelog gh-release) currently produces entries with only title + PR link — it does not extract therelease_notes:block from PR bodies. This creates a content fidelity gap: products using the On-release GitHub Release path (APM agents, Beats agents, etc.) get lower-quality release notes than serverless products using the git-ref path.Required change
Update
GitHubReleaseChangelogServiceto apply the same extraction precedence as the git-ref mode:changelog-upload), use it.Extract.ReleaseNotes/ the same path used bychangelog add).This normalises release-note quality across all On-release trigger shapes.
Related
GitHubReleaseChangelogService.csdocs/rfcs/release-notes-serverless-deployment.md(docs-eng-team)