Skip to content

docs: better documentation for the branch option #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
andrii-bodnar merged 1 commit into from
Feb 10, 2025
Merged

docs: better documentation for the branch option #146

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,10 @@ files:

Use `preserve_hierarchy` if your project contains multiple modules that you want to localize with the same source file names.

> **Note:**
> [!WARNING]
> Both `source` and `translation` keys should be specified.

> **Note:**
> [!NOTE]
> If `preserve_hierarchy` is set to `true`, the plugin will add the path to your translation pattern.
>
> ```yml
Expand All @@ -139,6 +139,19 @@ Use `preserve_hierarchy` if your project contains multiple modules that you want

#### Additional properties

##### Branch

If you are using the branching functionality in Crowdin, you can specify the branch name in the configuration file:

```yml
branch: main
```

Alternatively, you can enable the [Use Git Branch](#use-git-branch) option in the plugin settings to use the local git branch name as the Crowdin branch name.

> [!WARNING]
> For **string-based** projects, the branch name must be specified either in the configuration file or in the plugin settings.

##### File properties

To attach labels to the uploaded strings, use `labels`:
Expand Down Expand Up @@ -201,10 +214,10 @@ translate_hidden: true

See the [Placeholders](https://support.crowdin.com/configuration-file/#placeholders) article to put appropriate variables.

> **Note:**
> [!TIP]
> `%android_code%` placeholder means a format such as `'fr-rCA'` ([<ISO 639-1>](http://www.loc.gov/standards/iso639-2/php/code_list.php) -r[<ISO 3166-1-alpha-2>](https://www.iso.org/obp/ui/#iso:pub:PUB500001:en)). When applying format with only two-letter language code such as `'fr'`([<ISO 639-1>](http://www.loc.gov/standards/iso639-2/php/code_list.php)) format, use `%two_letters_code%` placeholder.

> **Note:**
> [!WARNING]
> Currently, the `%original_path%` placeholder is not supported.

### Plugin settings
Expand All @@ -226,7 +239,8 @@ You can also set a specific branch name to work with by using the `branch` optio

If you are not using branching, make sure the `Use Git Branch` option is disabled and `branch` is not defined in the `crowdin.yml` file.

Note that a **branch is required for string-based** projects.
> [!WARNING]
> For **string-based** projects, the branch name must be specified either in the configuration file or in the plugin settings.

#### Automatic uploads

Expand Down