Skip to content

Adopt chloggen for changelog management to eliminate CHANGELOG.md merge conflicts - #3927

Draft
ps48 wants to merge 1 commit into
open-telemetry:mainfrom
ps48:chore/adopt-chloggen
Draft

Adopt chloggen for changelog management to eliminate CHANGELOG.md merge conflicts#3927
ps48 wants to merge 1 commit into
open-telemetry:mainfrom
ps48:chore/adopt-chloggen

Conversation

@ps48

@ps48 ps48 commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Fixes #3926. Today every PR edits the shared ## Unreleased section of CHANGELOG.md, so PRs that stay open collide on the same lines and constantly need changelog rebases.

This adopts chloggen, the same tooling used by opentelemetry-collector and opentelemetry-collector-contrib, so each PR adds its own fragment file under .chloggen/ that is folded into CHANGELOG.md at release time. Because every PR creates a new file, changelog merge conflicts are eliminated by construction.

What's included:

  • .chloggen/TEMPLATE.yaml plus make chlog-new/chlog-validate/chlog-preview/chlog-update (chloggen pinned to v0.30.0, matching the Collector).
  • A changelog CI job running make chlog-validate, wired into the build gate.
  • CONTRIBUTING and release-process docs updated to describe the fragment workflow.
  • The 11 existing ## Unreleased entries migrated into fragments (validated with make chlog-validate and previewed with make chlog-preview; yamllint and markdownlint also pass locally).

Enforcement: CI validates fragment syntax only and does not require a fragment per PR. The Skip Changelog label is documented as the convention for when/if the SIG decides to enforce fragment presence.

Opening as draft to get SIG feedback on the approach before finalizing.

@ps48
ps48 force-pushed the chore/adopt-chloggen branch 2 times, most recently from 43c8b06 to 52d3ff9 Compare September 2, 2026 04:38
…ge conflicts

Fixes open-telemetry#3926.

Assisted-by: Claude (Anthropic AI)
Signed-off-by: Shenoy Pratik Gurudatt <4348487+ps48@users.noreply.github.com>
@ps48
ps48 force-pushed the chore/adopt-chloggen branch from 52d3ff9 to 9cfac7b Compare September 2, 2026 04:44
@julianocosta89

Copy link
Copy Markdown
Member

YES!!!!
Thank you @ps48 for that!

LMK when that's good to review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Adopt chloggen (per-PR changelog fragments) to eliminate CHANGELOG.md merge conflicts

2 participants