How It Works
The integration with Bitbucket allows you to synchronize repository files directly with the Bureau Works platform. With this connection, you can submit files for translation and receive translated content automatically via Pull Request.
The general workflow is as follows:
Create a Bitbucket Connector Configuration in the Bureau Works platform.
Authenticate via API Token with Bitbucket.
Define repository details (workspace, repository, branch, folder, and files).
Send the selected files to the platform for translation.
Receive the translated files via an automatically created Pull Request in a new branch.
Creating a Connector Configuration
To get started, navigate to the Bitbucket connector and click “Add Configuration”.
Fill out the following fields:
Field | Description |
1 - Type | Select Bitbucket. |
2 - Name | An internal name to identify the configuration. |
3 - Email | The email associated with your Bitbucket account. |
4 - API Token | Access token generated at https://id.atlassian.com/manage-profile/security/api-tokens. This token must be created before setting up the configuration in Bureau Works. |
5 - Language Mapping | Map Bitbucket languages to Bureau Works. Use source=destination format, where the first value is the repo language and the second is in BW. Separate mappings with semicolons (;). Example: en-us=en;cs=cs_cz. |
Click Save to store the configuration.
Configurations:
API Token
The API Token is a secure authentication method that replaces the account password for API calls. It allows the system to access the repository on behalf of the user with controlled permissions.
How to Create and Configure a Bitbucket API Token
Click Create API Token with Scopes.
Set a name and select an expiration date (up to 1 year).
Select the Bitbucket application.
Assign the required permissions, for example:
repository:bitbucket → Read, Write
pullrequests:bitbucket → Read, Write
workspace:bitbucket → Read, Write
project:bitbucket → Read, Write
permissions:bitbucket → Read, Write
user:bitbucket → Read, Write
Click Create to generate the token.
Name step.
Choice of provider.
In Scope Actions select read and write and define the permissions.
Validate the permissions and finish by clicking in Create Token.
Repository Configuration
Once your account is connected, configure the repository parameters for synchronization:
Organizational Unit: Select a unit within the organization.
Contact Person: This person will receive project notifications.
Project Reference: Reference name for this new project.
Source Language: Base language to be translated.
Target Language: Target language in which the translation was made.
Workflows: Necessary steps for your translation (e.g TRANSLATION, REVIEW).
Workspace: Your Bitbucket workspace name (available in the repository URL).
Repository: The repository name.
Branch: The main branch where the files are located (e.g.,
main).Folder Path (optional): Subfolder where the files are stored (e.g.,
src/).Files (optional): A list of specific files to synchronize (e.g.,
README.md,terms.json).
If no files are specified, all text files located in the folder will be included.
Example Values
Parameter | Example Value |
Workspace |
|
Repository |
|
Branch |
|
Folder Path |
|
Files |
|
Click New Sync.
Define your configuration setup based on the information above and finish by clicking Sync to create the project.
Delivery Mechanism
After the translation process in Bureau Works:
A new branch is created in the repository (e.g.,
bw-translated-<timestamp>).Translated files are committed to the same paths as the original files.
A Pull Request (PR) is automatically opened against the main branch.
Important: Each file name must include its extension (e.g., test.json). Using a file name without an extension (e.g., test) will prevent the synchronization from working correctly.
Translations can be reviewed directly in the PR and approved following the standard Bitbucket workflow.
Duplicate File Handling
The system may skip files during synchronization if:
The file name is identical (e.g.,
README.md).The file content is identical (same hash).
The source and target languages are the same.
This behavior prevents duplicate entries and unnecessary reprocessing.
If you need a new processing cycle for the same file, you can manually force a new synchronization by clicking in Force Entry Creation.
