Установка приложения Azure Boards для GitHub

Сервисы Azure DevOps | Azure DevOps Server | Azure DevOps Server 2022

В этом кратком руководстве по быстрому старту вы установите приложение Azure Boards для GitHub, чтобы подключить Azure Boards к вашим репозиториям GitHub. При подключении проектов Azure Boards к репозиториям GitHub.com поддерживается связывание между коммитами GitHub и pull request’ами с рабочими элементами. Вы можете использовать GitHub для разработки программного обеспечения при использовании Azure Boards для планирования и отслеживания работы. После установки приложения Azure Boards для GitHub в вашей учетной записи или организации GitHub выберите из проекта те репозитории GitHub, к которым вы хотите подключиться.

Для получения сведений об интеграции, которую поддерживает приложение Azure Boards для GitHub, см. раздел Azure Boards-GitHub integration.

Prerequisites

Категория разрешений Requirements
Azure DevOps — Член группы администраторов коллекции проектов . Если вы создали проект, у вас есть это разрешение.
- Участник проекта в проекте Azure Boards.
GitHub - Администратор или владелец организации GitHub для установки приложения Azure Boards
- Разрешения на чтение для репозитория GitHub

Important

  • Если репозиторий уже подключен с помощью другого типа проверки подлинности, например OAuth, необходимо удалить этот репозиторий из существующего подключения, прежде чем повторно подключить его с помощью приложения GitHub. Выполните действия, описанные в Add или удалите репозитории GitHub далее в этой статье перед настройкой приложения GitHub.
  • Вы можете подключить организацию Azure DevOps к нескольким репозиториям GitHub, если вы являетесь администратором этих репозиториев. Не следует подключать репозиторий GitHub к более чем одной организации Azure DevOps.

Установка и настройка приложения Azure Boards

В следующих шагах показана типичная последовательность установки. Выполните все запросы на экране, чтобы завершить настройку.

  1. Перейдите к приложению Azure Boards в GitHub< Marketplace.

  2. В разделе "Планы и цены" в разделе "Бесплатный" выберите "Установить".

  3. В разделе Установите и авторизуйте Azure Boards выберите репозитории, которые нужно подключить к Azure Boards, а затем нажмите Установить и авторизовать.

    В этом примере используются все репозитории:

    Снимок экрана: страница

  4. Выберите организацию Azure DevOps и проект Azure Boards, к которым вы хотите подключиться на GitHub.com.

    Скриншот отображает страницу настройки вашего проекта в Azure Boards, где вы выбираете организацию и проект.

    Одновременно можно подключить только один проект. Если вы хотите подключить другие проекты, см. статью "Настройка других проектов или репозиториев".

Предоставление доступа к организации Azure Boards

Чтобы предоставить GitHub доступ к Azure DevOps организации, выполните следующие действия.

  1. На веб-портале GitHub откройте Settings из меню профиля.

    Снимок экрана: параметр

  2. Выберите приложения в разделе "Интеграция".

  3. Выберите Авторизованные приложения GitHub>Azure Boards.

    Снимок экрана показывает авторизованные приложения GitHub с выделенными Azure Boards.

  4. В разделе "Доступ к организации" устраните все проблемы, которые могут возникнуть. Выберите "Предоставить", чтобы предоставить доступ к любым организациям, которые отображаются как ожидающие запроса на доступ.

    Снимок экрана: доступ организации с организациями без доступа.

Проверка политики доступа к сторонним приложениям

Убедитесь, что ваша GitHub организация разрешает сторонним приложениям доступ к приложению Azure Boards. Если сторонний доступ ограничен, добавление репозиториев из Azure DevOps может отобразить пустой список или создать ошибку.

Разрешение доступа

  1. В GitHub откройте свою организацию и перейдите в Настройки>Политика OAuth-приложений.

  2. Утверждайте приложение Azure Boards специально (рекомендуется) или удалите ограничения для всех сторонних приложений.

    Снимок экрана: политика доступа к сторонним приложениям.

Замечание

Чтобы изменить этот параметр, необходимо быть владельцем организации или администратором.

После настройки интеграции Azure Boards-GitHub можно связать рабочие элементы с запросами на вытягивание и коммитами GitHub.

В следующем примере показано, как выполнить интеграцию путем создания рабочего элемента и связывания его с pull request:

  1. На доске выберите новый рабочий элемент , чтобы создать рабочий элемент. В этом примере используйте заголовок "Добавить эмблему в README". Тип рабочего элемента зависит от процесса: проблема (базовая), история пользователя (гибкая) или элемент невыполненной работы продукта (Scrum).

    Новый рабочий элемент появится на доске.

  2. Откройте рабочий элемент и перейдите в раздел "Разработка ".

  3. Выберите Добавить ссылку, а затем выберите GitHub Pull Request в меню Тип ссылки.

  4. Выберите репозиторий и введите идентификатор запроса на включение изменений. Вы также можете добавить необязательный комментарий.

  5. Нажмите кнопку "Добавить ссылку", чтобы создать подключение.

    Azure Boards автоматически выполняет следующие действия в фоновом режиме:

    • Добавляет значок в файл README первого репозитория в списке подключенных GitHub репозиториев
    • Создает коммит в GitHub для обновления значка
    • Создает запрос на включение изменений в GitHub, чтобы объединить изменения в файле README
    • Связывает коммит и pull request GitHub с вашим рабочим элементом

  6. В рабочем элементе выберите ссылку на запрос на включение изменений, чтобы открыть его в GitHub.

  7. Выберите Слить pull request в GitHub.

  8. В репозитории GitHub откройте файл README, чтобы убедиться, что значок добавлен. Дополнительные сведения см. в разделе "Настройка индикаторов состояния" для добавления в GitHub файлы README.

Настройка других проектов или репозиториев

Вы можете настроить другие Azure Boards/Azure DevOps Проекты, GitHub.com репозитории или изменить текущую конфигурацию на странице приложения Azure Boards. Дополнительные сведения см. в статье Добавить или удалить репозитории, или удалить соединение с Azure Boards.

Добавление или удаление репозиториев или удаление подключения из Azure Boards

Если возникла проблема с подключением, удалите подключение и начните с нового подключения.

  1. В проекте Azure DevOps выберите Параметры проекта>Подключения GitHub.

  2. Чтобы добавить или удалить репозитории, выберите Дополнительные параметры для подключения и выберите "Добавить репозитории" или "Удалить репозитории" в меню.

    Скриншот показывает меню подключения GitHub с дополнительными параметрами.

  3. Чтобы удалить все репозитории и подключение, выберите параметр "Удалить подключение ". Затем нажмите кнопку "Удалить ", чтобы подтвердить.

    Скриншот показывает подтверждение удаления подключения GitHub.

Изменение доступа к репозиторию

  1. На веб-портале GitHub откройте Settings из меню профиля.

  2. Выберите Интеграции>Приложения. В разделе Installed GitHub Apps выберите Configure.

    Screenshot отображает установленные приложения GitHub с Azure Boards и параметром Configure.

    Откроется страница конфигурации Azure Boards.

  3. Прокрутите вниз до раздела доступа к репозиторию.

  4. Выберите нужный вариант: все репозитории или только репозитории.

    Если выбрать Only select repositories, выберите репозитории, которые вы хотите участвовать в интеграции с Azure Boards.

    Снимок экрана: доступ к репозиторию, где можно выбрать выбранные репозитории.

  5. Нажмите кнопку "Сохранить".

Приостановка или удаление интеграции Azure Boards

  1. Начиная с шага 2 в предыдущей процедуре прокрутите вниз до раздела "Зона опасности".

    Снимок экрана: раздел

  2. Чтобы приостановить интеграцию, выберите "Приостановить". В окне подтверждения нажмите кнопку "ОК ", чтобы подтвердить приостановку.

    Снимок экрана: диалоговое окно подтверждения приостановки.

    Чтобы отменить интеграцию, выберите Unsuspend.

  3. Чтобы удалить приложение Azure Boards, нажмите кнопку "Удалить" и нажмите кнопку "ОК" в окне подтверждения всплывающего окна.

    Снимок экрана: диалоговое окно подтверждения удаления.

Обновление подключений Azure Boards-GitHub

Если изменить репозитории, которые поддерживает приложение Azure Boards для GitHub, возможно, вы будете перенаправлены на подключения Azure Boards для GitHub. Рекомендуется удалить репозитории в Azure Boards, которые больше не могут подключаться к GitHub. Дополнительные сведения см. в разделе Добавление или удаление репозиториев GitHub.

При удалении приложения Azure Boards для GitHub следующее сообщение отображается в Azure Boards, Project settings>GitHub подключения. Выберите "Удалить подключение", чтобы удалить все ранее сделанные GitHub подключения. Дополнительные сведения см. в разделе Добавление или удаление репозиториев GitHub.

Скриншот показывает неустановленное приложение Azure Boards GitHub.

Устранение неполадок интеграции

Пустой список репозиториев при добавлении репозиториев

Если список репозитория отображается пустым в Azure DevOps:

Застрявшее состояние «Запрос доступа в ожидании»

Если доступ организации всё ещё ожидает подтверждения:

  • Чтобы утвердить запрос, необходимо быть владельцем GitHub организации или администратором.
  • Выберите "Предоставить" в разделе "Доступ организации" для параметров авторизованных приложений.
  • Если проблема сохранится, удалите приложение Azure Boards и переустановите его, выполнив действия по установке и настройке приложения Azure Boards.

Значок не отображается после привязки запроса на включение изменений

Если значок не отображается в файле README после привязки pull request:

  • Значок отображается только если вы связали pull request и этот репозиторий стоит первым в вашем списке подключенных репозиториев.
  • Убедитесь, что PR, на который вы дали ссылку, по-прежнему открыт (смёрженные PR не запускают создание значка).
  • Убедитесь, что Azure Boards имеет доступ на запись в репозиторий.

Ошибки проверки подлинности или разрешений

Если во время установки возникают ошибки проверки подлинности:

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

Следующий шаг

Свяжите коммиты GitHub, pull-запросы и ветки с рабочими элементами

Связанный контент

  • Last updated on