You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/references/string-translations.md
+9-8
Original file line number
Diff line number
Diff line change
@@ -2,18 +2,19 @@
2
2
3
3
[@azure/communication-react](https://www.npmjs.com/package/@azure/communication-react) includes translations of all strings used internally to a set of supported languages.
4
4
5
-
We use a Microsoft internal translation service for string translations. Strings are automatically sent for translation via a [GitHub action](https://github.com/Azure/communication-ui-library/actions/workflows/run-td-build.yml) on pushes to the `main`.
5
+
We use a Microsoft internal translation service for string translations. Strings are automatically sent for translation when pushed to main. This is done via an internal Azure Pipeline.
6
6
7
7
**Strings are not committed back into the repository automatically**. This is to avoid surprises due to mis-translated strings and so that test snapshots can be updated to reflect the new strings.
8
8
9
-
To fetch back strings:
9
+
## Pulling strings back to the repo
10
10
11
-
* Create a new branch off of `main` and trigger the same [GitHub action](https://github.com/Azure/communication-ui-library/actions/workflows/run-td-build.yml).
12
-
* Pick your new branch to run the workflow and check the option to commit updated strings.
* Follow the [usual process](../contributing-guide/6.%20submitting-a-pr.md) for merging the PR into `main`.
15
-
* You _may_ need to add the `update_snapshots` label to the PR to update [e2e test snapshots](../references/ui-tests.md) if the e2e tests fail.
11
+
To pull strings back to the repo:
16
12
17
-
**Note**: String translation can take up to 5 working days to complete. Be careful when making (i.e., cherry-picking into a release branch) string changes close to a release.
13
+
- Run the internal Azure pipeline manually and select `Commit strings to GitHub`.
14
+
- This will create a branch called `td/new-strings-<datetime>` with the new strings.
15
+
- This pipeline can br run off any branch and the strings will be translated from that branch. We typically run it off `main` or a `release` branch.
16
+
- Then create a PR to merge this branch into your desired branch.
17
+
18
+
## References
18
19
19
20
Further reading: [Internal documentation](https://skype.visualstudio.com/SPOOL/_wiki/wikis/SPOOL.wiki/25949/Localization) for details on how string translation service is setup.
0 commit comments