Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider a different way to manage the CHANGELOG #1617

Open
asomers opened this issue Dec 24, 2021 · 2 comments
Open

Consider a different way to manage the CHANGELOG #1617

asomers opened this issue Dec 24, 2021 · 2 comments

Comments

@asomers
Copy link
Member

asomers commented Dec 24, 2021

The CHANGELOG file is by far our biggest source of merge conflicts. It would be great if we could fix that. One approach would be that taken by https://github.com/saltstack/salt . They use a changelog directory, and each PR adds a file to that directory whose name indicates whether it is a change, addition, removal, or fix. Then when preparing a release, all the files get combined into the CHANGELOG. That eliminates merge conflicts.

@rtzoeller
Copy link
Collaborator

rtzoeller commented Dec 24, 2021

merge=union ought to solve this (it's why a local rebase resolves the issue automatically), but GitHub doesn't seem to support it.

I found isaacs/github#487 on this topic, but it appears there is a better way to submit feedback requests now. I've created community/community#9288 as an official request to support merge=union in .gitattributes files when conflicts arise in PRs.

@asomers
Copy link
Member Author

asomers commented Dec 24, 2021

Using merge=union solves the problem whenever git would complain about a merge conflict. But there's another problem too, when git doesn't complain about a merge conflict. That happens when somebody opens a PR against one release of Nix, then we publish a new release, and they rebase their PR putting the CHANGELOG entry into the section for the just-published release. merge=union doesn't help with that.

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

No branches or pull requests

2 participants