GitHub Crowdin Action

The GitHub Crowdin Action allows you to easily integrate the localization of your Crowdin Enterprise project into the workflow you’ve set up on your repo with help of GitHub Actions. Using GitHub Crowdin Action, you can automate the synchronization of localization resources with your Crowdin Enterprise project.

With this action you can do the following things:

  • Upload sources to Crowdin Enterprise.
  • Upload translations to Crowdin Enterprise.
  • Download translations from Crowdin Enterprise.

Használat

Állítson be egy munkafolyamatot itt: .github/workflows/crowdin.yml (vagy adjon hozzá egy feladatot a meglévő munkafolyamatokhoz).

Olvassa el a Munkafolyamat konfigurálása cikket az egyedi munkafolyamatok létrehozásának és beállításának részleteiről.

name: Crowdin Action

on:
  push:
    branches: [ master ]

jobs:
  synchronize-with-crowdin:
    runs-on: ubuntu-latest

    steps:

    - name: Checkout
      uses: actions/checkout@v2

    - name: crowdin action
      uses: crowdin/github-action@1.0.4
      with:
        upload_translations: true
        download_translations: true
      env:
        GITHUB_TOKEN: $
        CROWDIN_PROJECT_ID: $
        CROWDIN_PERSONAL_TOKEN: $

Támogatott lehetőségek

Az alapértelmezett művelet az erőforrások feltöltése. A with lehetőséggel azonban különböző műveleteket definiálhat. If you don’t want to upload your sources to Crowdin Enterprise, just set the upload_sources option to false.

Alapértelmezetten a források és a fordítások feltöltésre kerülnek a Crowdin Enterprise projektje gyökérkönyvtárába. Ennek ellenére, ha ágakat használ, meghatározhatja a preferált forráságat.

Megadhatja azt is, hogy a GitHub melyik ágába szeretné letölteni a fordításokat (az alapértelmezett fordítási ág l10n_crowdin_action).

Ha nem akarja letölteni a fordításokat a Crowdinból (download_translations: false), localization_branch_name és create_pull_request opciók szintén nem szükségesek.

- name: crowdin action
  with:
    # upload options
    upload_sources: true
    upload_translations: true

    # download options
    download_translations: true
    language: 'uk'
    push_translations: true

    # This is the name of the git branch that Crowdin Enterprise will create when opening a pull request. 
    # This branch does NOT need to be manually created. It will be created automatically by the action.
    localization_branch_name: l10n_crowdin_action
    create_pull_request: true

    # global options

    # This is the name of the top-level directory that Crowdin Enterprise will use for files.
    # Note that this is not a "branch" in the git sense, but more like a top-level directory in your Crowdin Enterprise project.
    # This branch does NOT need to be manually created. It will be created automatically by the action.
    crowdin_branch_name: l10n_branch
    identity: '/path/to/your/credentials/file'
    config: '/path/to/your/crowdin.yml'
    dryrun_action: true

    # config options

    # This is a project numeric id
    # Open a project and see "Crowdin API" at Resources > Integrations & API
    project_id: $ 

    # This is a personal access token
    # Open a project and see "Crowdin API" at Resources > Integrations & API > Create Token
    token: $
    source: '/path/to/your/file'
    translation: 'file/export/pattern'
    base_url: 'https://crowdin.com'
    base_path: '/project-base-path'

A lehetőségek részletesebb leírása az alábbi linken találja: action.yml.

Crowdin Enterprise konfigurációs fájl

If your workflow file contains the config property, you’ll need to add the following to your Crowdin Enterprise configuration file (e.g. crowdin.yml):

project_id_env: CROWDIN_PROJECT_ID
api_token_env: CROWDIN_PERSONAL_TOKEN

A munkafolyamat végrehajtásakor a token és a projektazonosító tényleges értékei a környezeti titkok felhasználásával beillesztésre kerülnek a konfigurációba.

Hasznos volt ez a cikk?