You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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
towncrier
to manage the changelog. This works better for projects with frequent release cycles though, which we currently aren't doing for OFRAK.CHANGELOG.md
files topath_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:
CHANGELOG.md
filesDoes the proposed maintenance include non-doc string functional changes to the Python code?
No
Are you interested in implementing it yourself?
Yes
The text was updated successfully, but these errors were encountered: