docs: translate docs (#250)

* chore: translate docs * chore: translate docs * chore: add docs_languages * fix: add assets folder * chore: docs * chore: docs --------- Co-authored-by: Tyler Matteson <[email protected]> Co-authored-by: Tyler Matteson <[email protected]>
agritheory · Jul 18, 2024 · 94d8004 · 94d8004
1 parent 5a8fa6f
commit 94d8004
Show file tree

Hide file tree

Showing 36 changed files with 162 additions and 0 deletions.
diff --git a/.github/workflows/translate_docs.yml b/.github/workflows/translate_docs.yml
@@ -0,0 +1,43 @@
+name: Translate Markdown Files
+
+on:
+  pull_request:
+    paths:
+      - 'docs/*/en/*.md'
+
+jobs:
+  translate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+
+      - name: Set up credentials
+        run: echo "$GOOGLE_APPLICATION_CREDENTIALS" > credentials.json
+        env:
+          GOOGLE_APPLICATION_CREDENTIALS: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install google-cloud-translate
+          pip install gitpython
+          pip install PyGithub
+
+      - name: Translate Markdown files
+        env:
+          GOOGLE_APPLICATION_CREDENTIALS: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_REPOSITORY: ${{ secrets.GITHUB_REPOSITORY }}
+          GITHUB_BASE_REF: ${{ secrets.GITHUB_SHA }}
+          GITHUB_REF: ${{ secrets.GITHUB_REF }}
+        run: |
+          python translate_docs.py
+
+      - name: Remove credentials file
+        run: rm credentials.json
diff --git a/check_run/hooks.py b/check_run/hooks.py
@@ -10,6 +10,8 @@
 app_license = "MIT"
 required_apps = ["frappe/erpnext", "frappe/hrms"]
 
+docs_languages = ["es"]
+
 # Includes in <head>
 # ------------------
 

diff --git a/docs/achgeneration.md → docs/version-14/en/achgeneration.md b/docs/achgeneration.md → docs/version-14/en/achgeneration.md
diff --git a/docs/assets/ACHFile.png → docs/version-14/en/assets/ACHFile.png b/docs/assets/ACHFile.png → docs/version-14/en/assets/ACHFile.png
diff --git a/docs/assets/BankAccount.png → docs/version-14/en/assets/BankAccount.png b/docs/assets/BankAccount.png → docs/version-14/en/assets/BankAccount.png
diff --git a/docs/assets/CheckRunDetailBoxAroundMoP.png → .../en/assets/CheckRunDetailBoxAroundMoP.png b/docs/assets/CheckRunDetailBoxAroundMoP.png → .../en/assets/CheckRunDetailBoxAroundMoP.png
diff --git a/docs/assets/CheckRunScreen.png → docs/version-14/en/assets/CheckRunScreen.png b/docs/assets/CheckRunScreen.png → docs/version-14/en/assets/CheckRunScreen.png
diff --git a/docs/assets/ConfigEmployee.png → docs/version-14/en/assets/ConfigEmployee.png b/docs/assets/ConfigEmployee.png → docs/version-14/en/assets/ConfigEmployee.png
diff --git a/docs/assets/ConfigSupplier.png → docs/version-14/en/assets/ConfigSupplier.png b/docs/assets/ConfigSupplier.png → docs/version-14/en/assets/ConfigSupplier.png
diff --git a/docs/assets/InitiatingCheckRunDialogue.png → .../en/assets/InitiatingCheckRunDialogue.png b/docs/assets/InitiatingCheckRunDialogue.png → .../en/assets/InitiatingCheckRunDialogue.png
diff --git a/.../assets/InvoicePaymentScheduleExample.png → .../assets/InvoicePaymentScheduleExample.png b/.../assets/InvoicePaymentScheduleExample.png → .../assets/InvoicePaymentScheduleExample.png
diff --git a/docs/assets/ModeOfPayment.png → docs/version-14/en/assets/ModeOfPayment.png b/docs/assets/ModeOfPayment.png → docs/version-14/en/assets/ModeOfPayment.png
diff --git a/docs/assets/PaymentEntryPaymentTerm.png → ...-14/en/assets/PaymentEntryPaymentTerm.png b/docs/assets/PaymentEntryPaymentTerm.png → ...-14/en/assets/PaymentEntryPaymentTerm.png
diff --git a/docs/assets/PaymentScheduleTransactions.png → ...en/assets/PaymentScheduleTransactions.png b/docs/assets/PaymentScheduleTransactions.png → ...en/assets/PaymentScheduleTransactions.png
diff --git a/docs/assets/PositivePayReport.png → ...ersion-14/en/assets/PositivePayReport.png b/docs/assets/PositivePayReport.png → ...ersion-14/en/assets/PositivePayReport.png
diff --git a/docs/assets/PostSubmissionOptions.png → ...on-14/en/assets/PostSubmissionOptions.png b/docs/assets/PostSubmissionOptions.png → ...on-14/en/assets/PostSubmissionOptions.png
diff --git a/docs/assets/PrintConfirmation.png → ...ersion-14/en/assets/PrintConfirmation.png b/docs/assets/PrintConfirmation.png → ...ersion-14/en/assets/PrintConfirmation.png
diff --git a/docs/assets/SettingsList.png → docs/version-14/en/assets/SettingsList.png b/docs/assets/SettingsList.png → docs/version-14/en/assets/SettingsList.png
diff --git a/docs/assets/Settings_ACH.png → docs/version-14/en/assets/Settings_ACH.png b/docs/assets/Settings_ACH.png → docs/version-14/en/assets/Settings_ACH.png
diff --git a/docs/assets/Settings_MOP.png → docs/version-14/en/assets/Settings_MOP.png b/docs/assets/Settings_MOP.png → docs/version-14/en/assets/Settings_MOP.png
diff --git a/docs/assets/Settings_Main.png → docs/version-14/en/assets/Settings_Main.png b/docs/assets/Settings_Main.png → docs/version-14/en/assets/Settings_Main.png
diff --git a/docs/assets/SupplierDefaultMoPDetail.png → ...14/en/assets/SupplierDefaultMoPDetail.png b/docs/assets/SupplierDefaultMoPDetail.png → ...14/en/assets/SupplierDefaultMoPDetail.png
diff --git a/docs/assets/VoucherGroup.png → docs/version-14/en/assets/VoucherGroup.png b/docs/assets/VoucherGroup.png → docs/version-14/en/assets/VoucherGroup.png
diff --git a/docs/assets/return-debit_note.png → ...ersion-14/en/assets/return-debit_note.png b/docs/assets/return-debit_note.png → ...ersion-14/en/assets/return-debit_note.png
diff --git a/docs/configuration.md → docs/version-14/en/configuration.md b/docs/configuration.md → docs/version-14/en/configuration.md
diff --git a/docs/exampledata.md → docs/version-14/en/exampledata.md b/docs/exampledata.md → docs/version-14/en/exampledata.md
diff --git a/docs/exampleprint.md → docs/version-14/en/exampleprint.md b/docs/exampleprint.md → docs/version-14/en/exampleprint.md
diff --git a/docs/index.md → docs/version-14/en/index.md b/docs/index.md → docs/version-14/en/index.md
diff --git a/docs/installationguide.md → docs/version-14/en/installationguide.md b/docs/installationguide.md → docs/version-14/en/installationguide.md
diff --git a/docs/payment_entry.md → docs/version-14/en/payment_entry.md b/docs/payment_entry.md → docs/version-14/en/payment_entry.md
diff --git a/docs/permissions.md → docs/version-14/en/permissions.md b/docs/permissions.md → docs/version-14/en/permissions.md
diff --git a/docs/positivepay.md → docs/version-14/en/positivepay.md b/docs/positivepay.md → docs/version-14/en/positivepay.md
diff --git a/docs/renderpdfsequence.md → docs/version-14/en/renderpdfsequence.md b/docs/renderpdfsequence.md → docs/version-14/en/renderpdfsequence.md
diff --git a/docs/settings.md → docs/version-14/en/settings.md b/docs/settings.md → docs/version-14/en/settings.md
diff --git a/docs/translations.md → docs/version-14/en/translations.md b/docs/translations.md → docs/version-14/en/translations.md
diff --git a/translate_docs.py b/translate_docs.py
@@ -0,0 +1,117 @@
+import os
+import re
+import json
+import pathlib
+import importlib
+from concurrent.futures import ThreadPoolExecutor, as_completed
+from google.cloud import translate_v2 as translate
+from git import Repo
+from github import Github, GithubException
+
+
+def get_languages():
+	app_name = pathlib.Path(__file__).resolve().parent.name
+	hooks = importlib.import_module(f"{app_name}.hooks")
+	try:
+		return hooks.docs_languages
+	except Exception:
+		return []
+
+
+def set_google_credentials():
+	secret_value = os.getenv("GOOGLE_APPLICATION_CREDENTIALS")
+	with open("credentials.json", "w") as f:
+		json.dump(json.loads(secret_value), f)
+	os.environ["GOOGLE_APPLICATION_CREDENTIALS"] = "credentials.json"
+
+
+def get_pull_request_number():
+	github_ref = os.getenv("GITHUB_REF")
+	match = re.match(r"refs/pull/(\d+)/merge", github_ref)
+	return int(match.group(1)) if match else None
+
+
+def translate_file(source_file, target_file, target_language, translate_client):
+	translation = translate_client.translate(
+		source_file, target_language=target_language, format_="text"
+	)
+	with open(target_file, "w", encoding="utf-8") as f:
+		f.write(translation["translatedText"])
+
+
+def translate_md_files():
+	target_languages = get_languages()
+
+	if not target_languages:
+		return
+
+	set_google_credentials()
+	translate_client = translate.Client()
+	base_branch = os.getenv("GITHUB_BASE_REF", "main")  # Default to 'main' if not available
+	repo_name = os.getenv("GITHUB_REPOSITORY")
+	g = Github(os.getenv("GITHUB_TOKEN"))
+
+	repo = Repo(search_parent_directories=True)
+	origin = repo.remote(name="origin")
+	origin.fetch()
+
+	version_folders = [f for f in os.listdir("docs") if os.path.isdir(os.path.join("docs", f))]
+
+	pull_request_number = get_pull_request_number()
+	repository = g.get_repo(repo_name, lazy=False)
+	pull_request = repository.get_pull(pull_request_number)
+	head_branch = pull_request.head.ref
+	files = pull_request.get_files()
+
+	modified_files = {}
+
+	for file in files:
+		try:
+			modified_files[file.filename] = repository.get_contents(
+				file.filename, ref=head_branch
+			).decoded_content.decode("utf-8")
+		except Exception:
+			continue
+
+	with ThreadPoolExecutor() as executor:
+		futures = []
+		for version in version_folders:
+			for target_language in target_languages:
+				for filename, modified_file in modified_files.items():
+					if filename.startswith(f"docs/{version}/en") and filename.endswith(".md"):
+						source_file = modified_file
+						target_folder = f"docs/{version}/{target_language}"
+						target_file = os.path.join(target_folder, os.path.basename(filename))
+						if not os.path.exists(target_folder):
+							os.makedirs(target_folder)
+						futures.append(
+							executor.submit(translate_file, source_file, target_file, target_language, translate_client)
+						)
+
+		for future in as_completed(futures):
+			try:
+				future.result()
+			except Exception as e:
+				print(f"Error during translation: {e}")
+
+	for version in version_folders:
+		for target_language in target_languages:
+			target_folder = f"docs/{version}/{target_language}"
+			branch_name = f"translate-{target_language}"
+			repo.git.checkout(base_branch)
+			repo.git.checkout("-b", branch_name)
+			repo.index.add([target_folder])
+			commit_message = f"Translate {target_language}"
+			repo.index.commit(commit_message)
+			origin.push(branch_name)
+
+			title = f"Translate to {target_language}"
+			body = f"This pull request translates to {target_language}"
+			try:
+				repository.create_pull(title=title, body=body, head=branch_name, base=base_branch)
+			except GithubException as e:
+				print(f"Failed to create pull request for {target_language}: {e}")
+
+
+if __name__ == "__main__":
+	translate_md_files()