概要

generaltranslation v8 では、API に大幅な変更を加えており、一部の API 関数およびエンドポイントを非推奨としています。

古いバージョンの API は今後サポートされなくなります。

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

---

背景

開発者体験を向上させ、今後の開発を進めやすくし、翻訳管理を容易にするため、ブランチ機能を導入するとともに、すでに使われていない一部のAPIエンドポイントを非推奨とします。

---

機能

最新のAPI関数でブランチがサポートされ、プロジェクトのブランチごとに異なる翻訳を作成できるようになりました。

現在は、すべてのファイルがブランチに関連付けられます。ファイルのバージョン管理は、branchId、fileId、versionId によって決まります。

以前は、ファイルの翻訳は単一のブランチに関連付けられていました。 キャッシュされたファイル翻訳では、デフォルトでそのファイルの最新更新版が使用されていました。

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

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

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

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

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

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

変更点

generaltranslation

• checkTranslationStatus は非推奨になりました
• downloadFile は非推奨になりました
• downloadTranslatedFile を downloadFile にリネーム
  • ロケールが指定されているかどうかに応じて、ソースまたは対応する翻訳をダウンロードします
• 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 ブランチが使用されます。
  • ドキュメントのドラフトプレビュー向けブランチのサポートは、今後のリリースで追加予定です。