Создавать пулл-реквесты
Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019
Visual Studio 2019 | Visual Studio 2022
Создание запросов на вытягивание (PR) для изменения, проверки и слияния кода в репозитории Git. Вы можете создавать PR из ветвей в вышестоящем репозитории или из ветвей в вилку репозитория. Ваша команда может пересмотреть PR-ы и дать отзыв об изменениях. Рецензенты могут пройти через предложенные изменения, оставить комментарии и проголосовать за утверждение или отклонение PR. В зависимости от политик ветви и других требований может потребоваться выполнить различные критерии, прежде чем завершить PR и объединить изменения в целевую ветвь.
Рекомендации по pr и управлению см. в разделе О запросах на вытягивание.
Предпосылки
Категория | Требования |
---|---|
Уровни доступа | — Просмотр или проверка PR: по крайней мере базовый доступ. Для общедоступных проектов пользователи доступ к заинтересованным лицам имеют полный доступ к Azure Repos. |
Разрешения | — Участие в PR: Член Читателей группы безопасности или с соответствующими разрешениями. — Создайте и завершите PR: член группы безопасности участники или соответствующие разрешения. |
услуги | Repos включено. |
Инструменты | Azure DevOps CLI. |
Категория | Требования |
---|---|
Уровни доступа | — Просмотр или проверка PR: по крайней мере базовый доступ. |
Разрешения | — Участие в pr: член читателей группы безопасности или соответствующих разрешений. — Создайте и завершите PR: член группы безопасности Участники или обладающий соответствующими разрешениями. |
услуги | Repos включено. |
Дополнительные сведения о разрешениях и доступе см. в разделе "Репозиторий Git по умолчанию" и " Разрешения ветви" и "Сведения о уровнях доступа".
Создание pull request
Вы можете создать новый PR на веб-сайте проекта Azure DevOps, из Visual Studio или из Интерфейса командной строки Azure DevOps.
На веб-сайте проекта Azure DevOps вы можете создать новый PR из следующих источников:
- Страница Pull requests.
- ветвь функций, отправленная в репозиторий.
- С помощью cherry-pick примените изменения к существующему PR.
- Управление разработкой в связанном рабочем элементе Azure Boards.
Создайте пулл-реквест на странице пулл-реквестов
Вы можете создать запросы на вытягивание для любой ветки на странице Запросы на вытягивание проекта в Интернете.
На странице запросов pull requestрепозитория > выберите пункт Новый pull request в правом верхнем углу.
Выберите ветвь с изменениями и ветвью, в которую необходимо объединить изменения, например основную ветвь.
Введите информацию о PR и создайте PR.
Создание PR из принудительной ветви
После отправки или обновления ветви компонентов Azure Repos отображает запрос на создание PR.
На странице Pull requests:
На странице файлы:
Выберите Создать запрос на вытягивание, чтобы перейти на страницу, в которой можно ввести сведения о pr и создать pr.
Создание PR из связанного рабочего элемента
Вы можете создать PR прямо из рабочего элемента Azure Boards, связанного с веткой.
В Azure Boards из журналов задач или запросов в представлении Работы откройте задачу, связанную с ветвью.
В области разработки рабочего элемента выберите Создать pull request.
Ссылка ведет на страницу, где вы можете ввести сведения о PR и создать PR.
Добавление обновлений с помощью выбора вишни
Вы можете скопировать коммиты из одной ветви в другую, используя cherry-pick. В отличие от слияния или перебазы, cherry-pick переносит изменения только из выбранных коммитов, а не все изменения в ветви.
Чтобы выбрать изменения из завершенного PR, выберите Cherry-pick на странице Обзор PR. Чтобы скопировать изменения из активного PR, выберите Cherry-pick в меню Дополнительные параметры. Это действие создает новую ветвь с скопированными изменениями. Затем вы можете создать новый PR из новой ветви. Для подробных инструкций см. Копирование изменений с помощьюcherry-pick.
Переключите исходные и целевые ветви вашего запроса на вытягивание
Перед первым сохранением PR вы можете переключить исходную и целевую ветви, выбрав значок Переключить исходную и целевую ветви рядом с именами ветвей. После активности pr этот значок исчезнет, но вы все равно можете изменить целевую ветвь PR.
Используйте шаблоны pull request'ов
Шаблон пулл-реквеста — это файл, содержащий текст Markdown, который заполняет описание PR при создании PR. Хорошие описания PR сообщают рецензентам о том, что ожидать, и могут помочь отслеживать задачи, такие как добавление модульных тестов и обновление документации. Ваша команда может создать шаблон PR по умолчанию, который добавляет текст во все новые описания PR в репозитории. Кроме того, вы можете выбрать шаблоны, относящиеся к ветви, или другие шаблоны, которые определяет команда. Дополнительные сведения о создании и использовании шаблонов для pull request см. в статье Улучшение описания pull request с помощью шаблонов.
Если репозиторий имеет шаблон по умолчанию, все PR в репозитории имеют текст описания шаблона по умолчанию при создании. Чтобы добавить другие шаблоны, выберите Добавить шаблон и выберите шаблон из раскрывающегося списка. Вы можете изменить текст шаблона в описании, удалить его или добавить другой текст.
Создавайте черновики PR
Если ваш PR не готов к просмотру, вы можете создать черновой PR, чтобы указать, что работа еще ведется. Когда PR будет готов для проверки, его можно опубликовать и начать или возобновить полный процесс рецензирования.
Проекты PR имеют следующие отличия от опубликованных PR:
Политики проверки сборки не выполняются автоматически. Вы можете выполнить проверку сборки вручную, выбрав меню дополнительных параметров в PR.
Голосование отключено в режиме черновика.
Обязательные рецензенты не добавляются автоматически. Уведомления отправляются только рецензентам, которых вы явно добавляете в черновик запроса на проверку.
Черновик PR отображается в списке PR с значком "Черновик".
Чтобы создать черновик PR, при создании PR щелкните стрелку рядом с Создать и выберите Создать в качестве черновика. Вам не нужно использовать префиксы заголовка, например WIP
или DO NOT MERGE
.
Когда вы будете готовы, чтобы PR был проверен и завершён, выберите Опубликовать в правом верхнем углу PR. Публикация PR назначает нужных рецензентов, проверяет политики и запускает голосование.
Чтобы изменить существующий опубликованный PR на черновик, выберите Mark as draft. Пометка PR в качестве черновика удаляет все существующие голоса.
Добавление или редактирование заголовка и описания pull request.
На странице Новый запрос на включение изменений введите заголовок и подробное описание ваших изменений, чтобы другие могли видеть, какие проблемы эти изменения решают. В новом PR, как и в существующих PR, вы можете увидеть файлы и коммиты на отдельных вкладках. Вы можете добавить рецензентов, связать рабочие элементы и добавить теги в PR.
Когда вы будете готовы отправить изменения на проверку, выберите Создать, чтобы создать PR.
.
Не беспокойтесь, если у вас нет всех элементов работы, ревьюеров или сведений, готовых при создании PR. После создания PR можно добавить или обновить эти элементы.
Изменение заголовка и описания PR
Поддерживайте заголовок и описание PR в актуальном состоянии, чтобы обозреватели могли понять изменения в PR.
Вы можете обновить название существующего PR, выбрав текущее название и обновив текст. Щелкните значок Сохранить, чтобы сохранить изменения, или щелкните значок отменить, чтобы отменить изменения.
Отредактируйте описание PR, выбрав значок Изменить в разделе Описание.
Добавление рецензентов в pull request
Вы можете добавить рецензентов в разделе Рецензентов нового или существующего PR. Вы также можете изменить необязательных рецензентов на необходимых, изменить необходимых рецензентов на необязательных или удалить их, если они не требуются политикой.
Политики ветви могут требовать минимальное количество рецензентов или автоматически включать некоторых необязательных или обязательных рецензентов в PR. Вы не можете удалить рецензентов, необходимых политике ветви, но вы можете изменить необязательных рецензентов на необходимые или удалить их.
Чтобы просмотреть политику ветви, которая автоматически добавила рецензента, щелкните правой кнопкой Дополнительные параметры рядом с рецензентом в разделе Рецензентов страницы Обзора PR.
Если пользователь или группа, которую вы хотите добавить для проверки вашего PR, не является членом вашего проекта, добавьте их в проект, прежде чем вы сможете назначить их рецензентами.
Чтобы добавить рецензентов в новый PR, сделайте следующее:
- На странице новый запрос на вытягивание в разделе рецензентывыберите "Поиск пользователей и групп", чтобы добавить в качестве рецензентов.
- При вводе имени или адреса электронной почты раскрывающийся список отображает список соответствующих пользователей и групп. Выберите имена из списка, чтобы добавить в качестве необязательных рецензентов.
- Чтобы добавить необходимых рецензентов, выберите Добавить обязательных рецензентов, а затем выберите Искать, чтобы найти и выбрать имена.
Чтобы добавить рецензентов в существующий PR, сделайте следующее:
В разделе рецензентов на странице обзор выберите Добавить, а затем выберите обязательный рецензент или необязательный рецензент.
Обзор пулл-реквеста
При вводе имени или адреса электронной почты появится список соответствующих пользователей или групп. Выберите имена для добавления в качестве рецензентов.
Чтобы сделать рецензента обязательным или необязательным и наоборот, или удалить рецензента, выберите другие параметры (⋮) справа от имени рецензента. Чтобы просмотреть членство в группе или команде, назначенных рецензентами, выберите значок группы или команды.
Связывание рабочих элементов с пул-реквестом
Чтобы связать рабочие элементы с новым PR, сделайте следующее:
- На странице нового запроса на вытягивание в разделе Рабочие элементы, чтобы связать, выберите Поиск рабочих элементов по идентификатору или заголовку.
- Начните вводить идентификатор рабочего элемента или заголовок, а затем выберите рабочий элемент, чтобы связаться с раскрывающимся списком.
- Поиск по названию возвращает рабочие элементы, отфильтрованные по состоянию; все рабочие элементы с состояниями, классифицированными как Завершенные и Удаленные, исключены.
- Эти рабочие элементы также фильтруются по дате и пользователю, отображая только элементы, созданные или обновленные за последние 30 дней. Они должны быть созданы, назначены или авторизованы текущим пользователем.
Чтобы связать рабочие элементы с существующим PR, выполните следующие действия:
На вкладке обзора PR в области рабочих элементов выберите +.
Введите идентификатор рабочего элемента или найдите название рабочего элемента. Выберите рабочий элемент в появившемся списке.
Удалите ссылку на рабочий элемент, выбрав значок x рядом с рабочим элементом. При удалении ссылки удаляется только ссылка между рабочим элементом и PR. Ссылки, созданные в ветке или из коммитов, остаются в рабочем элементе.
Добавление тегов в запрос на вытягивание
Используйте теги для отображения важных сведений и справки по упорядочению PR. Теги могут передавать дополнительную информацию рецензентам, например о том, что PR находится в процессе работы, или является исправлением для предстоящего обновления.
Чтобы добавить тег при создании PR, введите имя тега в разделе тегов. После создания PR вы можете управлять тегами в разделе Теги.
Добавление вложений в pull requests
Вы можете прикрепить файлы, в том числе изображения, к PR во время или после его создания. Щелкните значок скрепки под полем описания или перетащите файлы непосредственно в поле описания PR.
Измените целевую ветку активного pull request
Для большинства команд почти все PR предназначены для ветви по умолчанию, например main
или develop
. Если иногда вам нужно выбрать другую ветвь, при создании PR легко забыть изменить целевую ветвь. В этом случае можно изменить целевую ветвь активного PR:
- Выберите Дополнительные действия в правом верхнем углу на странице обзора pr, а затем выберите Изменить целевую ветвь в раскрывающемся меню.
- В области Изменить целевую ветвь выберите Выберите целевую ветвь, выберите новую ветвь и выберите Изменить.
Отправка уведомлений о запросах на слияние по электронной почте заинтересованным лицам
Вы можете поделиться pull request по электронной почте, чтобы уведомить рецензентов и общаться с участниками команды. Чтобы поделиться PR, выполните следующие действия.
Выберите Дополнительные параметры на странице обзора Pull Request, а затем выберите Отправить Pull Request.
На экране Поделиться запросом на вытягивание добавьте получателей, введя их имена в поле To: и выбрав из появляющихся имен пользователей. Вы также можете удалить получателей.
Добавьте необязательное сообщение в поле Заметка (необязательно), а затем выберите Отправить. Получатели получают электронное письмо с просьбой обратить внимание и ссылкой на PR.
Примечание.
При использовании встроенной функции электронной почты можно отправлять только сообщения электронной почты отдельным членам проекта. Добавление группы группы или группы безопасности в To: строка не поддерживается. Если вы добавите нераспознанный адрес электронной почты, вы получите сообщение, указывающее, что у одного или нескольких получателей нет доступа, чтобы прочитать пулл-реквест.
Для работы функции электронной почты администратор должен настроить smtp-сервер.