Skip to content

Tooling: Can we come up with another way to edit CHANGELOG and schema-next.yaml? #617

@braydonk

Description

@braydonk

I apologize if this is already tracked somewhere.

If we have a long running PR in this repo and we add the changelog and schema changes early, we have to painstakingly resolve merge conflicts on those over time because we're all editing the same file. Is there any way we could find a pattern that didn't require editing a monolithic file together?

I think the best way would be to have a folder for future changelog and schema changes respectively, which each have a collection of individual files for the changelog and schema changes for the next release. Then the release process would take care of squashing together all the files we have in those folders each release. This would have two benefits:

  • No more merge conflicts by all editing the same files; each change would have its own file
  • If things change while you're working on your PR, it is very easy to edit your expected schema and changelog changes
  • The file will only exist in the folder on main once the PR is merged, meaning if a PR lasts beyond the release it was created for, we don't have to worry about continuously moving the change back up to next when we resolve merge conflicts

However I am open to any other suggestions that would help resolve the toil of resolving merge conflicts in these files.

Metadata

Metadata

Assignees

Labels

toolingRegarding build, workflows, build-tools, ...

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions