GitHub Actions

Use GitHub Actions when you want a repository to translate changed documentation automatically and open a pull request with the generated outputs.

Most repositories should use the standard GITHUB_TOKEN setup. Use the GitHub App setup only when your organization restricts the default token permissions or requires app-based authentication.

Preduvjeti

Prije stvaranja workflowa, konfigurirajte tajne AI servisa koje vaš prijevodni proces zahtijeva.

Text translation requires one language model provider:

• Azure OpenAI: AZURE_OPENAI_API_KEY, AZURE_OPENAI_ENDPOINT, AZURE_OPENAI_MODEL_NAME, AZURE_OPENAI_CHAT_DEPLOYMENT_NAME, AZURE_OPENAI_API_VERSION
• OpenAI: OPENAI_API_KEY, OPENAI_CHAT_MODEL_ID, plus optional OPENAI_ORG_ID and OPENAI_BASE_URL

Image translation additionally requires Azure AI Vision:

• AZURE_AI_SERVICE_API_KEY
• AZURE_AI_SERVICE_ENDPOINT

See Konfiguracija and Postavljanje Azure AI for local configuration details.

Standardna postavka

Use this setup for most public and private repositories.

Korak 1: Dodajte tajne repozitorija

In your target repository, open Postavke > Tajne i varijable > Actions, then add the provider secrets your workflow will use.

Korak 2: Omogućite dozvole za workflow

Otvorite Postavke > Actions > Općenito.

Under Dozvole za workflow:

1. Odaberite Dozvole čitanja i pisanja.
2. Omogućite Dopusti GitHub Actions da stvara i odobrava pull requestove.
3. Spremite postavku.

Korak 3: Dodajte workflow

Stvorite .github/workflows/co-op-translator.yml:

name: Co-op Translator

on:
  push:
    branches:
      - main

jobs:
  co-op-translator:
    runs-on: ubuntu-latest

    permissions:
      contents: write
      pull-requests: write

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: "3.10"

      - name: Install Co-op Translator
        run: |
          python -m pip install --upgrade pip
          pip install co-op-translator

      - name: Run Co-op Translator
        env:
          PYTHONIOENCODING: utf-8
          AZURE_AI_SERVICE_API_KEY: ${{ secrets.AZURE_AI_SERVICE_API_KEY }}
          AZURE_AI_SERVICE_ENDPOINT: ${{ secrets.AZURE_AI_SERVICE_ENDPOINT }}
          AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}
          AZURE_OPENAI_ENDPOINT: ${{ secrets.AZURE_OPENAI_ENDPOINT }}
          AZURE_OPENAI_MODEL_NAME: ${{ secrets.AZURE_OPENAI_MODEL_NAME }}
          AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: ${{ secrets.AZURE_OPENAI_CHAT_DEPLOYMENT_NAME }}
          AZURE_OPENAI_API_VERSION: ${{ secrets.AZURE_OPENAI_API_VERSION }}
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
          OPENAI_ORG_ID: ${{ secrets.OPENAI_ORG_ID }}
          OPENAI_CHAT_MODEL_ID: ${{ secrets.OPENAI_CHAT_MODEL_ID }}
          OPENAI_BASE_URL: ${{ secrets.OPENAI_BASE_URL }}
        run: |
          translate -l "es fr de" -y

      - name: Create Pull Request with translations
        uses: peter-evans/create-pull-request@v5
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          commit-message: "Update translations via Co-op Translator"
          title: "Update translations via Co-op Translator"
          body: |
            This PR updates translations for recent changes to the main branch.

            Generated by Co-op Translator.
          branch: update-translations
          base: main
          labels: translation, automated-pr
          delete-branch: true
          add-paths: |
            translations/
            translated_images/

Change translate -l "es fr de" -y to the target languages and content flags your project needs. For large repositories, add a paths: filter under on: so the workflow only runs when documentation changes.

Postavljanje GitHub App-a

Use this setup when GITHUB_TOKEN cannot create commits or pull requests in your organization.

Korak 1: Kreirajte ili instalirajte GitHub App

Kreirajte GitHub App s pristupom za čitanje/pisanje na Sadržaj i Pull requests, ili instalirajte aplikaciju koju je organizacija osigurala ako vaša organizacija već ima jednu.

Zabilježite:

• App ID
• Sadržaj privatnog ključa

Spremite ih kao tajne repozitorija:

• GH_APP_ID
• GH_APP_PRIVATE_KEY

Korak 2: Generirajte App token

Koristite isti workflow kao u standardnoj postavci, ali dodajte korak app-token prije koraka za pull request:

      - name: Authenticate GitHub App
        id: generate_token
        uses: tibdex/github-app-token@v1
        with:
          app_id: ${{ secrets.GH_APP_ID }}
          private_key: ${{ secrets.GH_APP_PRIVATE_KEY }}

      - name: Create Pull Request with translations
        uses: peter-evans/create-pull-request@v5
        with:
          token: ${{ steps.generate_token.outputs.token }}
          commit-message: "Update translations via Co-op Translator"
          title: "Update translations via Co-op Translator"
          branch: update-translations
          base: main
          delete-branch: true
          add-paths: |
            translations/
            translated_images/

Ograničenja runnera

GitHub-hosted runneri imaju maksimalno trajanje zadatka. Veliki repozitoriji ili mnogi ciljni jezici mogu premašiti to ograničenje.

For large translation workloads:

• Prevodite manji broj jezika po pokretanju.
• Koristite zastavice sadržaja kao što su -md, -nb, ili -img.
• Koristite self-hosted runner kada veličina repozitorija ili latencija modela čine hosted runnere nepouzdanim.

Pregled u CI

Use co-op-review when a pull request should validate generated translations without calling LLM or Vision providers.

      - name: Review translated outputs
        run: |
          co-op-review --changed-from "origin/${{ github.base_ref }}" --format github

co-op-review je beta deterministička naredba za pregled. Njene provjere i shema izlaza mogu se mijenjati, ali je dizajnirana da bude sigurna za CI jer ne zapisuje datoteke niti poziva pružatelje modela.