Bitbucket (Strings)

Content is machine translated from English by Phrase Language AI.

Bitbucket Sync is only supported for Bitbucket Cloud. It cannot be used with Bitbucket Server.
Bitbucket Sync can be used via API.

Prerequisites

The .phrase.yml configuration file must be present in the root of the branch to be monitored. The file defines which files to import (pull) or export (push) from the repository.
Read and write access are required for the repository.
Incorrectly defined configuration files may cause errors. Ensure that the file contains at least one push and one pull target, correct file formats and the correct setting of the update_translations parameter.

Sample configuration file:

phraseapp:
    project_id: 1f61b9ecdb7a17a9dd174302419c50cc
    file_format: simple_json
    push:
        sources:
            - file: ./<locale_name>.json
    pull:
        targets:
            - file: ./<locale_name>.json

Project ID of a project is found in project settings.

Connect Repositories

Once the configuration file is in place, to connect a repository, follow these steps:

From the Integrations page, scroll down to the Bitbucket Sync connector and click Activate.

The Bitbucket Sync activation page opens.
Select the Bitbucket account to be connected from the Authorize for workspace dropdown list and click on Grant access.

The connection between Phrase Strings and the selected Bitbucket account is established.

Note

It is not possible to connect multiple accounts via the Bitbucket integration.
Click Connect repository.

The Connect repository window opens.
Select a repository from the dropdown list and click Save.

The repository is added to list of connected repositories and an access token is automatically created.

If repository ownership is not correct, the repository will not be visible in the dropdown list.

Integrations can be deactivated or removed from the Integrations page. To remove a Bitbucket integration, follow these steps:

If removing an integration set up by another user, delete the user profile who set up the connection in Phrase Strings.
Access Bitbucket with Admin rights and completely remove the integration.
Log into Phrase Strings and set up the integration again.

Import to Bitbucket

After activating Bitbucket Sync and connecting a repository, local files can be imported. This is done in the form of pull requests so changes can be reviewed and branch management can be controlled.

To import local files to BitBucket, follow these steps:

From the Bitbucket account, select a repository for synchronization.
Select a branch of the repository and from the context menu, select Import from Phrase.

Translations are pulled into the repository.
Approve, merge or close the pull request in Bitbucket.

Export from Bitbucket

To export locale files from Bitbucket, follow these steps:

From the Bitbucket account, select a repository to be synchronized.
Select a branch of the repository and from the context menu, click Export to Phrase.

Translations are pushed into the project. Keys and current translations are updated.
Click on an upload in the list or from Uploads in the project to see a detailed upload summary.

Successful uploads are indicated with a green icon and failed uploads are indicated with a red icon.