Tip
For information about GitLab integration in Phrase TMS, refer to GitLab (TMS).
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. -
Use GitLab 9.5 or newer to ensure API compatibility.
Once the configuration file is in place, to connect a repository, follow these steps:
-
From the Configure.
page, scroll down to the connector and clickThe
page opens. -
Click Add Sync/GitLab.
The
settings window opens. -
Select a project from the dropdown list.
-
Optionally select
and provide the GitLab self-hosted . -
Select a
from the dropdown list. -
Select a
from the dropdown list to import (push) and export (pull) from. This is usually the master branch. -
Click Validate Configuration to ensure access token and configuration file are correct.
-
Optionally select
to import files with every commit to the selected GitLab branch.Provide a webhook and the copied from Strings.
for the -
Click Save.
The project is now connected to the selected GitLab repository and added to the list.
To import files:
-
From the Import
page, select a project and click.
GitLab data is imported into the selected project.
To export files, follow these steps:
-
From the Export
page, select a project and click.
The most recent files in the repository are exported as a new pull request.
-
Once files are exported, the pull request can be merged or closed in the repository and the branch can be deleted.
Note
In case of issues upon importing or exporting, use the CLI client to test the .phrase.yml
configuration file locally and check for any error messages.
If required, contact Phrase Technical Support and attach the .phrase.yml
configuration file to the support request.
Repo syncs keep a history of the latest imports and exports for each Phrase Strings project.
To view the history: