Интеграции
    1. Phrase
    2. Phrase Strings
    3. Интеграции

    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.

      • Поддерживает подключение учетной записи Strings к нескольким организациям GitHub. Выберите, какая организация GitHub синхронизируется в конфигурации интеграция. Жесткого ограничения на количество организаций, которые можно подключить, нет.

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

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

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

      • Точно настроенные токены

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

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

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

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

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

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

    Примечание

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

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

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

    1. В главном меню навигации нажмите Автоматизация, затем Синхронизация хранилищ.

      Альтернативно, на странице Интеграции прокрутите вниз до Синхронизация хранилищ и нажмите Настроить.

      Откроется страница Синхронизация хранилищ. В список Синхронизация хранилищ выводятся только проекты, к которым пользователь имеет доступ.

    2. Нажмите Добавить синхронизацию/GitHub.

      Откроется окно настройки Синхронизация GitHub.

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

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

      • GitHub App (рекомендуется)

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

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

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

        Предоставьте личный токен доступа к хранилищу с областью действия интерфейс приложений API.

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

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

        Предоставьте GitHub self-hosted интерфейс приложений API endpoint и личный токен доступа к хранилищу с областью действия интерфейс приложений API.

      Если для целевого хранилища требуются подтверждено (подписанные) коммиты, следует использовать метод аутентификации GitHub App. Коммиты, отправленные с использованием токена личного доступа, не подписаны, поэтому синхронизация завершается со следующей ошибкой: «Хранилище требует подтвержденные (подписанные) коммиты».

    5. Если используется приложение GitHub, выберите Подключенная организация GitHub из раскрывающегося списка. Список хранилищ загружается на основе этого выбора.

    6. Выбрать хранилище GitHub из раскрывающегося списка.

    7. Выбрать ветвь хранилища из раскрывающегося списка для импорта (отправки) и экспорта (получения). Обычно это главная ветвь.

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

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

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

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

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

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

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

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

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

    • На странице Синхронизация хранилищ выберите проект и нажмите Импортировать Sync Import.

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

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

      Примечание

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

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

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

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

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

    1. На странице Синхронизация хранилищ Выбрать проект и нажмите Экспорт Sync Export.

      Отображается окно Экспорт.

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

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

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

    Примечание

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

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

    История

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

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

    • На странице Синхронизация хранилищ Выбрать проект и нажмите История 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.