1#!/usr/bin/env python3 2# 3# Add version information to poky.yaml based upon current git branch/tags 4# Also generate the list of available manuals (releases.rst file) 5# 6# Copyright Linux Foundation 7# Author: Richard Purdie <richard.purdie@linuxfoundation.org> 8# Author: Quentin Schulz <foss@0leil.net> 9# 10# SPDX-License-Identifier: MIT 11# 12 13 14import subprocess 15import collections 16import sys 17import os 18import itertools 19import re 20 21ourversion = None 22if len(sys.argv) == 2: 23 ourversion = sys.argv[1] 24 25ourversion = None 26if len(sys.argv) == 2: 27 ourversion = sys.argv[1] 28 29activereleases = ["styhead", "scarthgap", "kirkstone"] 30devbranch = "walnascar" 31ltsseries = ["scarthgap", "kirkstone"] 32 33# used by run-docs-builds to get the default page 34if ourversion == "getlatest": 35 print(activereleases[0]) 36 sys.exit(0) 37 38release_series = collections.OrderedDict() 39release_series["walnascar"] = "5.2" 40release_series["styhead"] = "5.1" 41release_series["scarthgap"] = "5.0" 42release_series["nanbield"] = "4.3" 43release_series["mickledore"] = "4.2" 44release_series["langdale"] = "4.1" 45release_series["kirkstone"] = "4.0" 46release_series["honister"] = "3.4" 47release_series["hardknott"] = "3.3" 48release_series["gatesgarth"] = "3.2" 49release_series["dunfell"] = "3.1" 50release_series["zeus"] = "3.0" 51release_series["warrior"] = "2.7" 52release_series["thud"] = "2.6" 53release_series["sumo"] = "2.5" 54release_series["rocko"] = "2.4" 55release_series["pyro"] = "2.3" 56release_series["morty"] = "2.2" 57release_series["krogoth"] = "2.1" 58release_series["jethro"] = "2.0" 59release_series["jethro-pre"] = "1.9" 60release_series["fido"] = "1.8" 61release_series["dizzy"] = "1.7" 62release_series["daisy"] = "1.6" 63release_series["dora"] = "1.5" 64release_series["dylan"] = "1.4" 65release_series["danny"] = "1.3" 66release_series["denzil"] = "1.2" 67release_series["edison"] = "1.1" 68release_series["bernard"] = "1.0" 69release_series["laverne"] = "0.9" 70 71 72bitbake_mapping = { 73 "walnascar" : "2.12", 74 "styhead" : "2.10", 75 "scarthgap" : "2.8", 76 "nanbield" : "2.6", 77 "mickledore" : "2.4", 78 "langdale" : "2.2", 79 "kirkstone" : "2.0", 80 "honister" : "1.52", 81 "hardknott" : "1.50", 82 "gatesgarth" : "1.48", 83 "dunfell" : "1.46", 84} 85 86# 3.4 onwards doesn't have poky version 87# Early 3.4 release docs do reference it though 88poky_mapping = { 89 "3.4" : "26.0", 90 "3.3" : "25.0", 91 "3.2" : "24.0", 92 "3.1" : "23.0", 93} 94 95ourseries = None 96ourbranch = None 97bitbakeversion = None 98docconfver = None 99 100# Test tags exist and inform the user to fetch if not 101try: 102 subprocess.run(["git", "show", "yocto-%s" % release_series[activereleases[0]]], stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True) 103except subprocess.CalledProcessError: 104 sys.exit("Please run 'git fetch --tags' before building the documentation") 105 106# Try and figure out what we are 107tags = subprocess.run(["git", "tag", "--points-at", "HEAD"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True).stdout 108for t in tags.split(): 109 if t.startswith("yocto-"): 110 ourversion = t[6:] 111 112if ourversion: 113 # We're a tagged release 114 components = ourversion.split(".") 115 baseversion = components[0] + "." + components[1] 116 docconfver = ourversion 117 for i in release_series: 118 if release_series[i] == baseversion: 119 ourseries = i 120 ourbranch = i 121 if i in bitbake_mapping: 122 bitbakeversion = bitbake_mapping[i] 123else: 124 # We're floating on a branch 125 branch = subprocess.run(["git", "branch", "--show-current"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True).stdout.strip() 126 ourbranch = branch 127 if branch != "master" and branch not in release_series: 128 # We're not on a known release branch so we have to guess. Compare the numbers of commits 129 # from each release branch and assume the smallest number of commits is the one we're based off 130 possible_branch = None 131 branch_count = 0 132 for b in itertools.chain(release_series.keys(), ["master"]): 133 result = subprocess.run(["git", "log", "--format=oneline", "HEAD..origin/" + b], stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True) 134 if result.returncode == 0: 135 count = result.stdout.count('\n') 136 if not possible_branch or count < branch_count: 137 print("Branch %s has count %s" % (b, count)) 138 possible_branch = b 139 branch_count = count 140 if possible_branch: 141 branch = possible_branch 142 else: 143 branch = "master" 144 print("Nearest release branch estimated to be %s" % branch) 145 if branch == "master": 146 ourseries = devbranch 147 docconfver = "dev" 148 bitbakeversion = "dev" 149 elif branch in release_series: 150 ourseries = branch 151 if branch in bitbake_mapping: 152 bitbakeversion = bitbake_mapping[branch] 153 else: 154 sys.exit("Unknown series for branch %s" % branch) 155 156 previoustags = subprocess.run(["git", "tag", "--merged", "HEAD"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True).stdout 157 previoustags = [t[6:] for t in previoustags.split() if t.startswith("yocto-" + release_series[ourseries])] 158 futuretags = subprocess.run(["git", "tag", "--merged", ourbranch], stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True).stdout 159 futuretags = [t[6:] for t in futuretags.split() if t.startswith("yocto-" + release_series[ourseries])] 160 161 # Append .999 against the last known version 162 if len(previoustags) != len(futuretags): 163 ourversion = previoustags[-1] + ".999" 164 else: 165 ourversion = release_series[ourseries] + ".999" 166 if not docconfver: 167 docconfver = ourversion 168 169series = [k for k in release_series] 170previousseries = series[series.index(ourseries)+1:] or [""] 171lastlts = [k for k in previousseries if k in ltsseries] or "dunfell" 172 173print("Version calculated to be %s" % ourversion) 174print("Release series calculated to be %s" % ourseries) 175 176replacements = { 177 "DISTRO" : ourversion, 178 "DISTRO_NAME_NO_CAP" : ourseries, 179 "DISTRO_NAME" : ourseries.capitalize(), 180 "DISTRO_NAME_NO_CAP_MINUS_ONE" : previousseries[0], 181 "DISTRO_NAME_NO_CAP_LTS" : lastlts[0], 182 "YOCTO_DOC_VERSION" : ourversion, 183 "DISTRO_REL_TAG" : "yocto-" + ourversion, 184 "DOCCONF_VERSION" : docconfver, 185 "BITBAKE_SERIES" : bitbakeversion, 186} 187 188if release_series[ourseries] in poky_mapping: 189 pokyversion = poky_mapping[release_series[ourseries]] 190 if ourversion != release_series[ourseries]: 191 pokyversion = pokyversion + "." + ourversion.rsplit(".", 1)[1] 192 else: 193 pokyversion = pokyversion + ".0" 194 replacements["POKYVERSION"] = pokyversion 195 196if os.path.exists("poky.yaml.in"): 197 with open("poky.yaml.in", "r") as r, open("poky.yaml", "w") as w: 198 lines = r.readlines() 199 for line in lines: 200 data = line.split(":") 201 k = data[0].strip() 202 if k in replacements: 203 w.write("%s : \"%s\"\n" % (k, replacements[k])) 204 else: 205 w.write(line) 206 207 print("poky.yaml generated from poky.yaml.in") 208 209 210# In the switcher list of versions we display: 211# - latest dev 212# - latest stable release 213# - latest LTS 214# - latest for each releases listed as active 215# - latest doc version in current series 216# - current doc version 217# (with duplicates removed) 218 219versions = [] 220with open("sphinx-static/switchers.js.in", "r") as r, open("sphinx-static/switchers.js", "w") as w: 221 lines = r.readlines() 222 for line in lines: 223 if "ALL_RELEASES_PLACEHOLDER" in line: 224 w.write(str(list(release_series.keys()))) 225 continue 226 if "VERSIONS_PLACEHOLDER" in line: 227 w.write(" 'dev': { 'title': 'Unstable (dev)', 'obsolete': false,},\n") 228 for branch in activereleases + ([ourseries] if ourseries not in activereleases else []): 229 if branch == devbranch: 230 continue 231 branch_versions = subprocess.run('git tag --list yocto-%s*' % (release_series[branch]), shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True).stdout.split() 232 branch_versions = sorted([v.replace("yocto-" + release_series[branch] + ".", "").replace("yocto-" + release_series[branch], "0") for v in branch_versions], key=int) 233 if not branch_versions: 234 continue 235 version = release_series[branch] 236 if branch_versions[-1] != "0": 237 version = version + "." + branch_versions[-1] 238 versions.append(version) 239 w.write(" '%s': {'title': '%s (%s)', 'obsolete': %s,},\n" % (version, branch.capitalize(), version, str(branch not in activereleases).lower())) 240 if ourversion not in versions and ourseries != devbranch: 241 w.write(" '%s': {'title': '%s (%s)', 'obsolete': %s,},\n" % (ourversion, ourseries.capitalize(), ourversion, str(ourseries not in activereleases).lower())) 242 else: 243 w.write(line) 244 245print("switchers.js generated from switchers.js.in") 246 247# generate releases.rst 248 249# list missing tags in yocto-docs 250missing_tags = [ 251 'yocto-0.9', 252 'yocto-1.0', 'yocto-1.0.1', 253 'yocto-1.1', 'yocto-1.1.1', 254 'yocto-1.2', 255 'yocto-1.4.4', 'yocto-1.4.5', 256 'yocto-1.5', 'yocto-1.5.2', 'yocto-1.5.3', 'yocto-1.5.4', 257 'yocto-1.6', 'yocto-1.6.1', 'yocto-1.6.2', 258 'yocto-1.7', 'yocto-1.7.1', 259 'yocto-1.9', 260 'yocto-2.5.3', 261 'yocto-3.1', 'yocto-3.1.1', 'yocto-3.1.2', 'yocto-3.1.3', 262 ] 263 264semver = re.compile(r'yocto-(\d+)\.(\d+)(?:\.)?(\d*)') 265 266# git is able to properly order semver versions but not python 267# instead of adding a dependency on semver module, let's convert the version 268# into a decimal number, e.g. 11.23.1 will be 112301 and 1.5 will be 010500 so 269# it can be used as a key for the sorting algorithm. 270# This can be removed once all the old tags are re-created. 271def tag_to_semver_like(v): 272 v_semver = semver.search(v) 273 v_maj, v_min, v_patch = v_semver.groups('0') 274 return int("{:0>2}{:0>2}{:0>2}".format(v_maj, v_min, v_patch), 10) 275 276yocto_tags = subprocess.run(["git", "tag", "--list", "--sort=version:refname", "yocto-*"], stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True).stdout 277yocto_tags = sorted(yocto_tags.split() + missing_tags, key=tag_to_semver_like) 278tags = [tag[6:] for tag in yocto_tags] 279 280with open('releases.rst', 'w') as f: 281 f.write('===========================\n') 282 f.write(' Supported Release Manuals\n') 283 f.write('===========================\n') 284 f.write('\n') 285 286 for activerelease in activereleases: 287 title = "Release Series %s (%s)" % (release_series[activerelease], activerelease) 288 f.write('*' * len(title) + '\n') 289 f.write(title + '\n') 290 f.write('*' * len(title) + '\n') 291 f.write('\n') 292 293 for tag in tags: 294 if tag == release_series[activerelease] or tag.startswith('%s.' % release_series[activerelease]): 295 f.write('- :yocto_docs:`%s Documentation </%s>`\n' % (tag, tag)) 296 f.write('\n') 297 298 f.write('==========================\n') 299 f.write(' Outdated Release Manuals\n') 300 f.write('==========================\n') 301 f.write('\n') 302 303 for series in release_series: 304 if series == devbranch or series in activereleases: 305 continue 306 307 if series == "jethro-pre": 308 continue 309 310 title = "Release Series %s (%s)" % (release_series[series], series) 311 f.write('*' * len(title) + '\n') 312 f.write(title + '\n') 313 f.write('*' * len(title) + '\n') 314 f.write('\n') 315 if series == "jethro": 316 f.write('- :yocto_docs:`1.9 Documentation </1.9>`\n') 317 for tag in tags: 318 if tag == release_series[series] or tag.startswith('%s.' % release_series[series]): 319 f.write('- :yocto_docs:`%s Documentation </%s>`\n' % (tag, tag)) 320 f.write('\n') 321