mirror of
https://github.com/seigler/dash-docs
synced 2025-07-27 17:56:16 +00:00
cbebe461ff
Add additional variables to the release note files to allow setting the version number and date. The version number is required, and can be used to automatically set the release notes title. The date is optional and can be set hours/days after the release. Additionally, a Makefile test is added that checks whether the download files exist on the Bitcoin.org server. This can help prevent creating a broken Download page. * Set variables for all previous releases * Document variables in README.md * Update code and templates to use variables * Add the Download page links to the "dl" CSS class. Also add newlines to make the HTML a bit easier to parse using sed * Add a new Liquid plugin to print warnings. This is used to print a non-error warning if any release is created without the optional date
98 lines
3.2 KiB
Ruby
98 lines
3.2 KiB
Ruby
# This file is licensed under the MIT License (MIT) available on
|
|
# http://opensource.org/licenses/MIT.
|
|
|
|
#releases.rb generates release pages using files in _releases
|
|
#and assign them the 'release' category.
|
|
|
|
#This is later used to loop through site.pages in order
|
|
#to display the release's list in version order, both
|
|
#on the "Version history" page and RSS file.
|
|
|
|
# This plugin also finds the highest required_version of
|
|
# Bitcoin Core and populates the Download page with variables set in
|
|
# that release file
|
|
|
|
require 'yaml'
|
|
|
|
module Jekyll
|
|
|
|
class ReleasePage < Page
|
|
|
|
def initialize(site, base, lang, srcdir, src, output_directory)
|
|
@site = site
|
|
@base = base
|
|
@dir = '/' + output_directory
|
|
|
|
## Read in the file's YAML header
|
|
self.read_yaml(File.join(base, srcdir), src)
|
|
|
|
## Die if required_ variables aren't set
|
|
if self.data['required_version']
|
|
version = self.data['required_version']
|
|
else
|
|
abort("Error: Variable required_version not set when processing " + src)
|
|
end
|
|
|
|
## Output file is v<version>.md (converted later to HTML)
|
|
output_file = "v" + version + ".md"
|
|
@name = output_file
|
|
self.process(output_file)
|
|
|
|
## Title required for <title></title> in _layouts/base.html
|
|
self.data['title'] = self.data['optional_title'] ? self.data['optional_title'] : "Bitcoin Core version %v released"
|
|
self.data['title'].gsub!('%v', version)
|
|
|
|
## For translation, but currently always set to "en"
|
|
self.data['lang'] = lang
|
|
|
|
## Only processes numeric version numbers with up to five decimals
|
|
self.data['versionint'] = versiontoint(self.data['required_version'])
|
|
|
|
self.data['layout'] = 'release'
|
|
self.data['category'] = 'release'
|
|
|
|
## If this is the highest version we've seen so far...
|
|
if !site.config.has_key?('DOWNLOAD_VERSION') or site.config['DOWNLOAD_VERSIONINT'] < self.data['versionint']
|
|
site.config['DOWNLOAD_VERSIONINT'] = self.data['versionint']
|
|
site.config['DOWNLOAD_VERSION'] = self.data['required_version']
|
|
|
|
site.config['DOWNLOAD_MAGNETLINK'] = self.data['optional_magnetlink'] ? self.data['optional_magnetlink'] : nil
|
|
end
|
|
end
|
|
|
|
def versiontoint(v)
|
|
x = 0
|
|
ar = v.split('.').map{|s| s.to_i}
|
|
ar.each_index do |k|
|
|
x += ar[k] * (1000 ** (5 - k))
|
|
end
|
|
return x
|
|
end
|
|
|
|
end
|
|
|
|
class ReleasePageGenerator < Generator
|
|
def generate(site)
|
|
|
|
#Do nothing if plugin is disabled
|
|
if !ENV['ENABLED_PLUGINS'].nil? and ENV['ENABLED_PLUGINS'].index('releases').nil?
|
|
print 'Releases disabled' + "\n"
|
|
return
|
|
end
|
|
|
|
#generate each release based on templates
|
|
Dir.foreach('_releases') do |file|
|
|
next if file == '.' or file == '..'
|
|
lang = 'en'
|
|
src = file
|
|
srcdir = '_releases'
|
|
output_directory = lang + '/release'
|
|
site.pages << ReleasePage.new(site, site.source, lang, '_releases', src, output_directory)
|
|
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
|