aboutsummaryrefslogtreecommitdiff
path: root/.github/build/README.md
diff options
context:
space:
mode:
authorRémy Raes <raes.remy@gmail.com>2023-04-06 00:28:09 +0200
committerGitHub <noreply@github.com>2023-04-06 00:28:09 +0200
commit7ec5413c0e71300814350164c69e6452136bd4cd (patch)
tree0b01bde876db7be51ab2d5a645bb3d13c745bfec /.github/build/README.md
parent80ceb2b317336c454d83392028501a31da89e77e (diff)
downloadNorthstarMods-7ec5413c0e71300814350164c69e6452136bd4cd.tar.gz
NorthstarMods-7ec5413c0e71300814350164c69e6452136bd4cd.zip
Add CI logic for finding missing translations (#608)
* build: add script to get missing keys per language * fix: typo * fix: check arguments before launching script * feat: script can be run with language argument * docs: add readme * fix: remove multiple spaces while searching for translations * build: add translations check CI * refactor: put translation job alongside encoding job * feat: add unicode characters because why not * build: exit with an error code if some translations are missing * build: exit using process.exit * feat: CI should continue running with missing translations * build: use actions/checkout v3 * refactor: put build directory into .github directory
Diffstat (limited to '.github/build/README.md')
-rw-r--r--.github/build/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/.github/build/README.md b/.github/build/README.md
new file mode 100644
index 000000000..84d479a32
--- /dev/null
+++ b/.github/build/README.md
@@ -0,0 +1,28 @@
+# Finding missing translations
+
+This package contains a script that detects missing translation keys in Titanfall2 translation files contained in this repository (in the `Northstar.Client/mod/resource` folder).
+
+It uses english translations file as reference.
+
+You have to launch it **from the repository root folder**:
+```shell
+node .github/build/find-missing-translations.js
+```
+The script will then list all missing translations for all supported languages.
+
+If you want to display missing keys for a given language, just add it as an argument:
+```shell
+node .github/build/find-missing-translations.js french
+```
+
+Here's the list of supported languages:
+* english
+* french
+* german
+* italian
+* japanese
+* mspanish
+* portuguese
+* russian
+* spanish
+* tchinese \ No newline at end of file