Changelog policy again
Posted: 23 Feb 2019, 21:40
Ok, so bzzt is complaining that changelog entries getting added in commits causes conflicts upon an attempt of revert which have to be solved (and he hates these with burning passion). So there's some motive to discuss the policy more. There are two solutions to this issue:
1. Either *every* single contributor needs to modify the changelog in a separate commit. This causes "commit bloat" as every PR that resolves a tracker issue now has a minimum of two commits, which isn't very nice - changelog modifying is not very meaningful in terms of git history and if for example the contributor pushes the commit that changes the changelog only after the first commit is pushed to git CIs will have to build the PR again. OCD triggered.
2. Or pre-0.45.0 policy is restored, where contributors keep their hands of the changelog file and only a maintainer/project leader updates the changelog manually upon the beginning of RC phase. The complaint is that this is more error-prone and makes recordkeeping more difficult (though it's proven the current approach isn't ideal in this area either). The benefit is that contributors or maintainers most likely don't need to solve merge conflicts at all due to changelog changes over time since the changelog doesn't change. Other thing is that the current GitLab tracker is somewhat less convenient than redmine for this because the roadmap table is no longer present and it's more difficult for the changelog updater to review the list of issues on the milestone.
Or of course everything can be left as is and bzzt and others with the same problem are kindly asked to resolve conflicts manually.
What do you think?
1. Either *every* single contributor needs to modify the changelog in a separate commit. This causes "commit bloat" as every PR that resolves a tracker issue now has a minimum of two commits, which isn't very nice - changelog modifying is not very meaningful in terms of git history and if for example the contributor pushes the commit that changes the changelog only after the first commit is pushed to git CIs will have to build the PR again. OCD triggered.
2. Or pre-0.45.0 policy is restored, where contributors keep their hands of the changelog file and only a maintainer/project leader updates the changelog manually upon the beginning of RC phase. The complaint is that this is more error-prone and makes recordkeeping more difficult (though it's proven the current approach isn't ideal in this area either). The benefit is that contributors or maintainers most likely don't need to solve merge conflicts at all due to changelog changes over time since the changelog doesn't change. Other thing is that the current GitLab tracker is somewhat less convenient than redmine for this because the roadmap table is no longer present and it's more difficult for the changelog updater to review the list of issues on the milestone.
Or of course everything can be left as is and bzzt and others with the same problem are kindly asked to resolve conflicts manually.
What do you think?