Prerequisites
-
The
.phrase.yml
configuration file must be present in the repository. 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.
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 to be used for the webhook.
-
Click Save.
The project is now connected to the selected GitHub repository.
To import files:
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.
-
Once files are exported, the pull request can be merged or closed in the repository and the branch can be deleted.