Skip to content

Change the branding name for the alpha and nightly releases

henry requested to merge henry/tor-browser:branding-names-tb43446 into tor-browser-128.7.0esr-14.5-1

Merge Info

Issues

Resolves

Related

Merging

Target Branches

  • tor-browser - !fixups to tor-browser-specific commits, new features, security backports
  • base-browser and mullvad-browser - !fixups to base-browser-specific commits, new features to be shared with mullvad-browser, and security backports
    • ⚠️ IMPORTANT: Please list the base-browser-specific commits which need to be cherry-picked to the base-browser and mullvad-browser branches here

Target Channels

  • Alpha: esr128-14.5
  • Stable: esr128-14.0
  • Legacy: esr115-13.5

Backporting

Timeline

  • No Backport (preferred): patchset for the next major stable
  • Immediate: patchset needed as soon as possible (fixes CVEs, 0-days, etc)
  • Next Minor Stable Release: patchset that needs to be verified in nightly before backport
  • Eventually: patchset that needs to be verified in alpha before backport

(Optional) Justification

  • Security update: patchset contains a security fix (be sure to select the correct item in Timeline)
  • Censorship event: patchset enables censorship circumvention
  • Critical bug-fix: patchset fixes a bug in core-functionality
  • Consistency: patchset which would make development easier if it were in both the alpha and release branches; developer tools, build system changes, etc
  • Sponsor required: patchset required for sponsor
  • Localization: typos and other localization changes that should be also in the release branch
  • Other: please explain

Issue Tracking

Review

Request Reviewer

  • Request review from an applications developer depending on modified system:
    • NOTE: if the MR modifies multiple areas, please /cc all the relevant reviewers (since Gitlab only allows 1 reviewer)
    • accessibility : henry
    • android : clairehurst, dan
    • build system : boklm
    • extensions : ma1
    • firefox internals (XUL/JS/XPCOM) : jwilde, ma1
    • fonts : pierov
    • frontend (implementation) : henry
    • frontend (review) : donuts, morgan
    • localization : henry, pierov
    • macOS : clairehurst, dan
    • nightly builds : boklm
    • rebases/release-prep : dan, ma1, pierov, morgan
    • security : jwilde, ma1
    • signing : boklm, morgan
    • updater : pierov
    • windows : jwilde, morgan
    • misc/other : pierov, morgan

Change Description

We change the -brand-short-name, -brand-full-name, brandShortName and brandFullName strings for the alpha and nightly releases.

In the translation CI, we merge all the branding file versions into one brand.ftl and brand.properties file that we send to the translations repository. The merged file contains the full content of the file in branding/tb-release/, plus additional strings for the alpha and nightly strings that differ from the release strings. These additional strings are given the _alpha and _nightly suffix, respectively.

From Weblate's point of view, this should just be 4 additional strings in each file.

I updated the combine library to handle the case where we only want to include some of strings from a file. And added some unit tests for these.

/cc @emmapeel

How Tested

I ran the combine-translation-versions.py script locally (with the fetch commands commented out) with the same input as in update-translations.yml.

The output for brand.ftl was

# For Tor Browser, we use a new file (different than the brand.ftl file
# that is used by Firefox) to avoid picking up the -brand-short-name values
# that Mozilla includes in the Firefox language packs.

-brand-shorter-name = Tor Browser
-brand-short-name = Tor Browser
-brand-full-name = Tor Browser
# This brand name can be used in messages where the product name needs to
# remain unchanged across different versions (Nightly, Beta, etc.).
-brand-product-name = Tor Browser
-vendor-short-name = Tor Project
# "Tor" is a trademark names, so should not be translated (not including the quote marks, which can be localized).
# "The Tor Project, Inc." is an organisation name.
trademarkInfo = “Tor” and the Tor logo are registered trademarks of The Tor Project, Inc.


## Alpha Release

-brand-short-name_alpha = Tor Browser Alpha
-brand-full-name_alpha = Tor Browser Alpha


## Nightly Release

-brand-short-name_nightly = Tor Browser Nightly
-brand-full-name_nightly = Tor Browser Nightly

and the output for brand.properties was

# Copyright (c) 2022, The Tor Project, Inc.
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

brandShorterName=Tor Browser
brandShortName=Tor Browser
brandFullName=Tor Browser

# Alpha Release
brandShortName_alpha=Tor Browser Alpha
# Alpha Release
brandFullName_alpha=Tor Browser Alpha

# Nightly Release
brandShortName_nightly=Tor Browser Nightly
# Nightly Release
brandFullName_nightly=Tor Browser Nightly

I also ran pytest . in the combine directory.

Edited by henry

Merge request reports