Skip to content

Localization Process

Jump to bottom
lmarceau edited this page Aug 10, 2023 · 45 revisions

Overview

For documentation on how to add strings in the repo, please look into this wiki page.

The following document gives a step by step guide for the string localization process, meaning the import and the export of strings and their translations in our project.

Github action import process

The string import refers to the import of strings from the l10n repository to the Firefox for iOS repository. The string export refers to the reverse action, which is to export strings from the Firefox for iOS repository to the l10n repository. Both of those actions are handled by Github actions. The import action lives in Firefox for iOS, while the export action lives in the l10n repository. The Firefox for iOS team is responsible for reviewing the import PRs opened towards main and releases, and ensuring the strings added in the repo are following the l10n rules. See documentation on how to add strings for this.

Import

String import from the firefoxios-l10n repository happens once a week and points to the main branch. The Github action opens a PR, which then needs to be reviewed and merged by the developer team. Importing strings can also be done by pointing to a certain branch. For example, on hard freeze a string import can be triggered by running the Create a PR with changes after importing strings workflow, and writing down the targeted version of the branch as shown in following picture:

Screen Shot 2022-09-12 at 1 36 19 PM

Export

String export happens by adding new strings into the Firefox for iOS strings file. Any developer adding new strings to the project should be familiar with the principles described in l10n documentation.

Steps to add strings to the strings.swift file:

  1. Add the new strings in the related struct. If there's no struct for a string, create one related to the feature or section this string will be under.
  2. How to define a localized string can be found here.
  3. Once all strings are added, open a PR on Firefox for iOS.
  4. Once merged, the new strings will be exported automatically to the firefox l10n repository through the automated Github action. In case the export needs to be triggered sooner, ping Delphine so the export Github action can be triggered.
Clone this wiki locally