Re: [docs] Version bump before release

[Richard Purdie <richard.purdie@linuxfoundation.org>]

I know I've been a bit against having magic versions as the tag information may
not always be present in a git checkout of the docs. That said, I was curious to
see how close we could get the information with and without tag information.
I've included a script below which tries to use any branch/tag information
available to guess the correct release series and version to use.

We can make sure the tag information is there for docs builds on our
infrastructure so that bit is easy. The question is therefore whether this does
generate good enough information for people with local checkouts?

The objective here would be to automate generation of the version information in
the docs so we don't have to manually update it other than adding new release
series mappings to master.

See what you think of the script/idea.

I've just realised we could detect the missing tags and tell the user to fetch
them before building too. That would solve most of my worries I think?

Cheers,

Richard



#!/usr/bin/env python3

import subprocess
import collections
import sys

devbranch = "langdale"

release_series = collections.OrderedDict()
release_series["langdale"] = "4.1"
release_series["kirkstone"] = "4.0"
release_series["honister"] = "3.4"
release_series["hardknott"] = "3.3"
release_series["gatesgarth"] = "3.2"
release_series["dunfell"] = "3.1"

ourversion = None
ourseries = None
ourbranch = None

# Try and figure out what we are
tags = subprocess.run(["git", "tag", "--points-at", "HEAD"], capture_output=True, text=True).stdout
for t in tags.split():
    if t.startswith("yocto-"):
        ourversion = t[6:]

if ourversion:
    components = ourversion.split(".")
    baseversion = components[0] + "." + components[1]
    for i in release_series:
        if release_series[i] == baseversion:
            ourseries = i
            ourbranch = i
else:
    branch = subprocess.run(["git", "branch", "--show-current"], capture_output=True, text=True).stdout.strip()
    ourbranch = branch
    if branch == "master":
        ourseries = devbranch
    elif branch in release_series:
        ourseries = branch
    else:
        sys.exit("Unknown series for branch %s" % branch)

    previoustags = subprocess.run(["git", "tag", "--merged", "HEAD"], capture_output=True, text=True).stdout
    previoustags = [t[6:] for t in previoustags.split() if t.startswith("yocto-" + release_series[ourseries])]
    futuretags = subprocess.run(["git", "tag", "--merged", ourbranch], capture_output=True, text=True).stdout
    futuretags = [t[6:] for t in futuretags.split() if t.startswith("yocto-" + release_series[ourseries])]

    if len(previoustags) != len(futuretags):
        ourversion = previoustags[-1] + ".999"
    else:
        ourversion = release_series[ourseries] + ".999"

print("Version calculated to be %s" % ourversion)
print("Release series calculated to be %s" % ourseries)