Рекомендации
Для получения информации об интеграции 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при синхронизации с общедоступным хранилищем) -
Токены с детальной настройкой прав доступа
Требуются следующие разрешения:
-
Содержимое: чтение и запись
-
Запросы на включение (pull requests): чтение и запись
-
-
Убедитесь, что настройки хранилища не требуют подписанных фиксаций.
-
-
Если в GitHub включен единый вход в систему (SSO), его также необходимо активировать для токена доступа.
-
Невозможно защитить ветвь phrase_translations.
Примечание
Из-за постоянных доработок пользовательский интерфейс может быть не совсем таким, как представлено в видео.
После того как файл конфигурации будет размещен, для подключения хранилища выполните следующие действия:
-
На странице прокрутите вниз до и нажмите Настроить.
Откроется страница .
-
Нажмите добавить Синхронизация/GitHub.
Откроется окно настройки .
-
Выбрать проект из выпадающего список.
-
Выбрать метод аутентификация:
-
Если приложение GitHub еще не установлено, нажмите аутентификация. Аутентификация выполняется один раз и может быть повторно использована для нескольких синхронизаций хранилище.
Если приложение GitHub уже установлено, нажмите Управление установкой, чтобы Завершить установку приложения для целевой организация или учетная запись. Доступ к хранилище управляется на уровне организация или учетная запись и не привязан к отдельному пользователь GitHub.
-
Укажите личный <1> с областью действия интерфейс приложений API.
При использовании личного токен доступа, доступ к хранилище зависит от пользователь GitHub, который создал токен.
-
Укажите собственный
Если целевой хранилище требует подтверждено (подписанные) коммиты, следует использовать метод аутентификация через приложение GitHub. Коммиты, отправленные с использованием личного токен доступа, не подписываются, поэтому синхронизация завершается с ошибкой: \"Хранилище требует подтверждено (подписанные) коммиты.\"
-
-
Выбрать из выпадающего список.
-
Выбрать из выпадающего список, чтобы импортировать (push) и экспортировать (pull) из нее. Обычно это основная ветвь.
-
При необходимости укажите имя ветвь для запроса на включение изменений. Если оставить поле пустой, будет создана ветвь со значением по умолчанию .
-
Нажмите Validate Configuration, чтобы убедиться, что настройки аутентификация и файл конфигурации верны.
-
При необходимости Выбрать параметр , чтобы определить, когда новые или обновленные файлы автоматически импортировать в проект.
-
Нажмите «Сохранить».
Проект теперь подключен к выбранному хранилище GitHub и добавлен в список.
-
(Необязательно) Нажмите значок карандаша, чтобы переименовать интеграция.
Убедитесь, что команды push правильно настроены в файле .phrase.yml настройки. Параметры push такие же, как для конечной точки uploads интерфейс приложений API.
Чтобы импортировать файлы:
-
На странице Выбрать проект и нажмите импортировать
.
Файлы языка (определенные как записи оригинала в файле конфигурации) импортируются в проект.
Языковой стандарт по умолчанию должен присутствовать.
Примечание
В случае возникновения проблем при импорте, использовать клиент CLI для локального тестирования файла конфигурации
.phrase.ymlи проверки наличия сообщений об ошибках.При необходимости свяжитесь со службой технической поддержки Phrase и приложите файл конфигурации
.phrase.ymlк запросу в поддержку.
Убедитесь, что команды pull правильно настроены в файле .phrase.yml настройки. Параметры pull (например, параметр include_empty_translations) такие же, как для конечной точки скачивание языковых стандартов интерфейс приложений API.
Чтобы экспортировать файлы:
-
На странице Выбрать проект и нажмите Экспорт
.
Отобразится окно .
-
Укажите целевую ветвь в поле .
Самые последние файлы в хранилище будут экспортированы как новый запрос на включение в желаемую ветвь.
-
После того как файлы будут экспортированы, запрос на включение можно объединить или закрыть в хранилище, а ветвь можно удалить.
Примечание
В случае возникновения проблем при экспорте используйте клиент CLI, чтобы протестировать файл конфигурации .phrase.yml локально и проверить наличие сообщений об ошибках.
При необходимости свяжитесь со службой технической поддержки Phrase и приложите файл конфигурации .phrase.yml к запросу в поддержку.
Синхронизации хранилища хранят историю последних импортов и экспортов для каждого проекта Phrase Strings.
Чтобы просмотреть историю: