<div dir="ltr"><div>I don't recall this conversation, where did it take place? <br></div><div><br></div><div>In the past, we had a Changelog that everyone modified for every merge, and it was largely a duplicate of their commit messages. So, we stopped doing it. Are you proposing a return to that type of duplication?</div><div><br></div><div>allan<br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, Dec 29, 2021 at 4:57 PM Ralph Little <<a href="mailto:skelband@gmail.com">skelband@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Hi,<br>
<br>
On 2021-12-29 1:30 p.m., Povilas Kanapickas wrote:<br>
> Hello,<br>
><br>
> There were some discussions on how to make handling release notes easier<br>
> in the past so that releases are not as difficult. Time has come to<br>
> actually implement them.<br>
><br>
> What changes?<br>
><br>
> Developers will need to write a short one or two sentence description to<br>
> a new file in newsfragments directory when submitting the feature for<br>
> review. That's it.<br>
><br>
> Longer version:<br>
><br>
> We'll write release notes as part of merge requests that introduce the<br>
> features or bug fixes instead of deferring everything until the release<br>
> time comes.<br>
><br>
> This has the benefit that the release notes will be written by a more<br>
> knowledgeable person than the release manager and we will not wait<br>
> months only to forget what merge request was actually about. The side<br>
> benefit of this will be that creating releases will become easier as no<br>
> one will need to hunt all merge requests that comprise the release.<br>
><br>
> The release notes for unreleased features will be stored in<br>
> "newsfragments" directory in the repository. At the time of the release,<br>
> the files will be combined into a single text block, edited by the<br>
> release manager and added to the NEWS file. Storing release notes in<br>
> separate files before the release makes it easy to avoid merge conflicts.<br>
><br>
> Like I said above, for the developers almost nothing changes: just add a<br>
> new file to the newsfragments directory with a one sentence description<br>
> before creating a merge request.<br>
><br>
> I've created a merge request with all unreleased changes since 1.0.32,<br>
> you can see how the new process looks like in practice:<br>
> <a href="https://gitlab.com/sane-project/backends/-/merge_requests/676" rel="noreferrer" target="_blank">https://gitlab.com/sane-project/backends/-/merge_requests/676</a><br>
><br>
> Regards,<br>
> Povilas<br>
><br>
Sounds great!<br>
Will we clean this directory out on every release?<br>
<br>
Cheers,<br>
Ralph<br>
<br>
<br>
<br>
</blockquote></div><br clear="all"><br>-- <br><div dir="ltr" class="gmail_signature">"well, I stand up next to a mountain- and I chop it down with the edge of my hand"</div>