概要

generaltranslation v8 では、API に大きな変更を加えるとともに、一部の API 関数やエンドポイントを非推奨とします。

古いバージョンの API は今後サポートされません。

7.5 より前の generaltranslation のバージョンでは、エラーが発生する可能性があります。 2.1.5 より前の gtx-cli のバージョンでは、エラーが発生する可能性があります。

---

Motivation

開発者エクスペリエンスを向上させ、今後の開発をしやすくし、翻訳管理を簡素化するため、ブランチ機能を導入し、既に使用されていない一部の API エンドポイントを廃止します。

---

機能

最新の API 関数はブランチングをサポートしており、プロジェクト内の各ブランチごとに別々の翻訳を作成できます。

すべてのファイルはブランチに紐づくようになりました。ファイルのバージョニングは branchId、fileId、versionId によって決定されます。

これまでは、ファイル翻訳は 1 つのブランチにのみ紐づいていました。 キャッシュされたファイル翻訳は、デフォルトでそのファイルの最新バージョンを使用していました。

バージョン 8 では、ファイルの翻訳を更新すると、指定したブランチ上にあるそのファイルの最新バージョンが使用されます。 バージョニングはタイムスタンプではなく、ブランチの履歴に紐づきます。

新しいバージョニングシステムは、git のブランチモデルを反映しています：

• ブランチ上のソースファイルを更新すると、そのファイルの新しいバージョンが作成されます。
• ブランチを main にマージすると、main ブランチ上のソースファイルと、マージ元ブランチ上のソースファイルとの間にリンクが生成されます。
  • 今後の翻訳では、両方のブランチからの翻訳が取り込まれます。
• ブランチをチェックアウトすると、そのファイルの新しいバージョンが作成されます。
  • このブランチ上の翻訳は、main ブランチの既存の翻訳を参照します。

この機能を有効にするには、最新バージョンの gtx-cli で gtx-cli translate コマンドに --enable-branching フラグを追加してください。

デフォルトではブランチングは無効であり、すべてのプロジェクトファイルは main ブランチに関連付けられています。

この機能を利用するには、組織が有料プランに加入している必要があります。

変更履歴

generaltranslation

• 非推奨: checkTranslationStatus
• 非推奨: downloadFile
• downloadTranslatedFile を downloadFile にリネーム
  • locale が指定されているかどうかに応じて、ソースまたは対応する翻訳のいずれかをダウンロードします
• downloadFile と downloadFileBatch のパラメーターを変更
• 非推奨: enqueueEntries
• enqueueFiles のパラメーターを変更（branchIds を追加）
• 非推奨: fetchTranslations
• 非推奨: shouldSetupProject
• submitUserEditDiffs のパラメーターを変更（branchIds を追加し、id フィールドを必須に変更）
• uploadSourceFiles のパラメーターを変更（branchIds を追加）
• uploadTranslations のパラメーターを変更（branchIds を追加）
• querySourceFile のパラメーターを変更（branchIds を追加）
• checkJobStatus を追加
• queryFileData を追加
• 非推奨: checkSetupStatus（代わりに checkJobStatus を使用）
• 非推奨: checkFileTranslations（代わりに queryFileData を使用）

gtx-cli

• translate コマンドに --enable-branching フラグを追加
• translate コマンドに --branch フラグを追加
  • （オプション）翻訳に使用するブランチを指定して上書き
• translate コマンドに --disable-branch-detection フラグを追加
  • （オプション）有効化すると、CLI は使用するブランチの自動検出を行いません。
  • git がインストールされていない場合や、プロジェクトが git リポジトリではない場合にこのフラグを使用してください。
• 翻訳の進行状況のトラッキングとログ出力を改善
• 翻訳エラー処理を改善
• 不要な API ファイルアップロードを回避するよう API パフォーマンスを最適化

gt-sanity

• generaltranslation の最新バージョンを使用するように更新
• 翻訳はデフォルトで main ブランチを使用します。
  • ドキュメントのドラフトプレビュー用ブランチのサポートは、今後のリリースで追加される予定です。