Re: [docs] [PATCH yocto-autobuilder-helper] scripts/run-docs-build: make all versions list releases known to master

[Quentin Schulz <quentin.schulz@theobroma-systems.com>]

Hi Michael,

On Wed, Dec 01, 2021 at 02:49:31PM +0100, Michael Opdenacker wrote:
> This allows all versions of Bitbake and Yocto Project manuals
> to see the manuals for the latest versions.
> 
> This also simplifies the release process, not having to update the
> releases.rst file for all releases every time a new release is made.
> 
> Note that such synchronization is already done for the
> switchers.js file (but in a different way). This way, advertised
> releases are in sync with switchers.js.
> 

Why don't we migrate this different method (find) to the one you
implement in this commit too?

I could see a variable storing all "force-latest" files or someting like
that to make it obvious why they have a specific handling.

> Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> ---
>  scripts/run-docs-build | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/scripts/run-docs-build b/scripts/run-docs-build
> index 4451018..5d6d24a 100755
> --- a/scripts/run-docs-build
> +++ b/scripts/run-docs-build
> @@ -39,8 +39,11 @@ cp -r ./_build/final/* $outputdir/bitbake/next
>  # A decision was made to keep updating all the Sphinx generated docs for the moment,
>  # even the ones corresponding to no longer supported releases
>  # https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_2193&d=DwIDAg&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=41QznJ3f-1jbT6A1N9c2-XE7vAUbnla1A6cM0yaU8thgWg_WVfeII9dfe8Uq2JTO&s=YCQsQAquPWLLWl11yDzvgP9zkF-UkMF0c8B3BASBDbk&e= 
> +# We copy the releases.rst file from master so that all versions of the docs
> +# see the latest releases.
>  for branch in 1.46 1.48 1.50 1.52; do
>      git checkout $branch
> +    git checkout master doc/releases.rst

That's one way to do it, not sure this is really what we want but at
least it lowers the maintenance burden so it's a good improvement.

Cheers,
Quentin