Use this app to exchange files with your Bitbucket repository.
As soon as the app is set up, you can pull the files by using the Lokalise web dashboard. There will also be an incoming webhook set up, which you may use to automatically pull the files as they are pushed to Bitbucket by your developer team.
Once the translations are done, you can trigger the creation of a pull request when exporting.
1. Connect your repository
Open your project and proceed to Apps.
Open Bitbucket and click Install. Next, click Connect to authenticate via OAuth2.
After successfully authorizing, you can enter your Repository and Branch to pull from.
You must specify the platform of the files stored in this repo. As you export files from Lokalise you can trigger the Bitbucket app to create pull requests to repositories with a platform related to the exported file format.
It is important to decide whether you would like the filenames to include a full path. It is not needed in most cases as you can configure the directory structure prefix in the pull request creation (export) step. However, when you have similar files in different subfolders, e.g. admin/locale.json and frontend/locale.json, you need to enable the Include path option in the filenames option. Keep in mind that if you already have files uploaded to the project, including a path in the filenames at this step would mean that you are uploading different files.
2. Select files to pull
Browse the selected repository and select the files you want to pull and import.
In most cases, in this step you will only need to select the base language files (the files that are being modified locally and then pushed to Bitbucket). After selecting a file, you must set the language of the file from the dropdown menu.
3. Add more repositories
As we recommend keeping all platform files within the same project, you may want to set up other repositories that apply to the same project. Click Add another repo to add more repositories.
Use the Pull now button on the app page. Clicking the button will add the pull to the system queue to be executed in the background.
If you need to adjust the options, click Pull options on the app page:
These options are similar to the ones presented on the Upload page.
When you are satisfied with the initial pull results, it is a good idea to set up a webhook in Bitbucket which automates pulling the changes to Lokalise as you push to Bitbucket.
In Bitbucket, navigate to Repository settings > Webhooks:
Click Add webhook, give it a name and and copy/paste the Auto-pull URL provided in the Lokalise app configuration into the URL text field:
As the translations are being completed, via download page Lokalise can create the pull requests with the exported files, which you can then merge to a selected branch.
In order to create a pull request, you need to perform a project export with the Bitbucket trigger enabled. It is a good idea to use the Preview button first, so you can see the resulting file/folder structure before triggering the creation of a pull request.
We would recommend only triggering pull requests only to the repos of the platform that match the file type you are exporting, i.e. if you are exporting in a JSON format, Lokalise will only create pull requests in repositories with the Web platform.
To actually create a pull request on Bitbucket, you should press Build only (this way you won't download a translations bundle to your local PC). To check the status of the pull request creation, return to the Bitbucket app page and click the Logs button.
Here is what happens as you trigger a new PR:
A new branch is created from the last revision of the branch you chose in the app setup. The branch name will look like this: lokalise-2018-03-12_15-14-13.
A commit with all the files is created in the new branch.
A pull request from the new branch to the previously chosen branch is created.
You may then review and merge a pull request in Bitbucket.
To initiate a pull request from the API, use the
triggers=['bitbucket'] parameter with the /export endpoint. If you are using the CLI tool, use
--triggers=bitbucket as a parameter when performing the export.