Рекомендации
Для получения информации об интеграция GitHub в Phrase TMS, обратитесь к GitHub (TMS).
Phrase Strings интегрируется с хранилище GitHub для синхронизации файлов локализации между Phrase и GitHub.
По умолчанию хранилища подключаются с помощью GitHub OAuth App. Личные получить доступ токены также поддерживаются и в основном предназначены для локально размещенных экземпляров или сред, где установка OAuth App невозможна.
Предварительные требования
-
Файл конфигурации
.phrase.ymlдолжен присутствовать в корне ветвь, которую необходимо отслеживать. Файл определяет, какие файлы импортировать (отправка) или экспортировать (извлечение) из хранилища. -
Для хранилища необходимо получить доступ для чтения и записи.
-
Неверно заданные файлы конфигурации могут вызвать ошибки. Убедитесь, что файл содержит хотя бы одну цель для отправки и одну для извлечения, правильные форматы файлов и правильную настройку параметра
Update_translations. -
-
GitHub OAuth App должен быть установлен в GitHub организация или учетная запись, которой принадлежит хранилище.
-
Хранилище должно быть включено в установку OAuth App.
-
Для целевой организация или учетная запись требуются разрешения на установку или авторизацию GitHub Apps.
-
-
-
Классические токены
Требуется область repo (
public_repoпри синхронизации с общедоступным хранилище) -
Точные токены
Требуются следующие разрешения:
-
Содержимое: Чтение и запись
-
Запросы на включение: Чтение и запись
-
-
Убедитесь, что настройки хранилища не требуют подписанных фиксаций.
-
-
Если в GitHub включен единый вход в систему (SSO), его также необходимо активировать для токена доступа.
-
Невозможно защитить ветвь phrase_translations.
Примечание
Из-за постоянных доработок пользовательский интерфейс может быть не совсем таким, как представлено в видео.
Как только файл конфигурации будет на месте, чтобы подключить хранилище, выполните следующие действия:
-
На странице прокрутите вниз до и нажмите Configure.
Откроется страница .
-
Нажмите Add Sync/GitHub.
Откроется окно настройки .
-
Выбрать проект из выпадающего список.
-
Выбрать метод аутентификация:
-
Если приложение GitHub App еще не установлено, нажмите Authenticate. Аутентификация выполняется один раз и может быть повторно использована для нескольких синхронизаций хранилище.
Если приложение GitHub App уже установлено, нажмите Manage installation, чтобы Завершить установку приложения для целевой организации или учетной записи. Доступ к хранилищу управляется на уровне организации или учетной записи и не привязан к отдельному пользователю GitHub.
-
Укажите личный с областью действия интерфейс приложений API.
При использовании личного токен доступа к хранилищу зависит от пользователя GitHub, который создал токен.
-
Укажите GitHub self-hosted и личный с областью действия интерфейс приложений API.
-
-
Выбрать из выпадающего список.
-
Выбрать из выпадающего список, чтобы импортировать (push) и экспортировать (pull) из нее. Обычно это основная ветвь.
-
При необходимости укажите имя ветвь для запроса на включение изменений. Если оставить поле пустой, будет создана ветвь со значением по умолчанию .
-
Нажмите Validate Configuration, чтобы убедиться, что настройки аутентификация и файл конфигурации верны.
-
При необходимости Выбрать параметр , чтобы определить, когда новые или обновленные файлы будут автоматически импортированы в проект.
-
Нажмите «Сохранить».
Проект теперь подключен к выбранному хранилище GitHub и добавлен в список.
-
(Необязательно) Нажмите значок карандаша, чтобы переименовать интеграция.
Убедитесь, что команды push правильно настроены в файле конфигурации .phrase.yml. Параметры push такие же, как для конечной точки uploads интерфейс приложений API.
Чтобы импортировать файлы:
-
На странице Выбрать проект и нажать импортировать
.
Файлы язык (определенные как записи оригинал push в файле конфигурации) импортируются в проект.
Языковой стандарт по умолчанию должен присутствовать.
Примечание
В случае возникновения проблем при импортировании, использовать клиент CLI для локального тестирования файла конфигурации
.phrase.ymlи проверки наличия сообщений об ошибках.При необходимости свяжитесь со службой технической поддержки Phrase и приложите файл конфигурации
.phrase.ymlк запросу в службу поддержки.
Убедитесь, что команды push правильно настроены в файле конфигурации .phrase.yml. Параметры pull (например, параметр include_empty_translations) такие же, как для конечной точки скачивание языковой стандарт интерфейс приложений API.
Чтобы экспортировать файлы:
-
На странице Выбрать проект и нажать Экспорт
.
Отобразится окно .
-
Укажите ветвь перевода в поле .
Самые последние файлы в хранилище будут экспортированы в виде нового запроса на включение изменений (pull request) в желаемую ветвь.
-
После того как файлы будут экспортированы, pull request можно объединить или закрыть в хранилище, а ветвь можно удалить.
Примечание
В случае возникновения проблем при экспорте используйте клиент CLI для локального тестирования файла конфигурации .phrase.yml и проверки наличия сообщений об ошибках.
При необходимости свяжитесь со службой технической поддержки Phrase и приложите файл конфигурации .phrase.yml к запросу в службу поддержки.
Синхронизации хранилища сохраняют историю последних импортов и экспортов для каждого проекта Phrase Strings.
Чтобы просмотреть историю: