GitLab (Strings)

Content is machine translated from English by Phrase Language AI.

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.

Connect Repositories

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

From the Integrations page, scroll down to Repo Sync and click Configure.

The Repo Syncs page opens.
Click Add Sync/GitLab.

The GitLab sync settings window opens.
Select a project from the dropdown list.
Optionally select Self-hosted instance and provide the GitLab self-hosted API endpoint.
Provide a personal project access token with an API scope.
Select a GitLab repository from the dropdown list.
Select a Repository branch 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 Auto import to import files with every commit to the selected GitLab branch.

Provide a URL for the webhook and the Secret token copied from Strings.
Click Save.

The project is now connected to the selected GitLab repository and added to the list.

Import and Export Files

To import files:

From the Repo Syncs page, select a project and click Import .

GitLab data is imported into the selected project.

To export files, follow these steps:

From the Repo Syncs page, select a project and click Export .

The Export window is displayed.
Provide the target branch in the PR branch field.

The most recent files in the repository will be exported as a new pull request to the desired branch.
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.

History

Repo syncs keep a history of the latest imports and exports for each Phrase Strings project.

To view the history:

From the Repo Syncs page, select a project and click History .

The import and export history for the project is presented. Export entries in the history include a link to the corresponding merge request.