From 6ac93df9f2da4af185ae55769c735ecd3bc8b1a9 Mon Sep 17 00:00:00 2001 From: Saivann Date: Wed, 19 Jun 2013 14:04:29 -0400 Subject: [PATCH] Generate releases notes using releases.rb Make releases notes layout and urls consistent with the alerts page Add RSS feed in download and version-history pages Add a canonical page with a redirect to the new url Simplify releases notes layouts --- README.md | 8 +-- _layouts/release.html | 19 +++++++ _layouts/releases.html | 14 ----- _less/screen.less | 7 ++- _plugins/releases.rb | 51 +++++++++++++++++++ _plugins/sitemap.rb | 13 +++++ .../2011-04-27-v0.3.21.md | 3 -- .../2011-06-05-v0.3.22.md | 3 -- .../2011-06-14-v0.3.23.md | 3 -- .../2011-07-08-v0.3.24.md | 3 -- .../2011-09-23-v0.4.0.md | 3 -- .../2011-11-21-v0.5.0.md | 3 -- .../2011-12-15-v0.5.1.md | 3 -- .../2012-01-09-v0.5.2.md | 3 -- .../2012-03-14-v0.5.3.md | 3 -- .../2012-03-16-v0.5.3.1.md | 3 -- .../2012-03-30-v0.6.0.md | 3 -- .../2012-05-04-v0.6.1.md | 3 -- .../2012-05-08-v0.6.2.md | 3 -- .../2012-06-25-v0.6.3.md | 3 -- .../2012-09-17-v0.7.0.md | 3 -- .../2012-10-19-v0.7.1.md | 3 -- .../2012-12-14-v0.7.2.md | 3 -- .../2013-02-19-v0.8.0.md | 3 -- .../2013-03-18-v0.8.1.md | 3 -- .../2013-05-29-v0.8.2.md | 3 -- _templates/download.html | 3 +- en/rss/releases.rss | 21 ++++++++ en/version-history.html | 20 ++------ 29 files changed, 118 insertions(+), 98 deletions(-) create mode 100644 _layouts/release.html delete mode 100644 _layouts/releases.html create mode 100644 _plugins/releases.rb rename {_posts/releases => _releases}/2011-04-27-v0.3.21.md (96%) rename {_posts/releases => _releases}/2011-06-05-v0.3.22.md (95%) rename {_posts/releases => _releases}/2011-06-14-v0.3.23.md (95%) rename {_posts/releases => _releases}/2011-07-08-v0.3.24.md (96%) rename {_posts/releases => _releases}/2011-09-23-v0.4.0.md (98%) rename {_posts/releases => _releases}/2011-11-21-v0.5.0.md (98%) rename {_posts/releases => _releases}/2011-12-15-v0.5.1.md (96%) rename {_posts/releases => _releases}/2012-01-09-v0.5.2.md (96%) rename {_posts/releases => _releases}/2012-03-14-v0.5.3.md (98%) rename {_posts/releases => _releases}/2012-03-16-v0.5.3.1.md (89%) rename {_posts/releases => _releases}/2012-03-30-v0.6.0.md (89%) rename {_posts/releases => _releases}/2012-05-04-v0.6.1.md (87%) rename {_posts/releases => _releases}/2012-05-08-v0.6.2.md (86%) rename {_posts/releases => _releases}/2012-06-25-v0.6.3.md (86%) rename {_posts/releases => _releases}/2012-09-17-v0.7.0.md (88%) rename {_posts/releases => _releases}/2012-10-19-v0.7.1.md (85%) rename {_posts/releases => _releases}/2012-12-14-v0.7.2.md (85%) rename {_posts/releases => _releases}/2013-02-19-v0.8.0.md (88%) rename {_posts/releases => _releases}/2013-03-18-v0.8.1.md (88%) rename {_posts/releases => _releases}/2013-05-29-v0.8.2.md (87%) create mode 100644 en/rss/releases.rss diff --git a/README.md b/README.md index 63eedb3a..d235d286 100644 --- a/README.md +++ b/README.md @@ -116,14 +116,12 @@ More information will follow. ### Release Notes -Release notes should be placed in `_posts/releases/YEAR-MONTH-DAY-SHORTTITLE.md` and adhere to this format: +Release notes should be placed in `_releases/YYYY-MM-DD-SHORTTITLE.md` and adhere to this format: ``` --- -layout: releases title: Bitcoin version 0.3.24 released src: http://sourceforge.net/mailarchive/message.php?msg_id=27771039 -category: releases --- Bitcoin v0.3.24 is now available for download at @@ -132,12 +130,8 @@ Bitcoin v0.3.24 is now available for download at ... ``` * `SHORTTITLE` is used to construct the URL. Something like `v0.3.24` will be fine -* `layout: releases` important for Jekyll * `title: ...` will be used as the title * `src: ...` (optional) link to full annoucement -* `category: ...` category of post -** `releases` -** `events` ### Aliases for contributors diff --git a/_layouts/release.html b/_layouts/release.html new file mode 100644 index 00000000..629a1986 --- /dev/null +++ b/_layouts/release.html @@ -0,0 +1,19 @@ +--- +layout: base +lang: en +--- +{% if page.redirect != nil %} + + +{% endif %} + +
+

{{ page.title }}
{{ page.date | date:"%e %B %Y" }}

+ {% if page.src %} +

+ Full announcement (including signatures) +

+ {% endif %} + {{ content }} +
+Go back to the version history diff --git a/_layouts/releases.html b/_layouts/releases.html deleted file mode 100644 index 18bfb139..00000000 --- a/_layouts/releases.html +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: base -lang: en ---- -
-

{{ page.title }}
{{ page.date | date:"%e %B %Y" }}

- {% if page.src %} -

- Full announcement (including signatures) -

- {% endif %} - {{ content }} -
-Show version history diff --git a/_less/screen.less b/_less/screen.less index 87010974..688c51a8 100644 --- a/_less/screen.less +++ b/_less/screen.less @@ -703,11 +703,16 @@ li p{ text-align:left; margin-bottom:40px; } -.rssicon{ +h1 .rssicon{ vertical-align:bottom; margin-bottom:9px; margin-left:10px; } +h2 .rssicon{ + vertical-align:bottom; + margin-bottom:7px; + margin-left:10px; +} .alertstatusinactive{ font-size:130%; color:#0d579b; diff --git a/_plugins/releases.rb b/_plugins/releases.rb new file mode 100644 index 00000000..2332abd9 --- /dev/null +++ b/_plugins/releases.rb @@ -0,0 +1,51 @@ +require 'yaml' + +module Jekyll + + class ReleasePage < Page + def initialize(site, base, lang, srcdir, src, dstdir, dst, year, month, day) + @site = site + @base = base + @dir = '/'+dstdir + @name = dst.gsub('.md','.html') + self.process(dst) + self.read_yaml(File.join(base, srcdir), src) + self.data['lang'] = lang + self.data['date'] = year + '-' + month + '-' + day + self.data['layout'] = 'release' + if dstdir.index('/releases/') === 0 + self.data['redirect'] = dst.gsub('.md','') + else + self.data['category'] = 'release' + site.pages << ReleasePage.new(site, base, lang, srcdir, src, '/releases/' + year + '/' + month + '/' + day, dst, year, month, day) + end + end + end + + class ReleasePageGenerator < Generator + def generate(site) + #generate each release based on templates + Dir.foreach('_releases') do |file| + next if file == '.' or file == '..' + lang = 'en' + src = file + dst = file.split('-') + next if dst.length < 4 + year = dst.shift() + month = dst.shift() + day = dst.shift() + next if !/^[0-9]{4}$/.match(year) + next if !/^[0-9]{2}$/.match(month) + next if !/^[0-9]{2}$/.match(day) + dst = dst.join('-') + srcdir = '_releases' + dstdir = lang + '/release' + site.pages << ReleasePage.new(site, site.source, lang, '_releases', src, dstdir, dst, year, month, day) + end + #TODO releases are only generated for english language, + #but they could also be translated at some point. They would however + #need to fallback to english when no translation is available. + end + end + +end diff --git a/_plugins/sitemap.rb b/_plugins/sitemap.rb index 46c452bf..c2da9b32 100644 --- a/_plugins/sitemap.rb +++ b/_plugins/sitemap.rb @@ -90,6 +90,19 @@ module Jekyll sitemap.puts ' http://bitcoin.org/en/alert/'+file.gsub('.html','')+'' sitemap.puts '' end + #Add english releases pages + Dir.foreach('_releases') do |file| + next if file == '.' or file == '..' + file = file.split('-') + next if file.length < 4 + file.shift() + file.shift() + file.shift() + file = file.join('-') + sitemap.puts '' + sitemap.puts ' http://bitcoin.org/en/release/'+file.gsub('.md','').gsub('.html','')+'' + sitemap.puts '' + end #Add posts site.posts.each do |post| sitemap.puts '' diff --git a/_posts/releases/2011-04-27-v0.3.21.md b/_releases/2011-04-27-v0.3.21.md similarity index 96% rename from _posts/releases/2011-04-27-v0.3.21.md rename to _releases/2011-04-27-v0.3.21.md index 95fd00ae..177b9e99 100644 --- a/_posts/releases/2011-04-27-v0.3.21.md +++ b/_releases/2011-04-27-v0.3.21.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin version 0.3.21 released -category: releases -version: 0.3.21 --- Binaries for Bitcoin version 0.3.21 are available at: diff --git a/_posts/releases/2011-06-05-v0.3.22.md b/_releases/2011-06-05-v0.3.22.md similarity index 95% rename from _posts/releases/2011-06-05-v0.3.22.md rename to _releases/2011-06-05-v0.3.22.md index 139e2821..4cd735ea 100644 --- a/_posts/releases/2011-06-05-v0.3.22.md +++ b/_releases/2011-06-05-v0.3.22.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin version 0.3.22 released -category: releases -version: 0.3.22 --- Download URL: diff --git a/_posts/releases/2011-06-14-v0.3.23.md b/_releases/2011-06-14-v0.3.23.md similarity index 95% rename from _posts/releases/2011-06-14-v0.3.23.md rename to _releases/2011-06-14-v0.3.23.md index 79a656d0..857d2344 100644 --- a/_posts/releases/2011-06-14-v0.3.23.md +++ b/_releases/2011-06-14-v0.3.23.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin version 0.3.23 released -category: releases -version: 0.3.23 --- Win32, Linux, MacOSX and source releases for bitcoin v0.3.23 have been uploaded to diff --git a/_posts/releases/2011-07-08-v0.3.24.md b/_releases/2011-07-08-v0.3.24.md similarity index 96% rename from _posts/releases/2011-07-08-v0.3.24.md rename to _releases/2011-07-08-v0.3.24.md index ed0842a4..684ede28 100644 --- a/_posts/releases/2011-07-08-v0.3.24.md +++ b/_releases/2011-07-08-v0.3.24.md @@ -1,9 +1,6 @@ --- -layout: releases title: Bitcoin version 0.3.24 released src: http://sourceforge.net/mailarchive/message.php?msg_id=27771039 -category: releases -version: 0.3.24 --- Bitcoin v0.3.24 is now available for download at diff --git a/_posts/releases/2011-09-23-v0.4.0.md b/_releases/2011-09-23-v0.4.0.md similarity index 98% rename from _posts/releases/2011-09-23-v0.4.0.md rename to _releases/2011-09-23-v0.4.0.md index 121b8684..a7027398 100644 --- a/_posts/releases/2011-09-23-v0.4.0.md +++ b/_releases/2011-09-23-v0.4.0.md @@ -1,9 +1,6 @@ --- -layout: releases title: Bitcoin version 0.4.0 released src: http://sourceforge.net/mailarchive/message.php?msg_id=28132490 -category: releases -version: 0.4.0 --- Bitcoin version 0.4.0 is now available for download at: diff --git a/_posts/releases/2011-11-21-v0.5.0.md b/_releases/2011-11-21-v0.5.0.md similarity index 98% rename from _posts/releases/2011-11-21-v0.5.0.md rename to _releases/2011-11-21-v0.5.0.md index ebc1720c..c3a3b6e5 100644 --- a/_posts/releases/2011-11-21-v0.5.0.md +++ b/_releases/2011-11-21-v0.5.0.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.5.0 released -category: releases -version: 0.5.0 --- Bitcoin-Qt version 0.5.0 is now available for download at: diff --git a/_posts/releases/2011-12-15-v0.5.1.md b/_releases/2011-12-15-v0.5.1.md similarity index 96% rename from _posts/releases/2011-12-15-v0.5.1.md rename to _releases/2011-12-15-v0.5.1.md index f0b35831..00c374d7 100644 --- a/_posts/releases/2011-12-15-v0.5.1.md +++ b/_releases/2011-12-15-v0.5.1.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.5.1 released -category: releases -version: 0.5.1 --- Bitcoin-Qt version 0.5.1 is now available for download at: diff --git a/_posts/releases/2012-01-09-v0.5.2.md b/_releases/2012-01-09-v0.5.2.md similarity index 96% rename from _posts/releases/2012-01-09-v0.5.2.md rename to _releases/2012-01-09-v0.5.2.md index f2f85be6..60ea32bd 100644 --- a/_posts/releases/2012-01-09-v0.5.2.md +++ b/_releases/2012-01-09-v0.5.2.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.5.2 released -category: releases -version: 0.5.2 --- Bitcoin-Qt version 0.5.2 is now available for download at: diff --git a/_posts/releases/2012-03-14-v0.5.3.md b/_releases/2012-03-14-v0.5.3.md similarity index 98% rename from _posts/releases/2012-03-14-v0.5.3.md rename to _releases/2012-03-14-v0.5.3.md index 05423fce..cc297040 100644 --- a/_posts/releases/2012-03-14-v0.5.3.md +++ b/_releases/2012-03-14-v0.5.3.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.5.3 released -category: releases -version: 0.5.3 --- Bitcoin-Qt version 0.5.3 is now available for download at: diff --git a/_posts/releases/2012-03-16-v0.5.3.1.md b/_releases/2012-03-16-v0.5.3.1.md similarity index 89% rename from _posts/releases/2012-03-16-v0.5.3.1.md rename to _releases/2012-03-16-v0.5.3.1.md index 71ad292d..99589186 100644 --- a/_posts/releases/2012-03-16-v0.5.3.1.md +++ b/_releases/2012-03-16-v0.5.3.1.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.5.3.1 released -category: releases -version: 0.5.3.1 --- Bitcoin-Qt version 0.5.3.1 for Windows is now available for download at: diff --git a/_posts/releases/2012-03-30-v0.6.0.md b/_releases/2012-03-30-v0.6.0.md similarity index 89% rename from _posts/releases/2012-03-30-v0.6.0.md rename to _releases/2012-03-30-v0.6.0.md index 91383686..8af52341 100644 --- a/_posts/releases/2012-03-30-v0.6.0.md +++ b/_releases/2012-03-30-v0.6.0.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.6.0 released -category: releases -version: 0.6.0 --- Bitcoin-Qt version 0.6.0 is now available for download at: diff --git a/_posts/releases/2012-05-04-v0.6.1.md b/_releases/2012-05-04-v0.6.1.md similarity index 87% rename from _posts/releases/2012-05-04-v0.6.1.md rename to _releases/2012-05-04-v0.6.1.md index 97e5ea45..2b782c7c 100644 --- a/_posts/releases/2012-05-04-v0.6.1.md +++ b/_releases/2012-05-04-v0.6.1.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.6.1 released -category: releases -version: 0.6.1 --- Bitcoin-Qt version 0.6.1 is now available for download at: diff --git a/_posts/releases/2012-05-08-v0.6.2.md b/_releases/2012-05-08-v0.6.2.md similarity index 86% rename from _posts/releases/2012-05-08-v0.6.2.md rename to _releases/2012-05-08-v0.6.2.md index 7f4c83ac..50c67e53 100644 --- a/_posts/releases/2012-05-08-v0.6.2.md +++ b/_releases/2012-05-08-v0.6.2.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.6.2 released -category: releases -version: 0.6.2 --- Bitcoin-Qt version 0.6.2 is now available for download at: diff --git a/_posts/releases/2012-06-25-v0.6.3.md b/_releases/2012-06-25-v0.6.3.md similarity index 86% rename from _posts/releases/2012-06-25-v0.6.3.md rename to _releases/2012-06-25-v0.6.3.md index 8309b570..54ec4069 100644 --- a/_posts/releases/2012-06-25-v0.6.3.md +++ b/_releases/2012-06-25-v0.6.3.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.6.3 released -category: releases -version: 0.6.3 --- Bitcoin-Qt version 0.6.3 is now available for download at: diff --git a/_posts/releases/2012-09-17-v0.7.0.md b/_releases/2012-09-17-v0.7.0.md similarity index 88% rename from _posts/releases/2012-09-17-v0.7.0.md rename to _releases/2012-09-17-v0.7.0.md index f9492fb6..edc35f06 100644 --- a/_posts/releases/2012-09-17-v0.7.0.md +++ b/_releases/2012-09-17-v0.7.0.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.7.0 released -category: releases -version: 0.7.0 --- Bitcoin-Qt version 0.7.0 is now available for download at: diff --git a/_posts/releases/2012-10-19-v0.7.1.md b/_releases/2012-10-19-v0.7.1.md similarity index 85% rename from _posts/releases/2012-10-19-v0.7.1.md rename to _releases/2012-10-19-v0.7.1.md index 1f1674db..ed981c00 100644 --- a/_posts/releases/2012-10-19-v0.7.1.md +++ b/_releases/2012-10-19-v0.7.1.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.7.1 released -category: releases -version: 0.7.1 --- Bitcoin-Qt version 0.7.1 is now available for download at: diff --git a/_posts/releases/2012-12-14-v0.7.2.md b/_releases/2012-12-14-v0.7.2.md similarity index 85% rename from _posts/releases/2012-12-14-v0.7.2.md rename to _releases/2012-12-14-v0.7.2.md index 28c7b9bc..5ff88192 100644 --- a/_posts/releases/2012-12-14-v0.7.2.md +++ b/_releases/2012-12-14-v0.7.2.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.7.2 released -category: releases -version: 0.7.2 --- Bitcoin-Qt version 0.7.2 is now available for download at: diff --git a/_posts/releases/2013-02-19-v0.8.0.md b/_releases/2013-02-19-v0.8.0.md similarity index 88% rename from _posts/releases/2013-02-19-v0.8.0.md rename to _releases/2013-02-19-v0.8.0.md index 5c2f3c36..707f4f89 100644 --- a/_posts/releases/2013-02-19-v0.8.0.md +++ b/_releases/2013-02-19-v0.8.0.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.8.0 released -category: releases -version: 0.8.0 --- Bitcoin-Qt version 0.8.0 is now available for download at: diff --git a/_posts/releases/2013-03-18-v0.8.1.md b/_releases/2013-03-18-v0.8.1.md similarity index 88% rename from _posts/releases/2013-03-18-v0.8.1.md rename to _releases/2013-03-18-v0.8.1.md index 9d74383c..27d641d5 100644 --- a/_posts/releases/2013-03-18-v0.8.1.md +++ b/_releases/2013-03-18-v0.8.1.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.8.1 released -category: releases -version: 0.8.1 --- Bitcoin-Qt version 0.8.1 is now available for download at: diff --git a/_posts/releases/2013-05-29-v0.8.2.md b/_releases/2013-05-29-v0.8.2.md similarity index 87% rename from _posts/releases/2013-05-29-v0.8.2.md rename to _releases/2013-05-29-v0.8.2.md index ce632da5..348f9630 100644 --- a/_posts/releases/2013-05-29-v0.8.2.md +++ b/_releases/2013-05-29-v0.8.2.md @@ -1,8 +1,5 @@ --- -layout: releases title: Bitcoin-Qt version 0.8.2 released -category: releases -version: 0.8.2 --- Bitcoin-Qt version 0.8.2 is now available for download at: diff --git a/_templates/download.html b/_templates/download.html index ef61bf78..e03fcb5f 100755 --- a/_templates/download.html +++ b/_templates/download.html @@ -2,8 +2,9 @@ layout: base id: download --- +

{% translate pagetitle %}

-

{% translate latestversion %}{{site.DOWNLOAD_VERSION}}

+

{% translate latestversion %}{{site.DOWNLOAD_VERSION}}rss

{% translate downloadwinzip %} ~13MB
{% translate downloadwinexe %} ~9MB
diff --git a/en/rss/releases.rss b/en/rss/releases.rss new file mode 100644 index 00000000..6595060c --- /dev/null +++ b/en/rss/releases.rss @@ -0,0 +1,21 @@ +--- +--- + + + + Bitcoin-Qt releases + http://bitcoin.org/en/version-history + This RSS feed allows to follow Bitcoin-Qt new releases. + + http://bitcoin.org/img/logo_rss.png + http://bitcoin.org/en/version-history + + {% catpage_for p in site.pages reversed sort_by:date category:release %} + + {{ p.title }} + http://bitcoin.org{{ p.url | replace:'.html','' }} + {{ p.date | date: "%a, %d %b %Y" }} + + {% endcatpage_for %} + + diff --git a/en/version-history.html b/en/version-history.html index 713d58a2..5915b711 100644 --- a/en/version-history.html +++ b/en/version-history.html @@ -4,24 +4,14 @@ lang: en id: version-history title: Bitcoin-Qt version history --- +

-

Bitcoin-Qt version history

+

Bitcoin-Qt version historyrss

    - {% for post in site.categories.releases %} + {% catpage_for p in site.pages reversed sort_by:date category:release %}
  • - {{ post.date | date:"%Y-%m-%d" }} - {{ post.title }} + {{ p.date | date:"%Y-%m-%d" }} - {{ p.title }}
    • - {% endfor %} + {% endcatpage_for %}
-{% for post in site.categories.releases %} -
-

{{ post.title }}
{{ post.date | date:"%e %B %Y" }}

- {% if post.src %} -

- Full announcement (including signatures) -

- {% endif %} - {{ post.content }} -
-{% endfor %}