ReleaseNotes.txt and merge conflicts

[Lubomir I. Ivanov]

On 28 November 2017 at 22:45, Dirk Hohndel <dirk at hohndel.org> wrote:
> On Tue, Nov 28, 2017 at 10:32:24PM +0200, Lubomir I. Ivanov wrote:
>> >
>> > Thanks for figuring this out, Lubomir!
>> >
>> > so, how are we supposed to write those now? A simple hack would of course be
>> > to actually have a folder release_notes where everybody add _files_ for
>> > things to report and then for a release we cat all those files…
>>
>> yesterday, we figured out that if we have a "release notes" file where
>> multiple branches / commits add notes on top of it (i.e. line 1) there
>> won't be any conflicts between the branches if we add this:
>>
>> <path>/ReleaseNotes.txt -text merge=union
>> in a file /.gitattributes
>>
>> until we restructure our ReleaseNotes, we have to resolve conflicts
>> locally and force push to the remote branch from which the PR is
>> happening.
>> the github "resolve conflicts" feature with the online editor merges
>> master into the user branch without fast-forward (--no-ff) and i don't
>> think we want that.
>
> Lubomir, can you create a pull request that adds the .gitattributes file
> as well as a Changelog file in the correct format plus a note at the top
> of ReleaseNotes.txt that points to that (and of course we need to adjust
> the PR instructions as well).
>
> I can do that this evening if it's not clear what I'm looking for :-/
>

should the Changelog file be in the root folder?

i'm not sure about the format
should it be something like:

---------------------------------------------------------------------------------
<---  new entries are added here on top and once we are
done we place a version XXXXX on top

- entry 1
- entry 2
- entry 3
- entry 4

some version YYYY

- entry 1
- entry 2
- entry 3
- entry 4
----------------------------------------------------------------------------------

lubomir
--