Для связывания коммитов, запросов на вытягивание, веток и задач из GitHub с рабочими элементами в Azure Boards

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

В этой статье вы узнаете, как связать рабочие элементы с коммитами GitHub, запросами на включение, ветвями и сборками после подключения проекта Azure Boards к репозиторию GitHub. Используйте синтаксис #mention для фиксаций и ветвей, используйте упоминания ! для ссылки на запросы на включение GitHub в обсуждениях рабочих элементов или добавьте ссылку на фиксацию, запрос на включение или ветвь GitHub непосредственно из рабочего элемента Azure Boards.

Prerequisites

Используйте AB# для ссылки из GitHub на рабочие элементы Azure Boards

Используйте упоминания AB# в тексте GitHub, чтобы ссылаться на рабочие элементы Azure Boards.

Чтобы создать ссылку, выполните приведенные выше действия.

1. Добавьте AB#{ID} в сообщение коммита, описание запроса на слияние или описание задачи.
2. Отправьте коммит или сохраните pull request либо issue.
3. Откройте рабочий элемент, чтобы подтвердить, что ссылка появится в разделе "Разработка ".

Использование AB#ID в комментарии или в заголовке запроса на включение изменений не создает ссылку на рабочий элемент.

AB#{ID}

Например, AB#125 ссылается на рабочий элемент с ID 125.

Вы также можете переводить рабочие элементы из текста коммита или пул-реквеста. Azure Boards распознает {state} или {state category} и ключевые слова, такие как fix, fixesи fixedзатем применяет этот переход к следующей AB# ссылке.

Если описание запроса на вытягивание содержит допустимое имя состояния, например, Closed AB#1234, система обновляет указанный рабочий элемент к этому конкретному состоянию. Если имя состояния не распознается напрямую, Azure Boards пытается сопоставить его с категорией рабочего процесса, например Resolved или Completed. Если совпадение найдено, рабочий элемент переходит в первое доступное состояние, определенное в этой категории.

По умолчанию рабочие элементы, ссылающиеся на fix, fixes или fixed, переходят в первое состояние, связанное с категорией Resolved. Если такое состояние отсутствует в текущем процессе, система вместо этого переместит рабочий элемент в первое состояние в категории "Завершено ".

Дополнительные сведения см. в разделе Как используются состояния категорий рабочего процесса в невыполненных работах и досках Azure Boards.

Используйте следующие примеры, содержащие только ссылки:

Используйте следующие примеры ссылок и перехода:

При добавлении ссылки на рабочий элемент с помощью AB# в описании pull request, эти ссылки отображаются в разделе Development pull request в GitHub. Эти ссылки доступны только при использовании AB# в описании запроса на вытягивание. Они не отображаются, если вы переходите по ссылке из рабочего элемента к pull request. Удаление AB# ссылки из описания также удаляет ее из раздела "Разработка".

Создание ветви GitHub из рабочего элемента

Чтобы создать ветвь GitHub непосредственно из рабочего элемента, выполните следующие действия.

1. Найдите рабочий элемент, который вы хотите использовать для создания ветки на GitHub.

2. Выберите действия Work item actions>New GitHub branch.

   

3. В диалоговом окне Create GitHub branch введите имя ветви. Выберите репозиторий GitHub и базовую ветвь.

4. Нажмите кнопку "Создать".

   

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

Добавление ссылки на рабочий элемент к ветке, коммиту или pull request в GitHub

1. Откройте рабочий элемент и перейдите в область разработки .

2. Выберите " Добавить ссылку". В каждом раскрывающемся меню выберите ваш тип ссылки, репозиторий GitHub и запрос на вытягивание GitHub. Вы можете выполнять поиск и углублённый поиск в репозитории, чтобы найти и выбрать конкретный запрос на вытягивание или коммит, без необходимости копировать и вставлять URL-адрес.

3. Выберите " Добавить ссылку".

   

   Azure Boards выполняет проверку, чтобы убедиться, что введена действительная ссылка. Связанный с GitHub репозиторий должен быть подключен к проекту Azure Boards или проверка не будет пройдена.

Автоматическое обновление ссылок

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

Просмотр или открытие ссылок из раздела "Разработка"

В разделе "Разработка" формы рабочего элемента перечислены ссылки, созданные на коммиты и pull requests в GitHub с использованием значка GitHub.

Выберите ссылку, чтобы открыть коммит или pull-реквест в GitHub.

GitHub информация о pull request

В разделе Development связанные pull request'ы GitHub показывают дополнительные сведения о статусе. Вы можете оценить прогресс, не открывая pull request в GitHub.

Предварительные требования для инcайтов по пулл-реквестам

Чтобы просмотреть аналитику по запросу на пулл-реквест, откройте приложение Azure Boards в GitHub и примите обновленные разрешения на чтение и запись для Проверок.

Просмотр статуса пул-реквеста

1. Откройте рабочий элемент, имеющий связанный GitHub pull запрос.

2. В разделе "Разработка" найдите связанный pull request. Следующие сведения о состоянии отображаются рядом со ссылкой на pull request:

   • Состояние черновика: показывает, является ли запрос на вытягивание черновиком.
   • Статус проверки: показывает, требует ли запрос на включение изменений проверки, одобрен ли он или требуются ли изменения.
   • Проверяет состояние: показывает, успешно проходят ли проверки CI, завершаются ли они с ошибками или находятся в ожидании.

   

3. Наведите указатель мыши на индикатор состояния, чтобы увидеть подробности, или выберите ссылку pull request, чтобы открыть её прямо в GitHub.

Указывайте GitHub pull-запросы с помощью !

Используйте ! упоминания, чтобы ссылаться и обсуждать запросы на извлечение GitHub непосредственно из любого поля с форматированным текстом рабочего элемента или комментария для обсуждения. Когда вы вводите ! в текстовом поле, появляется селектор, с помощью которого можно искать и выбирать запрос на извлечение GitHub из подключенного репозитория. Выбранный pull request вставляется в виде ссылки, щелчок по которой доступен.

Эта функция позволяет легко ссылаться на связанные pull requests в описаниях рабочих элементов, критериях принятия или потоках обсуждения, не копируя URL-адреса вручную.

Отображение статуса сборки для конвейеров на YAML (входит в состав сборки)

При использовании Azure Pipelines YAML для сборки кода, размещенного в репозитории GitHub, вы можете автоматически создавать связи интеграция в сборке на связанные с этим элементы рабочего процесса. Эта функция обеспечивает трассировимость сборки для репозиториев GitHub, достигая равенства с возможностями, доступными для Azure Repos.

Чтобы включить эту функцию:

1. Откройте конвейер YAML, выберите "Дополнительные действия" и выберите "Параметры".

2. В диалоговом окне "Параметры конвейера" включите автоматическое связывание новых рабочих элементов в этой сборке.

   

Когда сборка завершится, в разделе "Разработка" каждого связанного рабочего элемента автоматически отображается ссылка "Интегрировано в сборке", обеспечивая команде полную трассировку от рабочего элемента к сборке.

Дополнительные сведения о настройке этого параметра см. в разделе "Настройка конвейеров для поддержки отслеживания работы".

Просмотр объектов GitHub на доске

Когда вы включаете аннотации GitHub на доске, можно быстро открывать связанные коммиты GitHub, pull-запросы или задачи, чтобы получить более подробную информацию. Дополнительные сведения см. в разделе "Настройка карточек".

Используйте ИИ, чтобы связывать рабочие процессы в GitHub и управлять ими

Если настроить Azure DevOps MCP Server, можно описывать задачи по связыванию GitHub с рабочими элементами на естественном языке, вместо того чтобы вручную заполнять форму рабочего элемента.

Используйте эти запросы в качестве примеров сценариев. Поддерживаемые операции зависят от настроенных наборов инструментов, версии расширения и разрешений.

Некоторые запросы могут возвращать рекомендации вместо выполнения действия записи или требовать несколько запросов в зависимости от включенных средств MCP.

Перед запуском промпта замените плейсхолдеры, такие как <Contoso>, <owner/repo> и <sha>, своими фактическими значениями.

Используйте этот быстрый поток выполнения и проверки:

1. Выполните один запрос из таблицы.
2. Просмотрите ответ на действия, выполненные.
3. Откройте рабочий элемент и подтвердите результат в разделе "Разработка ".
4. Откройте связанный артефакт GitHub и подтвердите ожидаемую ссылку или обновление.

Сначала попробуйте выполнить следующие запросы:

• Link work item AB#125 in project <Contoso> to GitHub pull request <owner/repo>#42
• Link work item AB#312 in project <Contoso> to GitHub commit <owner/repo>@<sha>
• Summarize all GitHub commits and pull requests linked to work item AB#312 in project <Contoso>

Устранение неполадок при связывании с помощью искусственного интеллекта

• Если запрос не выполняется, убедитесь, что режим агента включен в клиенте ИИ.
• Если запрос завершается ошибкой доступа, убедитесь, что у вашей учетной записи есть доступ к проекту Azure DevOps и репозиторию GitHub.
• Если ссылки не созданы, замените все заполнители (например, <Contoso>, <owner/repo>, ) <sha>реальными значениями и снова запустите запрос.
• Если массовый запрос завершается ошибкой, сначала повторите попытку с одним рабочим элементом, а затем повторите попытку с меньшим пакетом.
• Если результаты по-прежнему не соответствуют ожиданиям, проверьте результат в разделе Development рабочего элемента и в связанном артефакте GitHub.

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

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

• Интегрируйте Azure Boards с GitHub
• Настройка конвейеров для поддержки отслеживания работы
• Поймите, как состояния категорий рабочих процессов используются в бэклогах и досках Azure Boards
• Связывание рабочих элементов с объектами
• Устранение проблем с подключением GitHub и Azure Boards