https://www.redmine.org/https://www.redmine.org/favicon.ico?16793021292017-04-16T07:53:28ZRedmineRedmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=780382017-04-16T07:53:28ZMischa The Evil
<ul><li><strong>Description</strong> updated (<a title="View differences" href="/journals/78038/diff?detail_id=61227">diff</a>)</li></ul><p>Updated until 16-04-2017 09:50.</p> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=780392017-04-16T07:55:33ZGo MAEDA
<ul></ul><p>+1<br />I always use the proposed structure when I publish Japanese translation of Changelog.<br /><a class="external" href="http://blog.redmine.jp/articles/3_3/changelog/">http://blog.redmine.jp/articles/3_3/changelog/</a></p> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=792922017-06-18T13:40:43ZMischa The Evil
<ul><li><strong>Target version</strong> set to <i>3.4.0</i></li></ul><p>Let's see if we can make this change happen starting from <a class="version" href="https://www.redmine.org/versions/119">3.4.0</a> indeed; setting proposed target.</p>
Please ping me when 3.4.0 is (planned to) being "freezed/freeze'ed/frozen" (:S), so I:
<ol>
<li>can update the proposals to the final release contents and,</li>
<li>might have at least a short amount of time to make minor, last minute subject/category (readability) changes when needed.</li>
</ol> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=794422017-06-25T08:58:10ZJean-Philippe Langjp_lang@yahoo.fr
<ul><li><strong>Assignee</strong> set to <i>Mischa The Evil</i></li></ul><p>ping</p> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=794472017-06-25T11:19:10ZJean-Philippe Langjp_lang@yahoo.fr
<ul></ul><blockquote>
<p>lists quickly get longer due to the many newlines between categories and issues</p>
</blockquote>
<p>Yes, for patch release, we may have very small numbers of tickets for each category.</p>
<blockquote>
<p>it takes some more time to prepare instead of just copy-pasting the roadmap view</p>
</blockquote>
<p>This is a real issue. Maybe we could just add a link on the <a class="wiki-page" href="https://www.redmine.org/projects/redmine/wiki/Changelog">Changelog</a> to the issue list grouped by categories?</p> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=796162017-07-02T04:06:24ZGo MAEDA
<ul><li><strong>File</strong> <i>changelog-3_4.txt</i> added</li><li><strong>File</strong> <i>make-changelog.rb</i> added</li></ul><p>I made <a class="attachment" href="https://www.redmine.org/attachments/18646">changelog-3_4.txt</a> by using <a class="attachment" href="https://www.redmine.org/attachments/18647">make-changelog.rb</a> .<br />Note that make-changelog.rb cannot retrieve issues which are invisible to anonymous users.</p> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=796172017-07-02T04:23:24ZGo MAEDA
<ul><li><strong>File</strong> <a href="/attachments/18646">changelog-3_4.txt</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/18646/changelog-3_4.txt">changelog-3_4.txt</a> added</li><li><strong>File</strong> <a href="/attachments/18647">make-changelog.rb</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/18647/make-changelog.rb">make-changelog.rb</a> added</li></ul><p>Slightly updated the script. Reuploading the files.</p>
<pre><code class="diff syntaxhl"><span class="gd">--- make-changelog.rb.orig 2017-07-02 13:18:19.000000000 +0900
</span><span class="gi">+++ make-changelog.rb 2017-07-02 13:18:57.000000000 +0900
</span><span class="p">@@ -25,7 +25,7 @@</span>
issue = Issue.new
issue.tracker = tr.css('td.tracker').first.text
issue.id = tr.css('td.id').first.text
<span class="gd">- issue.subject = tr.css('td.subject').first.text
</span><span class="gi">+ issue.subject = tr.css('td.subject').first.text.strip
</span> issue.category = tr.css('td.category').first.text
issues << issue
end
<span class="p">@@ -36,6 +36,6 @@</span>
issues_by_category.keys.sort.each do |category|
print "\n=== #{category}\n\n"
issues_by_category[category].sort_by {|v| [v.tracker, v.id.to_i]}.each do |issue|
<span class="gd">- puts "* #{issue.tracker} #{issue.id}: #{issue.subject}"
</span><span class="gi">+ puts "* #{issue.tracker} ##{issue.id}: #{issue.subject}"
</span> end
end
</code></pre> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=796182017-07-02T04:23:51ZGo MAEDA
<ul><li><strong>File</strong> deleted (<del><i>changelog-3_4.txt</i></del>)</li></ul> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=796192017-07-02T04:23:57ZGo MAEDA
<ul><li><strong>File</strong> deleted (<del><i>make-changelog.rb</i></del>)</li></ul> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=796272017-07-02T06:36:49ZMischa The Evil
<ul><li><strong>File</strong> <a href="/attachments/18650">changelog_generator.rb</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/18650/changelog_generator.rb">changelog_generator.rb</a> added</li><li><strong>File</strong> <a href="/attachments/18651">0001-Add-changelog-generator-script.patch</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/18651/0001-Add-changelog-generator-script.patch">0001-Add-changelog-generator-script.patch</a> added</li><li><strong>File</strong> <a href="/attachments/18652">0001-Fix-changelog-markup.patch</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/18652/0001-Fix-changelog-markup.patch">0001-Fix-changelog-markup.patch</a> added</li><li><strong>File</strong> <a href="/attachments/18653">0001-Fix-changelog-markup.-3.2-stable-backport-of-rX.patch</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/18653/0001-Fix-changelog-markup.-3.2-stable-backport-of-rX.patch">0001-Fix-changelog-markup.-3.2-stable-backport-of-rX.patch</a> added</li><li><strong>File</strong> <a href="/attachments/18654">0001-Fix-changelog-markup.-3.3-stable-backport-of-rX.patch</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/18654/0001-Fix-changelog-markup.-3.3-stable-backport-of-rX.patch">0001-Fix-changelog-markup.-3.3-stable-backport-of-rX.patch</a> added</li><li><strong>File</strong> <a href="/attachments/18655">0002-Add-3.4.0-changelog.patch</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/18655/0002-Add-3.4.0-changelog.patch">0002-Add-3.4.0-changelog.patch</a> added</li></ul><p>Jean-Philippe Lang wrote:</p>
<blockquote><blockquote>
<p>it takes some more time to prepare instead of just copy-pasting the roadmap view</p>
</blockquote>
<p>This is a real issue. Maybe we could just add a link on the <a class="wiki-page" href="https://www.redmine.org/projects/redmine/wiki/Changelog">Changelog</a> to the issue list grouped by categories?</p>
</blockquote>
<p>I agree this is a valid issue. I'd prefer though not to use issue queries for the changelog.</p>
<p>I came to the same conclusion as Go did: we need a script to generate a changelog. I'll attach my resulting script (which looks to me a bit more sophisticated than the script written by Go), and a patch which adds it to <a class="source" href="https://www.redmine.org/projects/redmine/repository/svn/entry/trunk/script">source:/trunk/script</a>, to this issue.
<a href="#" onclick="$('#collapse-294b2b29-show, #collapse-294b2b29-hide').toggle(); $('#collapse-294b2b29').fadeToggle(150);; return false;" id="collapse-294b2b29-show" class="icon icon-collapsed collapsible">Impression of the usage page of the script...</a><a href="#" onclick="$('#collapse-294b2b29-show, #collapse-294b2b29-hide').toggle(); $('#collapse-294b2b29').fadeToggle(150);; return false;" id="collapse-294b2b29-hide" class="icon icon-expended collapsible" style="display:none;">Impression of the usage page of the script...</a><div id="collapse-294b2b29" class="collapsed-text" style="display:none;"><pre>
Usage: changelog_generator.rb [options]
Required specific options:
-i, --version_id VERSIONID Numerical id of the version [int]
Optional specific options:
-n, --version_name VERSIONNAME Name of the version [string]
-d, --release_date RELEASEDATE Date of the release [string: YYYY-MM-DD]
-b, --new_branch NEWBRANCH New release branch indicator [string: true/false/auto (default)]
Common options:
-h, --help Prints this help
-v, --version Show version
</pre></div></p>
While looking into this issue I also noticed that the formatting of the changelogs of the last 3.2.6 and 3.3.3 releases in the packaged CHANGLOG file is wrong. I've fixed it and I'll leave the three patch files attached to this issue:
<ul>
<li>0001-Fix-changelog-markup.patch (for trunk, can be merged into 3.4-stable)</li>
<li>0001-Fix-changelog-markup.-3.2-stable-backport-of-rX.patch (for 3.2-stable)</li>
<li>0001-Fix-changelog-markup.-3.3-stable-backport-of-rX.patch (for 3.3-stable)</li>
</ul>
<p>I have updated <a class="wiki-page new" href="https://www.redmine.org/projects/redmine/wiki/Changelog_3_4-draft">Changelog_3_4-draft</a> upto today. I also updated the packaged CHANGELOG file; I'll leave a patch against trunk for that change (which requires patch 0001-Fix-changelog-markup.patch to be applied first).</p>
<p><em>Note: <a class="issue tracker-3 status-5 priority-4 priority-default closed" title="Patch: Fix outdated copyrights (Closed)" href="https://www.redmine.org/issues/26311">#26311</a> and <a class="issue tracker-3 status-5 priority-4 priority-default closed" title="Patch: Remove duplicate notifiable require (Closed)" href="https://www.redmine.org/issues/26312">#26312</a> (nor <a class="issue tracker-2 status-5 priority-4 priority-default closed" title="Feature: Change format of the changelog (both on redmine.org and in the shipped changelog file) (Closed)" href="https://www.redmine.org/issues/25616">#25616</a>) are not-yet included in the 3.4.0 changelogs I've generated. If any of these is actually getting included in 3.4.0 (and they are kept targeted to 3.4.0 version), they still need to be added (maybe nice to test the uploaded scripts...)</em></p> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=796282017-07-02T06:45:14ZGo MAEDA
<ul></ul><p>Mischa, thank you for making the script!</p> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=796412017-07-02T09:07:22ZMischa The Evil
<ul><li><strong>Assignee</strong> changed from <i>Mischa The Evil</i> to <i>Jean-Philippe Lang</i></li></ul> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=796442017-07-02T12:02:40ZJean-Philippe Langjp_lang@yahoo.fr
<ul><li><strong>Status</strong> changed from <i>New</i> to <i>Closed</i></li><li><strong>Resolution</strong> set to <i>Fixed</i></li></ul><p>Patches applied and changelog generator committed, thanks.</p> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=796452017-07-02T12:09:13ZMarius BÄ‚LTEANU
<ul><li><strong>File</strong> <a href="/attachments/18663">screenshot.png</a> <a class="icon-only icon-download" title="Download" href="/attachments/download/18663/screenshot.png">screenshot.png</a> added</li></ul><p>One mention if it's not too late: we should strip the subject text in order to avoid left/right empty spaces</p>
<p><img src="https://www.redmine.org/attachments/download/18663/screenshot.png" alt="" /></p> Redmine - Feature #25616: Change format of the changelog (both on redmine.org and in the shipped changelog file)https://www.redmine.org/issues/25616?journal_id=804052017-07-31T10:21:46ZToshi MARUYAMA
<ul></ul><p>Marius BALTEANU wrote:</p>
<blockquote>
<p>One mention if it's not too late: we should strip the subject text in order to avoid left/right empty spaces</p>
</blockquote>
<p>FTR: <a class="issue tracker-1 status-5 priority-4 priority-default closed" title="Defect: Remove unnecessary spaces from CHANGELOG (Closed)" href="https://www.redmine.org/issues/26388">#26388</a>.</p>