gitloc.yaml

You can download the minimal gitloc.yaml here:

gitloc.yaml file sample:

config:
  defaultLocale: en
  locales:
    - en
    - es
    - fr
  directories:
    - public/locales
  branches:
    - feature/*
    - development
  result: push
  format: 2
  modes:
   - autocorrection

defaultLocale

required

The setting indicates base locale, which values will be translated. Gitloc detects changes only in the localization files for the default locale. Supported values for this setting depend on used translation engine and can be found in the Supported Languages document.

locales

required

The setting contains the list of all locales that your application support. Supported values for this setting depend on used translation engine and can be found in the Supported Languages document.

locales setting must include default locale value as well.

directories

required

The setting contains the list of the folders in your repository which contain the localization files.

Do not use the "/" symbol at the beginning of the directory name.

branches

optional

The setting indicates which Git branches should be processed. You can use glob patterns for branch names.

result

optional, default value is push

The setting indicates how Gitloc has to process results of translation.

Supported values:

push - Gitloc will commit translation to the same branch which were used for processing (source branch)

pull-request - Gitloc will create a new branch, commit translation to the new branch and create a pull request to the source branch

modes

optional

The setting contains the list of the used modes for Gitloc processing. All available modes you can find in the Modes document.

format

optional, default value is 2

The setting indicates how the final JSON file will be formatted. You can use either the "tab" keyword or specify the number of spaces for formatting.

Supported values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, tab

Last updated