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. -
A GitHub access token for the scope of the repository (
public_repo
if synchronizing with a public repository). -
If SSO is enabled in GitHub, it must also be enabled for the access token.
-
The phrase_translations branch cannot be protected.
-
Ensure repository settings do not require signed commits.
Note
Due to continuous improvements, the user interface may not be exactly the same as presented in the video.
Once the configuration file is in place, to connect a repository, follow these steps:
-
From GitHub Sync tab.
, select the -
Enable Github Sync.
GitHub Sync settings are presented.
-
Optionally select GitHub Enterprise and provide the .
-
Provide a GitHub
. -
Select a
from the dropdown list. -
Select a
from the dropdown list to import (push) and export (pull) from. This is usually the main branch. -
Click Validate Configuration to ensure access token and configuration file are correct.
-
Optionally
to import files with every commit to the selected GitHub branch.Generate a payload URL and set up a webhook for push events from GitHub.
-
Click Save.
The project is now connected to the selected GitHub repository.
To import files:
-
From the GitHub Sync select .
page of a project, clickA default locale must be present.
Language files (defined as push source entries in the configuration file) are imported into the project. Import progress can be monitored in the project activity stream.
Note
In case of issues upon importing, 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.
To export files:
-
From the GitHub Sync select .
page of a project, clickThe most recent language files are exported to the repository as a new pull request. Export progress can be monitored in the project activity stream.
Note
In case of issues upon 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. -
Once files are exported, the pull request can be merged or closed in the repository and the branch can be deleted.