How we solved GitLab's changelog conflict crisis

#1

Post by mikece » Tue, Jul 03, 2018, 7:28 PM UTC

How we solved GitLab's changelog conflict crisis
about.gitlab.com

Re: How we solved GitLab's changelog conflict crisis

#2

Post by lozenge » Tue, Jul 03, 2018, 10:59 PM UTC

This solution is neat, but Git also has a very simple built in solution: https://git-scm.com/docs/gitattributes#gitattributes-union

Re: How we solved GitLab's changelog conflict crisis

#3

Post by nettsundere » Tue, Jul 03, 2018, 11:30 PM UTC

lozenge wrote: post #2

This solution is neat, but Git also has a very simple built in solution: https://git-scm.com/docs/gitattributes#gitattributes-union

union is bad in general, there is a risk of bad merge

Re: How we solved GitLab's changelog conflict crisis

#4

Post by nettsundere » Tue, Jul 03, 2018, 11:31 PM UTC

Funny thing, i had this idea back in 2015, i even implemented a tool for that,

old blog post: https://medium.com/@nettsundere/on-reducing-changelog-merge-...

Re: How we solved GitLab's changelog conflict crisis

#5

Post by nettsundere » Tue, Jul 03, 2018, 11:33 PM UTC

nettsundere wrote: post #4

Funny thing, i had this idea back in 2015, i even implemented a tool for that, old blog post: https://medium.com/@nettsundere/on-reducing-changelog-merge-...

that was the tool https://github.com/nettsundere/cyberlog

Re: How we solved GitLab's changelog conflict crisis

#6

Post by nettsundere » Tue, Jul 03, 2018, 11:35 PM UTC

nettsundere wrote: post #3

lozenge wrote: post #2

This solution is neat, but Git also has a very simple built in solution: https://git-scm.com/docs/gitattributes#gitattributes-union

union is bad in general, there is a risk of bad merge

works pretty well until you really need to have similar lines from each branch

Re: How we solved GitLab's changelog conflict crisis

#7

Post by glandium » Wed, Jul 04, 2018, 1:34 AM UTC

Git supports merge drivers to do things like this: https://git-scm.com/docs/gitattributes#_defining_a_custom_me...

Debian has had a merge driver for its changelogs for a while: https://salsa.debian.org/dpkg-team/dpkg/commit/9b98847665d8b...

Re: How we solved GitLab's changelog conflict crisis

#8

Post by auscompgeek » Wed, Jul 04, 2018, 1:35 AM UTC

A number of Python projects use a fairly similar way of managing changelogs: https://github.com/hawkowl/towncrier

Re: How we solved GitLab's changelog conflict crisis

#9

Post by ocharles » Wed, Jul 04, 2018, 8:21 AM UTC

I imagine just sorting the changelog entries per release (maybe split into sections) would get you quite far, too.

Re: How we solved GitLab's changelog conflict crisis

#10

Post by joshka » Wed, Jul 04, 2018, 9:22 AM UTC

TL;DR - ChangeBlog -> MD ;)