<story><title>A new public beta of GitHub Releases</title><url>https://github.blog/2021-10-04-beta-github-releases-improving-release-experience/</url></story><parent_chain><item><author>Vinnl</author><text>Ugh. One of my pet peeves is the generation of release notes from commit messages. Commit messages and PR descriptions have a different audience (i.e. contributors) from release notes (i.e. users).&lt;p&gt;For example, take a look at ESLint&amp;#x27;s autogenerated changelog [1]:&lt;p&gt;&lt;pre&gt;&lt;code&gt;    67c0074 Update: Suggest missing rule in flat config (fixes #14027) (#15074) (Nicholas C. Zakas)
    cf34e5c Update: space-before-blocks ignore after switch colons (fixes #15082) (#15093) (Milos Djermanovic)
    c9efb5f Fix: preserve formatting when rules are removed from disable directives (#15081) (Milos Djermanovic)
    14a4739 Update: no-new-func rule catching eval case of MemberExpression (#14860) (Mojtaba Samimi)
    7f2346b Docs: Update release blog post template (#15094) (Nicholas C. Zakas)
    fabdf8a Chore: Remove target.all from Makefile.js (#15088) (Hirotaka Tagawa &amp;#x2F; wafuwafu13)
    e3cd141 Sponsors: Sync README with website (ESLint Jenkins)
    05d7140 Chore: document target global in Makefile.js (#15084) (Hirotaka Tagawa &amp;#x2F; wafuwafu13)
    0a1a850 Update: include ruleId in error logs (fixes #15037) (#15053) (Ari Perkkiö)
    47be800 Chore: test Property &amp;gt; .key with { a = 1 } pattern (fixes #14799) (#15072) (Milos Djermanovic)
    a744dfa Docs: Update CLA info (#15058) (Brian Warner)
    9fb0f70 Chore: fix bug report template (#15061) (Milos Djermanovic)
    f87e199 Chore: Cleanup issue templates (#15039) (Nicholas C. Zakas)
&lt;/code&gt;&lt;/pre&gt;
I&amp;#x27;m reading release notes to get a feel for how the new release might impact me. This takes so much time to scan, because there&amp;#x27;s so much useless cruft (to me, as a user) I have to ignore.&lt;p&gt;What&amp;#x27;s worked very well for me is to simply have an &amp;quot;I updated the changelog, if applicable&amp;quot; entry in my PR template checklist. Then when I cut a new release, I simply add the release date above the release notes currently listed under &amp;quot;Unreleased&amp;quot;, and they&amp;#x27;ll list all relevant changes, reviewed during the pull request to verify that it is relevant to users.&lt;p&gt;[1] &lt;a href=&quot;https:&amp;#x2F;&amp;#x2F;github.com&amp;#x2F;eslint&amp;#x2F;eslint&amp;#x2F;blob&amp;#x2F;master&amp;#x2F;CHANGELOG.md&quot; rel=&quot;nofollow&quot;&gt;https:&amp;#x2F;&amp;#x2F;github.com&amp;#x2F;eslint&amp;#x2F;eslint&amp;#x2F;blob&amp;#x2F;master&amp;#x2F;CHANGELOG.md&lt;/a&gt;</text></item></parent_chain><comment><author>mylesborins</author><text>I guess it is a good thing we made automated release notes on GitHub use PRs instead of commits then ; )</text></comment>
<story><title>A new public beta of GitHub Releases</title><url>https://github.blog/2021-10-04-beta-github-releases-improving-release-experience/</url></story><parent_chain><item><author>Vinnl</author><text>Ugh. One of my pet peeves is the generation of release notes from commit messages. Commit messages and PR descriptions have a different audience (i.e. contributors) from release notes (i.e. users).&lt;p&gt;For example, take a look at ESLint&amp;#x27;s autogenerated changelog [1]:&lt;p&gt;&lt;pre&gt;&lt;code&gt;    67c0074 Update: Suggest missing rule in flat config (fixes #14027) (#15074) (Nicholas C. Zakas)
    cf34e5c Update: space-before-blocks ignore after switch colons (fixes #15082) (#15093) (Milos Djermanovic)
    c9efb5f Fix: preserve formatting when rules are removed from disable directives (#15081) (Milos Djermanovic)
    14a4739 Update: no-new-func rule catching eval case of MemberExpression (#14860) (Mojtaba Samimi)
    7f2346b Docs: Update release blog post template (#15094) (Nicholas C. Zakas)
    fabdf8a Chore: Remove target.all from Makefile.js (#15088) (Hirotaka Tagawa &amp;#x2F; wafuwafu13)
    e3cd141 Sponsors: Sync README with website (ESLint Jenkins)
    05d7140 Chore: document target global in Makefile.js (#15084) (Hirotaka Tagawa &amp;#x2F; wafuwafu13)
    0a1a850 Update: include ruleId in error logs (fixes #15037) (#15053) (Ari Perkkiö)
    47be800 Chore: test Property &amp;gt; .key with { a = 1 } pattern (fixes #14799) (#15072) (Milos Djermanovic)
    a744dfa Docs: Update CLA info (#15058) (Brian Warner)
    9fb0f70 Chore: fix bug report template (#15061) (Milos Djermanovic)
    f87e199 Chore: Cleanup issue templates (#15039) (Nicholas C. Zakas)
&lt;/code&gt;&lt;/pre&gt;
I&amp;#x27;m reading release notes to get a feel for how the new release might impact me. This takes so much time to scan, because there&amp;#x27;s so much useless cruft (to me, as a user) I have to ignore.&lt;p&gt;What&amp;#x27;s worked very well for me is to simply have an &amp;quot;I updated the changelog, if applicable&amp;quot; entry in my PR template checklist. Then when I cut a new release, I simply add the release date above the release notes currently listed under &amp;quot;Unreleased&amp;quot;, and they&amp;#x27;ll list all relevant changes, reviewed during the pull request to verify that it is relevant to users.&lt;p&gt;[1] &lt;a href=&quot;https:&amp;#x2F;&amp;#x2F;github.com&amp;#x2F;eslint&amp;#x2F;eslint&amp;#x2F;blob&amp;#x2F;master&amp;#x2F;CHANGELOG.md&quot; rel=&quot;nofollow&quot;&gt;https:&amp;#x2F;&amp;#x2F;github.com&amp;#x2F;eslint&amp;#x2F;eslint&amp;#x2F;blob&amp;#x2F;master&amp;#x2F;CHANGELOG.md&lt;/a&gt;</text></item></parent_chain><comment><author>e3bc54b2</author><text>This is why I believe Nate Graham does a fantastic job with weekly KDE updates[0]. He actually goes through the pain to condense every bugfix&amp;#x2F;feature addition to readable and grokkable single line, and it makes for great changelog read.&lt;p&gt;Of course, not every project can manage to write such a thoughtful post for every release, but if Mr. Graham can do it for something as sprawling as KDE, then can sure at least try.&lt;p&gt;[0] &lt;a href=&quot;https:&amp;#x2F;&amp;#x2F;pointieststick.com&amp;#x2F;&quot; rel=&quot;nofollow&quot;&gt;https:&amp;#x2F;&amp;#x2F;pointieststick.com&amp;#x2F;&lt;/a&gt;</text></comment>