GitHub Actions

公式のLingo.dev GitHub Actionは、プッシュのたびにローカライゼーションパイプラインを実行し、ワークフローに応じて翻訳を直接コミットするか、プルリクエストを作成します。

マネージド運用をお望みですか？

GitHub App は、GitHubで継続的ローカライゼーションを実現する最も手軽な方法です。一度インストールするだけで、runnerもAPIキーのsecretもlockfileも不要で、プッシュやプルリクエストに反応します。翻訳を他のCIステップとあわせて自分のパイプライン内で実行したい場合は、GitHub Action（以下）を使ってください。

前提条件

まず CI/CD Setup を完了してください。リポジトリのsecretに保存された有効な i18n.json と LINGODOTDEV_API_KEY が必要です。

最小構成#

.github/workflows/translate.yml を作成します。

yaml

name: Translate
on:
  push:
    branches: [main]
permissions:
  contents: write
jobs:
  translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Lingo.dev
        uses: lingodotdev/lingo.dev@main
        with:
          api-key: ${{ secrets.LINGODOTDEV_API_KEY }}

これにより、プッシュのたびに翻訳が main に直接コミットされます。

ワークフロー例#

main にコミット#

yaml

name: Translate
on:
  push:
    branches: [main]
permissions:
  contents: write
jobs:
  translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Lingo.dev
        uses: lingodotdev/lingo.dev@main
        with:
          api-key: ${{ secrets.LINGODOTDEV_API_KEY }}

main からプルリクエストを作成#

yaml

name: Translate
on:
  push:
    branches: [main]
permissions:
  contents: write
  pull-requests: write
jobs:
  translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Lingo.dev
        uses: lingodotdev/lingo.dev@main
        with:
          api-key: ${{ secrets.LINGODOTDEV_API_KEY }}
          pull-request: true
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

PRベースのワークフローでは、Settings > Actions > General > Allow GitHub Actions to create and approve pull requests を有効にしてください。

feature branch にコミット#

yaml

name: Translate
on:
  push:
    branches-ignore: [main]
permissions:
  contents: write
jobs:
  translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Lingo.dev
        uses: lingodotdev/lingo.dev@main
        with:
          api-key: ${{ secrets.LINGODOTDEV_API_KEY }}

feature branch からプルリクエストを作成#

yaml

name: Translate
on:
  push:
    branches-ignore: [main]
permissions:
  contents: write
  pull-requests: write
jobs:
  translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Lingo.dev
        uses: lingodotdev/lingo.dev@main
        with:
          api-key: ${{ secrets.LINGODOTDEV_API_KEY }}
          pull-request: true
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

利用可能な入力#

入力	デフォルト	説明
`api-key`	必須	Lingo.dev APIキー
`pull-request`	`false`	直接コミットする代わりにプルリクエストを作成
`commit-message`	`feat: update translations via @LingoDotDev`	カスタムコミットメッセージ
`pull-request-title`	`feat: update translations via @LingoDotDev`	カスタムPRタイトル
`commit-author-name`	`Lingo.dev`	Gitコミットの作成者名
`commit-author-email`	`support@lingo.dev`	Gitコミットの作成者メールアドレス
`working-directory`	`.`	モノレポ向けの作業ディレクトリ
`process-own-commits`	`false`	このアクションが作成したコミットも処理
`parallel`	`false`	並列モードで実行
`version`	`latest`	Lingo.dev CLIのバージョン

次のステップ#

GitHub App

マネージド運用の代替手段。runner、secret、lockfileは不要

高度なパターン

翻訳チェック、マージコンフリクト、ワークフローの選択

GitLab CI/CD

GitLab CI/CD連携を設定

Bitbucket Pipelines

Bitbucket Pipelines連携を設定

マネージド運用をお望みですか？

前提条件

まず CI/CD Setup を完了してください。リポジトリのsecretに保存された有効な i18n.json と LINGODOTDEV_API_KEY が必要です。

最小構成#

.github/workflows/translate.yml を作成します。

yaml

name: Translate
on:
  push:
    branches: [main]
permissions:
  contents: write
jobs:
  translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Lingo.dev
        uses: lingodotdev/lingo.dev@main
        with:
          api-key: ${{ secrets.LINGODOTDEV_API_KEY }}

これにより、プッシュのたびに翻訳が main に直接コミットされます。

ワークフロー例#

main にコミット#

yaml

name: Translate
on:
  push:
    branches: [main]
permissions:
  contents: write
jobs:
  translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Lingo.dev
        uses: lingodotdev/lingo.dev@main
        with:
          api-key: ${{ secrets.LINGODOTDEV_API_KEY }}

main からプルリクエストを作成#

yaml

name: Translate
on:
  push:
    branches: [main]
permissions:
  contents: write
  pull-requests: write
jobs:
  translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Lingo.dev
        uses: lingodotdev/lingo.dev@main
        with:
          api-key: ${{ secrets.LINGODOTDEV_API_KEY }}
          pull-request: true
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

PRベースのワークフローでは、Settings > Actions > General > Allow GitHub Actions to create and approve pull requests を有効にしてください。

feature branch にコミット#

yaml

name: Translate
on:
  push:
    branches-ignore: [main]
permissions:
  contents: write
jobs:
  translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Lingo.dev
        uses: lingodotdev/lingo.dev@main
        with:
          api-key: ${{ secrets.LINGODOTDEV_API_KEY }}

feature branch からプルリクエストを作成#

yaml

name: Translate
on:
  push:
    branches-ignore: [main]
permissions:
  contents: write
  pull-requests: write
jobs:
  translate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Lingo.dev
        uses: lingodotdev/lingo.dev@main
        with:
          api-key: ${{ secrets.LINGODOTDEV_API_KEY }}
          pull-request: true
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

利用可能な入力#

入力	デフォルト	説明
`api-key`	必須	Lingo.dev APIキー
`pull-request`	`false`	直接コミットする代わりにプルリクエストを作成
`commit-message`	`feat: update translations via @LingoDotDev`	カスタムコミットメッセージ
`pull-request-title`	`feat: update translations via @LingoDotDev`	カスタムPRタイトル
`commit-author-name`	`Lingo.dev`	Gitコミットの作成者名
`commit-author-email`	`support@lingo.dev`	Gitコミットの作成者メールアドレス
`working-directory`	`.`	モノレポ向けの作業ディレクトリ
`process-own-commits`	`false`	このアクションが作成したコミットも処理
`parallel`	`false`	並列モードで実行
`version`	`latest`	Lingo.dev CLIのバージョン

次のステップ#

GitHub App

マネージド運用の代替手段。runner、secret、lockfileは不要

高度なパターン

翻訳チェック、マージコンフリクト、ワークフローの選択

GitLab CI/CD

GitLab CI/CD連携を設定

Bitbucket Pipelines

Bitbucket Pipelines連携を設定