<div dir="ltr"><div>My initial thought is this looks useful to the user and very clean. I've also found it to be a burden trying to write good release notes, having to dig through commits and try to decide what's important enough and what's not, so +1 to trying to improve this process for both the releaser and user.<br></div><div><br></div><div>However:</div><div>"<code>towncrier</code> works best in a development system where all merges involve closing a ticket."</div><div>We frequently make use of "[noissue]" in our PRs, in part to lower the burden on contributors making small fixes. Would we want to move to a model where we *must* have an issue? Are we instead assuming those items are small enough that the user doesn't need to see it in the release notes?</div><div><br></div><div>Thoughts?</div><div><br></div><div>--Dana</div><div><br></div><div><div><div dir="ltr" class="gmail_signature" data-smartmail="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><div>
<p style="font-weight:bold;margin:0px;padding:0px;font-size:14px;text-transform:capitalize;font-family:"RedHatText",sans-serif">
<span>Dana</span> <span>Walker</span><span style="color:rgb(170,170,170);margin:0px"></span>
</p>
<p style="font-weight:normal;font-size:12px;margin:0px 0px 4px;text-transform:capitalize;font-family:"RedHatText",sans-serif">She / Her / Hers</p>
<p style="font-weight:normal;font-size:12px;margin:0px;text-transform:capitalize;font-family:"RedHatText",sans-serif">
<span>Software Engineer, Pulp Project</span>
</p>
<p style="font-weight:normal;margin:0px 0px 4px;font-size:12px;font-family:"RedHatText",sans-serif">
<a style="color:rgb(0,136,206);font-size:12px;margin:0px;text-decoration:none;font-family:"RedHatText",sans-serif" href="https://www.redhat.com" target="_blank">Red Hat <span></span></a>
</p>
<div style="margin-bottom:4px">
</div>
<p style="font-weight:normal;margin:0px;font-size:12px;font-family:"RedHatText",sans-serif">
<span style="margin:0px;padding:0px"><a style="color:rgb(0,0,0);font-size:12px;margin:0px;text-decoration:none;font-family:"RedHatText",sans-serif" href="mailto:dawalker@redhat.com" target="_blank">dawalker@redhat.com</a> </span>
</p>
<div style="margin-top:12px">
<table border="0">
<tbody><tr>
<td width="100px"><a href="https://www.redhat.com" target="_blank"> <img src="https://marketing-outfit-prod-images.s3-us-west-2.amazonaws.com/f5445ae0c9ddafd5b2f1836854d7416a/Logo-RedHat-Email.png" width="90" height="auto"></a> </td>
</tr>
</tbody></table>
</div>
</div><table border="0"><tbody><tr><td width="100px"><br></td>
</tr></tbody></table>
</div></div></div></div></div></div></div></div></div></div></div></div></div></div><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Thu, May 23, 2019 at 3:49 PM Brian Bouterse <<a href="mailto:bbouters@redhat.com">bbouters@redhat.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"><div dir="ltr"><div>In discussion with some other devs, I've realized that pulpcore and pulpcore-plugin would benefit from better release notes. Here are some of the reasons that have come up:</div><div><br></div><div>* The release notes are incomplete. One person tries to go through and write release notes just before the release happens, and by that point, the number of changes are too many for this approach to produce complete and robust notes.<br></div><div>* They are hard to produce. Producing "all the release notes" is a mentally difficult task. <br></div><div>* We try to substitute with Redmine, but this approach limits us (a) it's now difficult and time consuming to see what changed, (b) there is way more detail than you actually want, and they aren't self-contained (can't be browsed off-line).<br></div><div>* overall all ^ leads to both users and plugin writers feeling uncertain about what has changed in the last release, week, or even day.</div><div><br></div><div>So what can we do? Recently I contributed to aiohttp and I found their release note process light and easy. It produces high-quality release notes like these: <a href="https://aiohttp.readthedocs.io/en/stable/changes.html" target="_blank">https://aiohttp.readthedocs.io/en/stable/changes.html</a></div><div><br></div><div>You can read about their process here: <a href="https://aiohttp.readthedocs.io/en/stable/contributing.html#changelog-update" target="_blank">https://aiohttp.readthedocs.io/en/stable/contributing.html#changelog-update</a> You can see some examples of these release note files in their repo here: <a href="https://github.com/aio-libs/aiohttp/tree/master/CHANGES" target="_blank">https://github.com/aio-libs/aiohttp/tree/master/CHANGES</a> Overall it makes use of the towncrier project <a href="https://github.com/hawkowl/towncrier" target="_blank">https://github.com/hawkowl/towncrier</a><br></div><div><br></div><div></div><div>What do you all think about trying something like this for pulpcore and pulpcore-plugin? Please write back on-list with thoughts, ideas, concerns, alternatives, etc.<br></div><div><br></div><div>Also, I made us a starter issue to coalesce some more of the practical aspect of adopting a change like this: <a href="https://pulp.plan.io/issues/4875" target="_blank">https://pulp.plan.io/issues/4875</a></div><div><br></div><div>All the best,</div><div>Brian</div><div><br></div><div><br></div><div><br></div></div>
_______________________________________________<br>
Pulp-dev mailing list<br>
<a href="mailto:Pulp-dev@redhat.com" target="_blank">Pulp-dev@redhat.com</a><br>
<a href="https://www.redhat.com/mailman/listinfo/pulp-dev" rel="noreferrer" target="_blank">https://www.redhat.com/mailman/listinfo/pulp-dev</a><br>
</blockquote></div>