GitHub

Lingo.dev unterstützt zwei Möglichkeiten für Kontinuierliche Lokalisierung auf GitHub: die verwaltete GitHub App oder @lingo.dev/cli in einem GitHub Actions-Job.

GitHub App (empfohlen)#

Die GitHub App ist der einfachste Weg, Kontinuierliche Lokalisierung auf GitHub zu nutzen. Einmal installieren, mit einer Engine verknüpfen, und schon reagiert sie auf jeden Push und Pull Request.

1. Installieren Sie die App über die GitHub App-Seite und gewähren Sie ihr Zugriff auf Ihr Repository.
2. Committen Sie eine .lingo/config.json im Stammverzeichnis des Repositorys, die Ihre Buckets und Sprachen beschreibt, einschließlich der engineId der Engine, die die App verwenden soll. Informationen zum Dateiformat finden Sie unter Konfiguration.
3. Pushen Sie Ihre Änderungen. Die App lokalisiert geänderte Inhalte serverseitig und committet die Ergebnisse zurück (oder öffnet einen Pull Request), damit .lingo/lock.json automatisch aktuell bleibt.

Da die App serverseitig läuft, gibt es keinen Runner, den Sie warten müssen, kein LINGO_API_KEY-Secret, das Sie speichern müssen, und keinen Lockfile-Befehl, den Sie ausführen müssen.

GitHub Actions#

Wenn Sie die Lokalisierung in Ihrer eigenen Pipeline ausführen möchten, installieren Sie die CLI in einem Job und führen Sie lingo push aus. Committen Sie anschließend die Ergebnisse oder öffnen Sie mit Ihren vorhandenen Tools einen Pull Request.

Speichern Sie Ihren API-Schlüssel als Repository-Secret mit dem Namen LINGO_API_KEY (Settings > Secrets and variables > Actions). Die CLI liest ihn aus der Umgebung.

In den aktuellen Branch committen#

Erstelle .github/workflows/localize.yml:

name: Localize
on:
  push:
    branches: [main]
permissions:
  contents: write
jobs:
  localize:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
      - name: Install Lingo.dev CLI
        run: npm install -g @lingo.dev/cli
      - name: Localize
        run: lingo push
        env:
          LINGO_API_KEY: ${{ secrets.LINGO_API_KEY }}
      - name: Commit translations
        run: |
          git config user.name "Lingo.dev"
          git config user.email "support@lingo.dev"
          git add .
          git diff --staged --quiet || git commit -m "feat: update translations"
          git push

Damit werden geänderte Inhalte lokalisiert und die Ergebnisse bei jedem Push direkt in den Branch committet.

Einen Pull Request öffnen#

Wenn Übersetzungen per Prüfung statt per direktem Commit übernommen werden sollen, pushen Sie die Ergebnisse in einen Branch und öffnen Sie einen Pull Request. Dieses Beispiel verwendet die GitHub CLI, die auf GitHub-gehosteten Runnern vorinstalliert ist:

name: Localize
on:
  push:
    branches: [main]
permissions:
  contents: write
  pull-requests: write
jobs:
  localize:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
      - name: Install Lingo.dev CLI
        run: npm install -g @lingo.dev/cli
      - name: Localize
        run: lingo push
        env:
          LINGO_API_KEY: ${{ secrets.LINGO_API_KEY }}
      - name: Open pull request
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          git config user.name "Lingo.dev"
          git config user.email "support@lingo.dev"
          branch="lingo/translations-${{ github.run_id }}"
          git checkout -b "$branch"
          git add .
          git diff --staged --quiet && exit 0
          git commit -m "feat: update translations"
          git push origin "$branch"
          gh pr create --fill --base "${{ github.ref_name }}" --head "$branch"

Derselbe Job funktioniert auch auf Feature-Branches – ändern Sie den Filter on.push.branches (zum Beispiel branches-ignore: [main]), um festzulegen, wo die Lokalisierung ausgeführt wird.

Nächste Schritte#