Разъем GitHub

Обзор

Эта страница иллюстрирует, как разъем GitHub способен отслеживать и создавать проекты на основе изменений, которые происходят в наборе репозиториев GitHub.

Общая цель

GitHub Connector отслеживает определенные файлы в репозиториях GitHub, учитывая определенный промежуток времени. Обычно в проектах локализации общими файлами являются JSON, YML, XLIFF, XML, STRINGS или любой другой структурированный и предсказуемый формат. Сравнивая хэш файла с репозиторием ранее выполненных переводов для того же файла, если будет обнаружено изменение, будет создан новый проект и начнутся проекты перевода.

Стратегии мониторинга

Мы можем контролировать репозитории GitHub с помощью API REST. Для этого нашим клиентам необходимо разрешить учетную запись для создания токена в Bureau Works для доступа к API. Эти учетные данные шифруются с AES 256 и хранятся в профиле Клиента.

Существует две стратегии мониторинга: ветви и запросы натянуть.

Ветви

Коннектор будет постоянно контролировать одну или несколько ветвей в одном или нескольких репозиториях, и как только файлы наблюдаются изменены, он создаст проект в Бюро работ и уведомить нашу команду. В проектах непрерывной локализации все ранее переведенные строки полностью учитываются.

Как только проект будет доставлен, разъем GitHub создаст Pull Request для ветви патча, содержащей файл (ы) после завершения перевода. Мы можем настроить путь вывода и назвать стратегии для выходных файлов. Это создает ненавязчивый и очень элегантный механизм доставки, когда команда, как правило, использует одну или несколько ветвей для развития.

Запросы на вытягивать

Так же, как и стратегия Филиала, мы также можем отслеживать запросы Pull для команд, использующих Gitflow или аналогичные рабочие процессы. Коннектор может отслеживать все запросы тянуть, для всех ветвей, для тех же настроенных файлов. Опять же, как только разница найдена на основе хэша файла, будет создан проект.

Большая разница в этой стратегии заключается в механизме доставки. Поскольку запросы на тянуть относятся к ветке, как только проект будет доставлен, Коннектор создаст коммит в той же ветви, что и запрос на тянуть. После того, как запрос на притяжение будет принят и объединен, он будет нести по переведенным файлам (ы) на целевую ветвь, т.е. мастер, развиваться и т.д.

Авторизовать работу Бюро

Для настройки разъема GitHub, первое, что вам нужно сделать, это разрешить Бюро работ для доступа к вашим репозиториям. В качестве дополнительного уровня безопасности мы рекомендуем создать пользователя, который будет иметь эксклюзивный доступ к репозиториям, представляющим интерес в вашей организации.

Если вы не видите рабочий процесс авторизации GitHub, возможно, к вашей учетной записи не применяются соответствующие роли. Пожалуйста, свяжитесь с вашим контактом организации, или если это человек вы, пожалуйста, пришлите нам по электронной почте [email protected].

1. Откройте мой счет в правом верхнем углу вашего представления Бюро работ.

2. На верхней плане выберите Connect GitHub

3. Войди в GitHub, используя учетную запись, которую вы хотите подключить к Bureau Works.

4. GitHub отправит вас обратно в Bureau Works и покажет сообщение, если проверка подлинности будет успешной.

Обеспечение путей мониторинга и доставки

Как только вы авторизируете работу Бюро, вам необходимо предоставить нам пути файлов (ы) и репозиториев, которые нуждаются в мониторинге. Например, в проектах iOS обычно в каждой папке языка развернут файл под названием Localizable.strings, например:

en.lproj/Localizable.strings - Источник
pt-BR.lproj/Localizable.strings - Цель
A de.lproj/Localizable.strings - Target B
...

Мы должны определить, какой из них является исходным файлом, и каковы желаемые пути для доставки переводов. Каждая доставка, выполняемая разъемом GitHub, в зависимости от выбранной стратегии, поместит файлы в правильную структуру папок в репозиторий GitHub.

Этот шаг выполняется нашей командой, и управляется через нашу поддержку в [email protected].

Безопасность и конфиденциальность

Каждый экземпляр GitHub Connector является эксклюзивным клиентом, он работает в отдельном контейнере и может получить доступ только к токену GitHub, привязанного к профилю Клиента в Bureau Works. Как только токен будет создан, он предоставит Bureau Works acce/zooss государственным и частным хранилищам в рамках этой организации, чтобы правильно создавать запросы и коммиты.

Наша команда не имеет доступа к зашифрованному токену, и поэтому мы не можем получить доступ к репозиториям через API. Мы предоставляем подробный аудиторский след для использования, если это необходимо, и система GitHub также отслеживает использование токенов.