<div dir="ltr"><div></div><div></div><div>+1 to improve release notes process</div><div><br></div><div>If we decide to use PR numbers and not redmine issues in the release notes, then there will be no limitation/requirement to have a redmine issue to add something to the release notes.</div><div><br></div><div>Tanya<br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, May 24, 2019 at 3:46 PM David Davis <<a href="mailto:daviddavis@redhat.com">daviddavis@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">+1 to bmbouter's proposal and not including '[noissue]' items in release notes.<br clear="all"><div><div dir="ltr" class="gmail-m_635808358011705696gmail_signature"><div dir="ltr"><div><div dir="ltr"><div><div dir="ltr"><div><br></div><div>David<br></div></div></div></div></div></div></div></div><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, May 24, 2019 at 3:52 AM Matthias Dellweg <<a href="mailto:dellweg@atix.de" target="_blank">dellweg@atix.de</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">I am fine with stating "[noissue] means 'not worth mentioning in<br>
release notes'".<br>
This would require the reviewer to decide to tell the contributor: "We<br>
want that to be part of the release notes. Please open up a ticket."<br>
And that process scales better than handpicking the notes in the end.<br>
<br>
On Thu, 23 May 2019 16:22:36 -0400<br>
Dana Walker <<a href="mailto:dawalker@redhat.com" target="_blank">dawalker@redhat.com</a>> wrote:<br>
<br>
> My initial thought is this looks useful to the user and very clean.<br>
> I've also found it to be a burden trying to write good release notes,<br>
> having to dig through commits and try to decide what's important<br>
> enough and what's not, so +1 to trying to improve this process for<br>
> both the releaser and user.<br>
> <br>
> However:<br>
> "towncrier works best in a development system where all merges involve<br>
> closing a ticket."<br>
> We frequently make use of "[noissue]" in our PRs, in part to lower the<br>
> burden on contributors making small fixes.  Would we want to move to a<br>
> model where we *must* have an issue?  Are we instead assuming those<br>
> items are small enough that the user doesn't need to see it in the<br>
> release notes?<br>
> <br>
> Thoughts?<br>
> <br>
> --Dana<br>
> <br>
> Dana Walker<br>
> <br>
> She / Her / Hers<br>
> <br>
> Software Engineer, Pulp Project<br>
> <br>
> Red Hat <<a href="https://www.redhat.com" rel="noreferrer" target="_blank">https://www.redhat.com</a>><br>
> <br>
> <a href="mailto:dawalker@redhat.com" target="_blank">dawalker@redhat.com</a><br>
> <<a href="https://www.redhat.com" rel="noreferrer" target="_blank">https://www.redhat.com</a>><br>
> <br>
> <br>
> <br>
> On Thu, May 23, 2019 at 3:49 PM Brian Bouterse <<a href="mailto:bbouters@redhat.com" target="_blank">bbouters@redhat.com</a>><br>
> wrote:<br>
> <br>
> > In discussion with some other devs, I've realized that pulpcore and<br>
> > pulpcore-plugin would benefit from better release notes. Here are<br>
> > some of the reasons that have come up:<br>
> ><br>
> > * The release notes are incomplete. One person tries to go through<br>
> > and write release notes just before the release happens, and by<br>
> > that point, the number of changes are too many for this approach to<br>
> > produce complete and robust notes.<br>
> > * They are hard to produce. Producing "all the release notes" is a<br>
> > mentally difficult task.<br>
> > * We try to substitute with Redmine, but this approach limits us<br>
> > (a) it's now difficult and time consuming to see what changed, (b)<br>
> > there is way more detail than you actually want, and they aren't<br>
> > self-contained (can't be browsed off-line).<br>
> > * overall all ^ leads to both users and plugin writers feeling<br>
> > uncertain about what has changed in the last release, week, or even<br>
> > day.<br>
> ><br>
> > So what can we do? Recently I contributed to aiohttp and I found<br>
> > their release note process light and easy. It produces high-quality<br>
> > release notes like these:<br>
> > <a href="https://aiohttp.readthedocs.io/en/stable/changes.html" rel="noreferrer" target="_blank">https://aiohttp.readthedocs.io/en/stable/changes.html</a><br>
> ><br>
> > You can read about their process here:<br>
> > <a href="https://aiohttp.readthedocs.io/en/stable/contributing.html#changelog-update" rel="noreferrer" target="_blank">https://aiohttp.readthedocs.io/en/stable/contributing.html#changelog-update</a><br>
> > You can see some examples of these release note files in their repo<br>
> > here: <a href="https://github.com/aio-libs/aiohttp/tree/master/CHANGES" rel="noreferrer" target="_blank">https://github.com/aio-libs/aiohttp/tree/master/CHANGES</a><br>
> > Overall it makes use of the towncrier project<br>
> > <a href="https://github.com/hawkowl/towncrier" rel="noreferrer" target="_blank">https://github.com/hawkowl/towncrier</a><br>
> ><br>
> > What do you all think about trying something like this for pulpcore<br>
> > and pulpcore-plugin? Please write back on-list with thoughts,<br>
> > ideas, concerns, alternatives, etc.<br>
> ><br>
> > Also, I made us a starter issue to coalesce some more of the<br>
> > practical aspect of adopting a change like this:<br>
> > <a href="https://pulp.plan.io/issues/4875" rel="noreferrer" target="_blank">https://pulp.plan.io/issues/4875</a><br>
> ><br>
> > All the best,<br>
> > Brian<br>
> ><br>
> ><br>
> ><br>
> > _______________________________________________<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>
> >  <br>
_______________________________________________<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>
_______________________________________________<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>