Интеграции

GitHub (Strings)

Контент автоматически переведен с английского языка с помощью Phrase Language AI.

Рекомендации

Для получения информации об интеграция 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 организация или учетная запись, которой принадлежит хранилище.

    • Хранилище должно быть включено в установку OAuth App.

    • Для целевой организация или учетная запись требуются разрешения на установку или авторизацию GitHub Apps.

  • GitHub получить доступ токен:

    • Классические токены

      Требуется область repo (public_repo при синхронизации с общедоступным хранилище)

    • Точные токены

      Требуются следующие разрешения:

      • Содержимое: Чтение и запись

      • Запросы на включение: Чтение и запись

    • Убедитесь, что настройки хранилища не требуют подписанных фиксаций.

  • Если в GitHub включен единый вход в систему (SSO), его также необходимо активировать для токена доступа.

  • Невозможно защитить ветвь phrase_translations.

Примечание

Из-за постоянных доработок пользовательский интерфейс может быть не совсем таким, как представлено в видео.

Подключить хранилища

Как только файл конфигурации будет на месте, чтобы подключить хранилище, выполните следующие действия:

  1. На странице Integrations прокрутите вниз до Repo Sync и нажмите Configure.

    Откроется страница Repo Syncs.

  2. Нажмите Add Sync/GitHub.

    Откроется окно настройки GitHub sync.

  3. Выбрать проект из выпадающего список.

  4. Выбрать метод аутентификация:

    • GitHub App (recommended)

      Если приложение GitHub App еще не установлено, нажмите Authenticate. Аутентификация выполняется один раз и может быть повторно использована для нескольких синхронизаций хранилище.

      Если приложение GitHub App уже установлено, нажмите Manage installation, чтобы Завершить установку приложения для целевой организации или учетной записи. Доступ к хранилищу управляется на уровне организации или учетной записи и не привязан к отдельному пользователю GitHub.

    • Личный токен доступа

      Укажите личный Repo access token с областью действия интерфейс приложений API.

      При использовании личного токен доступа к хранилищу зависит от пользователя GitHub, который создал токен.

    • Самостоятельная точка

      Укажите GitHub self-hosted API endpoint и личный Repo access token с областью действия интерфейс приложений API.

  5. Выбрать GitHub repository из выпадающего список.

  6. Выбрать Repository branch из выпадающего список, чтобы импортировать (push) и экспортировать (pull) из нее. Обычно это основная ветвь.

  7. При необходимости укажите имя ветвь для запроса на включение изменений. Если оставить поле пустой, будет создана ветвь со значением по умолчанию phrase-translations.

  8. Нажмите Validate Configuration, чтобы убедиться, что настройки аутентификация и файл конфигурации верны.

  9. При необходимости Выбрать параметр импортировать behavior, чтобы определить, когда новые или обновленные файлы будут автоматически импортированы в проект.

  10. Нажмите «Сохранить».

    Проект теперь подключен к выбранному хранилище GitHub и добавлен в список.

  11. (Необязательно) Нажмите значок карандаша, чтобы переименовать интеграция.

Импортировать файлы

Убедитесь, что команды push правильно настроены в файле конфигурации .phrase.yml. Параметры push такие же, как для конечной точки uploads интерфейс приложений API.

Чтобы импортировать файлы:

  • На странице Repo Syncs Выбрать проект и нажать импортировать Sync Import.

    Файлы язык (определенные как записи оригинал push в файле конфигурации) импортируются в проект.

    Языковой стандарт по умолчанию должен присутствовать.

    Примечание

    В случае возникновения проблем при импортировании, использовать клиент CLI для локального тестирования файла конфигурации .phrase.yml и проверки наличия сообщений об ошибках.

    При необходимости свяжитесь со службой технической поддержки Phrase и приложите файл конфигурации .phrase.yml к запросу в службу поддержки.

Экспорт файлов

Убедитесь, что команды push правильно настроены в файле конфигурации .phrase.yml. Параметры pull (например, параметр include_empty_translations) такие же, как для конечной точки скачивание языковой стандарт интерфейс приложений API.

Чтобы экспортировать файлы:

  1. На странице Repo Syncs Выбрать проект и нажать Экспорт Sync Export.

    Отобразится окно Экспорт.

  2. Укажите ветвь перевода в поле PR branch.

    Самые последние файлы в хранилище будут экспортированы в виде нового запроса на включение изменений (pull request) в желаемую ветвь.

  3. После того как файлы будут экспортированы, pull request можно объединить или закрыть в хранилище, а ветвь можно удалить.

Примечание

В случае возникновения проблем при экспорте используйте клиент CLI для локального тестирования файла конфигурации .phrase.yml и проверки наличия сообщений об ошибках.

При необходимости свяжитесь со службой технической поддержки Phrase и приложите файл конфигурации .phrase.yml к запросу в службу поддержки.

История

Синхронизации хранилища сохраняют историю последних импортов и экспортов для каждого проекта Phrase Strings.

Чтобы просмотреть историю:

  • На странице Repo Syncs Выбрать проект и нажмите History Sync History.

    Отображается история импорта и экспорта для проекта. Записи экспорта в истории включают ссылку на соответствующий запрос на объединение.

Была ли эта статья полезной?

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.