Skip to content

Changelog Conflicts are Annoying #3683

Open
@cwfitzgerald

Description

Right now, the way we manage our changelog is that each individual PR adds its own entry to the changelog in the appropriate section. This is a good first step as it decentralizes our changelog authoring and makes publishing less annoying.

This does leave us with two problems though:

  • Conflicts on the changelog happen a lot. Both in standard PRs and backporting PRs, the changelog will almost always be in conflict.
  • The changelog format isn't terribly strict and can often get munged by conflicts. This requires a decent amount of cleanup on publish.

We should investigate possible solutions to this problem and see if they are worth the trouble. One particular solution would be for each PR to include a yaml-type changelog in a separate file, then have a tool combine all of them into a single changelog. This should get rid of most of the merge points, but would require an xtask-like tool to merge all of them into the final changelog.

Metadata

Assignees

No one assigned

    Labels

    area: infrastructureTesting, building, coordinating issueshelp requiredWe need community help to make this happen.type: enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions