Difference between revisions of "Module:Version"
Jump to navigation
Jump to search
module>Jdforrester (WMF) m (Duh.) |
m (1 revision imported) |
(No difference)
|
Latest revision as of 05:53, 31 July 2020
This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
The main entrypoint is the "get" function. First parameter is release, can be "stable", "legacy", "lts", or "alpha". Second parameter is the format, can be "version", "branch", "git", or "date". Note that "alpha" only works with "branch", the behavior of other output formats is undefined.
{{#invoke:Version|get|alpha|branch}}
: 1.36{{#invoke:Version|get|stable|version}}
: 1.34.2{{#invoke:Version|get|stable|branch}}
: 1.34{{#invoke:Version|get|stable|git}}
: REL1_34{{#invoke:Version|get|stable|date}}
: 2020-06-24{{#invoke:Version|get|lts|version}}
: 1.31.8{{#invoke:Version|get|legacy|version}}
: 1.33.4{{#invoke:Version|get|legacylts|version}}
: 1.31.8
That said, you probably want to use one of the wrapper templates in Category:MediaWiki version information templates instead of calling this module directly.
local p = {}
local releases = {}
-- HEY YOU, UPDATE THESE
releases["1.34.2"] = "2020-06-24"
releases["1.33.4"] = "2020-06-24"
releases["1.31.8"] = "2020-06-24"
-- Is there a beta branch that isn't a proper release yet?
p.isthereabeta = true
-- OKAY YOU CAN STOP NOW
-- Iterate in reverse
-- from http://lua-users.org/wiki/IteratorsTutorial
function ripairs(t)
local function ripairs_it(t,i)
i=i-1
local v=t[i]
if v==nil then return v end
return i,v
end
return ripairs_it, t, #t+1
end
p.releases = releases
-- get trimmed version like "1.XX"
function p.branch( version )
return string.sub(version, 0,4)
end
-- git branch like REL1_XX
function p.git_branch( version )
return "REL1_" .. string.sub(p.branch(version), 3)
end
-- is the given version an LTS release?
function p.islts( version )
-- if we ever cut a 2.x release this will need to be rethought
local x = tonumber(string.sub(p.branch( version ), 3))
if x < 19 then return false end
-- every 4th release starting with 1.19 is an LTS
return ((x - 19) % 4) == 0
end
function p.get( frame )
return p.version( frame.args[1], frame.args[2] )
end
-- main function
-- release: stable, legacy, legacylts, lts, alpha
-- format: version, branch, git, date
function p.version( release, format )
local versions = {}
for k,v in pairs(p.releases) do
table.insert(versions,k)
end
table.sort(versions)
--mw.logObject(versions)
--mw.log(#versions)
local version = "0.0.0"
if release == "stable" then
version = versions[#versions]
elseif release == "legacy" then
version = versions[#versions-1]
elseif release == "lts" then
for i,v in ipairs(versions) do
-- this might not be right.
if p.islts(v) then
version = v
end
end
elseif release == "legacylts" then
-- the oldest LTS version is the legacy LTS version.
-- (e.g. when there are both 1.23.x and 1.27.x releases, choose 1.23.x)
for i,v in ripairs(versions) do
if p.islts(v) then
version = v
end
end
elseif (release == "alpha" or release == "beta") then
-- alpha and beta only works with "branch" output
version_parts = mw.text.split(p.branch(versions[#versions]), ".", true)
version_parts[2] = tonumber(version_parts[2])+1
if (p.isthereabeta and release == "alpha") then
version_parts[2] = tonumber(version_parts[2]) + 1
end
version = table.concat(version_parts, ".")
if (not p.isthereabeta and release == "beta") then
version = "—"
end
end
local out = "WRONG"
if format == "version" then
out = version
elseif format == "branch" then
out = p.branch( version )
elseif format == "git" then
out = p.git_branch( version )
elseif format == "date" then
out = p.releases[version]
end
return out
end
return p