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

Adding CHANGELOG.md entries in pull requests is not fun #534

Open
alchzh opened this issue Dec 13, 2024 · 0 comments
Open

Adding CHANGELOG.md entries in pull requests is not fun #534

alchzh opened this issue Dec 13, 2024 · 0 comments

Comments

@alchzh
Copy link
Collaborator

alchzh commented Dec 13, 2024

Currently, every pull request causes a merge conflict on CHANGELOG.md files if a changelog entry was added to the same section since the pull request branch was forked off. This is a well known annoyance with git and requires a manual merge conflict resolution right before a pull request is merged. Coordination is required here since no other pull request can be merged in the meantime without causing another conflict, and the whole test suite is triggered just from the one line addition so you have to wait a while after the push to merge it.

There are a few steps we can consider to smooth this whole

  • Adopting a tool like towncrier to manage the changelog. This works better for projects with frequent release cycles though, which we currently aren't doing for OFRAK.
  • Adding a git custom merge strategy. This wouldn't work with the github UI but would make the merge automatic instead of a conflict resolution
  • Adding CHANGELOG.md files to path_ignore in Github actions. This should at least prevent us from having to wait for the whole test suite to run after a changelog update before merging in a branch.

Which files would be affected?
Possible files affected:

  • git configuration files
  • CHANGELOG.md files
  • github workflow config

Does the proposed maintenance include non-doc string functional changes to the Python code?
No

Are you interested in implementing it yourself?
Yes

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

1 participant