Fix handling of translations in the manual builds #105036

New Issue

Bastien Montagne · 2024-11-26T12:47:02+01:00

Bastien Montagne commented

2024-11-26 12:47:02 +01:00

Current Issue

Currently there is only one branch for manual translations, which is used for all non-English locales of all currently generated manuals.

Since translations for the manual are currently always updated from the main branch, all older manuals will see their translations degrade over time, as the main branch diverge more and more from the release ones.

Proposed Solution

Add 'release' branches to blender-manual-translations.

Add blender-vx.y-release branches to the blender-manual-translations, when the release branches are created for the main Blender code one.
- Will require adding these branches for 4.3 and current LTS releases too.
Update related release process documentation.
Use 'categories' in weblate to have main, Blender 4.3, etc sets of components. See mock-up in the staging server.
Update buildbot/worker/doc_manual.py buildbot code update() function to pass in the branch for the locale repo update. Something like that should work (code not tested yet):

def update(builder: ManualBuilder) -> None:
    builder.update_source()
    if builder.needs_all_locales:
        worker.utils.update_source(
            "blender", "blender-manual-translations", builder.code_path / "locale",
            branch_id=builder.branch_id
        )

## Current Issue Currently there is only [one branch](https://projects.blender.org/blender/blender-manual-translations) for manual translations, which is used for all non-English locales of all currently generated manuals. Since translations for the manual are currently always updated from the main branch, all older manuals will see their translations degrade over time, as the main branch diverge more and more from the release ones. ## Proposed Solution Add 'release' branches to `blender-manual-translations`. * [x] Add `blender-vx.y-release` branches to the `blender-manual-translations`, when the release branches are created for the main Blender code one. - Will require adding these branches for 4.3 and current LTS releases too. * [x] Update related [release process documentation](https://projects.blender.org/blender/blender-developer-docs/src/branch/main/docs/handbook/release_process/release_checklist/index.md#blender). * [x] Use 'categories' in weblate to have `main`, `Blender 4.3`, etc sets of components. See mock-up in the [staging server](https://translate.staging.blender.org/projects/blender-manual/). * [x] Update `buildbot/worker/doc_manual.py` buildbot code `update()` function to pass in the branch for the `locale` repo update. Something like that should work (code not tested yet): ```python def update(builder: ManualBuilder) -> None: builder.update_source() if builder.needs_all_locales: worker.utils.update_source( "blender", "blender-manual-translations", builder.code_path / "locale", branch_id=builder.branch_id ) ```

Bastien Montagne added the

labels 2024-11-26 12:47:03 +01:00

Bastien Montagne commented

2024-11-26 12:48:16 +01:00

@bartvdbraak @Sergey @Blendify FYI.

Sergey Sharybin commented

2024-11-26 16:45:38 +01:00

@mont29 I am not sure if there is anything actionable from the CI/CD perspective. We already have tracks for the different releases, so the changes are limited to the organization of the translation repos, the update script, and the Weblate?

Bastien Montagne commented

2024-11-26 17:07:10 +01:00

@Sergey unless am mistaken buildbot/worker/doc_manual.py is buildbot area (the bdr-devops-core repo on our gitlab), so changing this file does involve CI/CD?

@Sergey unless am mistaken `buildbot/worker/doc_manual.py` is buildbot area (the bdr-devops-core repo on our gitlab), so changing this file does involve CI/CD?

Sergey Sharybin commented

2024-11-27 10:05:56 +01:00

@mont29 Ah, indeed. Somehow I thought it is all tackled by manual's make update.
Anyway, seems an easy change to do.

@mont29 Ah, indeed. Somehow I thought it is all tackled by manual's `make update`. Anyway, seems an easy change to do.

Aaron Carlisle commented

2024-11-28 02:51:51 +01:00

@mont29 I have been meaning to bring this up. I think you described the issue perfectly and I have no problems with the proposed solution.

Aaron Carlisle added the

Priority

High

label 2024-11-28 04:45:56 +01:00

Aaron Carlisle referenced this issue