Re: [docs] Version bump before release

[Quentin Schulz <foss+yocto@0leil.net>]

Hi all,

On March 18, 2022 1:04:32 AM GMT+01:00, Michael Halstead <mhalstead@linuxfoundation.org> wrote:
>Hello,
>In the past we've correctly bumped the versions in the yocto-docs release
>branches before the release build and I only need to update the master
>branch to update the switcher on the website. This doesn't happen reliably
>though and we've been having to patch the build system to make the docs
>build correctly.
>
>Ideally all that would be needed at release time is a patch like
>https://git.yoctoproject.org/yocto-docs/commit/?id=78545b8f42657c21bc3cac96429d3950b07a3aca
>to update the website.
>

For the new releases (not the dot releases), it is essential this patch is merged with correct infos before tagging, specifically the poky.yaml file.

For dot releases, what matters is the bump of the dot release in poky.yaml, the rest of the changes aren't that important because it's impossible to always keep it up-to-date.

releases.rst and switchers.js are taken from master for all builds anyways by yocto-autobuilder-help so we don't technically have to worry about those making it before tagging day. Those need to make it to the master branch as soon as possible though (basically after tagging).

Two changes to conf.py need to be done too for releases. current_version needs to be bumped and bitbake_version to be set.

>Lately I've also had to make patches like these as well during release:
>
>https://git.yoctoproject.org/yocto-autobuilder-helper/commit/?id=ca8e95276d96b94d97e269b0f4f9ad306f8417d7
>https://git.yoctoproject.org/yocto-docs/commit/?h=honister&id=7980cfe942a1c8ceb3fd6b003ec6346d9bc11015
>(honister branch)
>

What is REALLY important is to get the current_version and bitbake_version correct in conf.py. poky.yaml changes might be required too but I haven't checked yet.

>What process can we put in place to make sure these version bumps happen on
>the named branch before the release candidate builds?
>
>Richard suggested a test that would make RC builds fail if the docs version
>were outdated. Any idea how to write that test?

Check the content of conf.py that current_version is NOT dev and that bitbake_version is set. Not sure how to detect a pre-release not having the current_version bumped though.

If current_version is set, extract it and make sure it's used in poky.yaml.

Cheers,
Quentin

> What other ideas come
>to mind?
>
>Thank you,