1#!/usr/bin/env python3 2# 3# Add version information to poky.yaml based upon current git branch/tags 4# 5# Copyright Linux Foundation 6# Author: Richard Purdie <richard.purdie@linuxfoundation.org> 7# 8# SPDX-License-Identifier: MIT 9# 10 11 12import subprocess 13import collections 14import sys 15import os 16import itertools 17 18ourversion = None 19if len(sys.argv) == 2: 20 ourversion = sys.argv[1] 21 22ourversion = None 23if len(sys.argv) == 2: 24 ourversion = sys.argv[1] 25 26activereleases = ["kirkstone", "honister", "hardknott", "dunfell"] 27devbranch = "langdale" 28ltsseries = ["kirkstone", "dunfell"] 29 30release_series = collections.OrderedDict() 31release_series["langdale"] = "4.1" 32release_series["kirkstone"] = "4.0" 33release_series["honister"] = "3.4" 34release_series["hardknott"] = "3.3" 35release_series["gatesgarth"] = "3.2" 36release_series["dunfell"] = "3.1" 37release_series["zeus"] = "3.0" 38release_series["warrior"] = "2.7" 39release_series["thud"] = "2.6" 40release_series["sumo"] = "2.5" 41release_series["rocko"] = "2.4" 42release_series["pyro"] = "2.3" 43release_series["morty"] = "2.2" 44release_series["krogoth"] = "2.1" 45release_series["jethro"] = "2.0" 46release_series["jethro-pre"] = "1.9" 47release_series["fido"] = "1.8" 48release_series["dizzy"] = "1.7" 49release_series["daisy"] = "1.6" 50release_series["dora"] = "1.5" 51release_series["dylan"] = "1.4" 52release_series["danny"] = "1.3" 53release_series["denzil"] = "1.2" 54release_series["edison"] = "1.1" 55release_series["bernard"] = "1.0" 56release_series["laverne"] = "0.9" 57 58 59bitbake_mapping = { 60 "langdale" : "2.2", 61 "kirkstone" : "2.0", 62 "honister" : "1.52", 63 "hardknott" : "1.50", 64 "gatesgarth" : "1.48", 65 "dunfell" : "1.46", 66} 67 68# 3.4 onwards doesn't have poky version 69# Early 3.4 release docs do reference it though 70poky_mapping = { 71 "3.4" : "26.0", 72 "3.3" : "25.0", 73 "3.2" : "24.0", 74 "3.1" : "23.0", 75} 76 77ourseries = None 78ourbranch = None 79bitbakeversion = None 80docconfver = None 81 82# Test tags exist and inform the user to fetch if not 83try: 84 subprocess.run(["git", "show", "yocto-3.4.2"], capture_output=True, check=True) 85except subprocess.CalledProcessError: 86 sys.exit("Please run 'git fetch --tags' before building the documentation") 87 88# Try and figure out what we are 89tags = subprocess.run(["git", "tag", "--points-at", "HEAD"], capture_output=True, text=True).stdout 90for t in tags.split(): 91 if t.startswith("yocto-"): 92 ourversion = t[6:] 93 94if ourversion: 95 # We're a tagged release 96 components = ourversion.split(".") 97 baseversion = components[0] + "." + components[1] 98 docconfver = ourversion 99 for i in release_series: 100 if release_series[i] == baseversion: 101 ourseries = i 102 ourbranch = i 103 if i in bitbake_mapping: 104 bitbakeversion = bitbake_mapping[i] 105else: 106 # We're floating on a branch 107 branch = subprocess.run(["git", "branch", "--show-current"], capture_output=True, text=True).stdout.strip() 108 ourbranch = branch 109 if branch != "master" and branch not in release_series: 110 # We're not on a known release branch so we have to guess. Compare the numbers of commits 111 # from each release branch and assume the smallest number of commits is the one we're based off 112 possible_branch = None 113 branch_count = 0 114 for b in itertools.chain(release_series.keys(), ["master"]): 115 result = subprocess.run(["git", "log", "--format=oneline", "HEAD..origin/" + b], capture_output=True, text=True) 116 if result.returncode == 0: 117 count = result.stdout.count('\n') 118 if not possible_branch or count < branch_count: 119 print("Branch %s has count %s" % (b, count)) 120 possible_branch = b 121 branch_count = count 122 if possible_branch: 123 branch = possible_branch 124 else: 125 branch = "master" 126 print("Nearest release branch estimated to be %s" % branch) 127 if branch == "master": 128 ourseries = devbranch 129 docconfver = "dev" 130 bitbakeversion = "dev" 131 elif branch in release_series: 132 ourseries = branch 133 if branch in bitbake_mapping: 134 bitbakeversion = bitbake_mapping[branch] 135 else: 136 sys.exit("Unknown series for branch %s" % branch) 137 138 previoustags = subprocess.run(["git", "tag", "--merged", "HEAD"], capture_output=True, text=True).stdout 139 previoustags = [t[6:] for t in previoustags.split() if t.startswith("yocto-" + release_series[ourseries])] 140 futuretags = subprocess.run(["git", "tag", "--merged", ourbranch], capture_output=True, text=True).stdout 141 futuretags = [t[6:] for t in futuretags.split() if t.startswith("yocto-" + release_series[ourseries])] 142 143 # Append .999 against the last known version 144 if len(previoustags) != len(futuretags): 145 ourversion = previoustags[-1] + ".999" 146 else: 147 ourversion = release_series[ourseries] + ".999" 148 if not docconfver: 149 docconfver = ourversion 150 151series = [k for k in release_series] 152previousseries = series[series.index(ourseries)+1:] or [""] 153lastlts = [k for k in previousseries if k in ltsseries] or "dunfell" 154 155print("Version calculated to be %s" % ourversion) 156print("Release series calculated to be %s" % ourseries) 157 158replacements = { 159 "DISTRO" : ourversion, 160 "DISTRO_NAME_NO_CAP" : ourseries, 161 "DISTRO_NAME" : ourseries.capitalize(), 162 "DISTRO_NAME_NO_CAP_MINUS_ONE" : previousseries[0], 163 "DISTRO_NAME_NO_CAP_LTS" : lastlts[0], 164 "YOCTO_DOC_VERSION" : ourversion, 165 "DISTRO_REL_TAG" : "yocto-" + ourversion, 166 "DOCCONF_VERSION" : docconfver, 167 "BITBAKE_SERIES" : bitbakeversion, 168} 169 170if release_series[ourseries] in poky_mapping: 171 pokyversion = poky_mapping[release_series[ourseries]] 172 if ourversion != release_series[ourseries]: 173 pokyversion = pokyversion + "." + ourversion.rsplit(".", 1)[1] 174 else: 175 pokyversion = pokyversion + ".0" 176 replacements["POKYVERSION"] = pokyversion 177 178if os.path.exists("poky.yaml.in"): 179 with open("poky.yaml.in", "r") as r, open("poky.yaml", "w") as w: 180 lines = r.readlines() 181 for line in lines: 182 data = line.split(":") 183 k = data[0].strip() 184 if k in replacements: 185 w.write("%s : \"%s\"\n" % (k, replacements[k])) 186 else: 187 w.write(line) 188 189 print("poky.yaml generated from poky.yaml.in") 190 191 192# In the switcher list of versions we display: 193# - latest dev 194# - latest stable release 195# - latest LTS 196# - latest for each releases listed as active 197# - latest doc version in current series 198# - current doc version 199# (with duplicates removed) 200 201versions = [] 202with open("sphinx-static/switchers.js.in", "r") as r, open("sphinx-static/switchers.js", "w") as w: 203 lines = r.readlines() 204 for line in lines: 205 if "ALL_RELEASES_PLACEHOLDER" in line: 206 w.write(str(list(release_series.keys()))) 207 continue 208 if "VERSIONS_PLACEHOLDER" in line: 209 w.write(" 'dev': { 'title': 'dev (%s)', 'obsolete': false,},\n" % release_series[devbranch]) 210 for branch in activereleases + ([ourseries] if ourseries not in activereleases else []): 211 if branch == devbranch: 212 continue 213 branch_versions = subprocess.run('git tag --list yocto-%s*' % (release_series[branch]), shell=True, capture_output=True, text=True).stdout.split() 214 branch_versions = sorted([v.replace("yocto-" + release_series[branch] + ".", "").replace("yocto-" + release_series[branch], "0") for v in branch_versions], key=int) 215 if not branch_versions: 216 continue 217 version = release_series[branch] 218 if branch_versions[-1] != "0": 219 version = version + "." + branch_versions[-1] 220 versions.append(version) 221 w.write(" '%s': {'title': '%s', 'obsolete': %s,},\n" % (version, version, str(branch not in activereleases).lower())) 222 if ourversion not in versions and ourseries != devbranch: 223 w.write(" '%s': {'title': '%s', 'obsolete': %s,},\n" % (ourversion, ourversion, str(ourseries not in activereleases).lower())) 224 else: 225 w.write(line) 226 227print("switchers.js generated from switchers.js.in") 228 229