Проверка и отправка запроса на вытягивание

  • 5 мин

Запрос на вытягивание (PR) — это ваш запрос на получение знаний на платформе Learn. Вы создали pr, но он еще не был отправлен в очередь PR целевого репозитория. Как и во многих проектах с открытым исходным кодом, существует ряд проверок и проверок, которые выполняются для проверки изменений перед публикацией.

Анатомия PR

Скриншот открытого пулл-реквеста.

Pr показывает пользователя GitHub, который создал PR, целевой репозиторий и ветвь, в которой был создан PR. PRs содержат несколько вкладок в верхней части, в том числе:

  • Вкладка беседы: панель мониторинга, в которой можно просматривать и отвечать на комментарии других участников совместной работы, просматривать список уведомлений в процессе сборки и проверки и использовать автоматизацию комментариев для выполнения действий.
  • Вкладка "Фиксации": Запись изменений, внесенных в ту ветвь.
  • Вкладка "Измененные файлы": сравнение измененных файлов в PR с предыдущим состоянием.

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

PR часто имеют метки, которые указывают их состояние, например draft указывать черновикИ PR, которые не готовы к просмотру, или do-not-merge для PR, которые являются новыми или неосмотримыми.

Проверка

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

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

  • Слияние: Сначала проводится базовый тест слияния GitHub, чтобы проверить, конфликтуют ли предложенные изменения в вашей ветке с веткой назначения. Если pr указывает, что этот тест завершился ошибкой, необходимо примирить содержимое, вызывающее конфликт слияния, прежде чем продолжить обработку.
  • Соглашение о лицензировании вкладов (CLA) — если вы вносите свой вклад в общедоступный репозиторий и не являетесь сотрудником Корпорации Майкрософт, в зависимости от величины предлагаемых изменений, вам может потребоваться выполнить краткое соглашение об уровне обслуживания при первом отправке запроса на предоставление услуг в этот репозиторий. После очистки шага CLA ваш pr-запрос будет обработан.
  • Метки: Метки автоматически применяются к вашему PR, чтобы указать его состояние, пока оно проходит через рабочий процесс проверки. Например, новые PR могут автоматически получать do-not-merge метку, указывая, что pr еще не завершил проверку, проверку и выход.
  • Проверка и сборка: автоматические проверки удостоверяются, проходят ли изменения тесты валидации. Тесты проверки могут привести к предупреждению или ошибкам, требуя внесения изменений в один или несколько файлов в pr, прежде чем его можно объединить. Результаты проверки добавляются в качестве комментария в вашем pr для проверки, и они могут быть отправлены вам по электронной почте.
  • Промежуточное выполнение. Страницы статей, затронутые изменениями, автоматически развертываются в промежуточной среде для проверки при успешной проверке и сборке. URL-адреса для проверки добавляются в комментарии запроса на вытягивание.
  • Автоматическое слияние: PR может быть автоматически объединен, если он проходит проверку на соответствие и соответствует определённым критериям. В этом случае вам не нужно делать ничего другого.

Проверка и выход

Осталось совсем немного! После завершения обработки pr рекомендуется просмотреть результаты (например, комментарии PR, URL-адреса предварительной версии), чтобы определить, требуются ли дополнительные изменения перед выходом на слияние. Если рецензент pr рассмотрел ваш pr, он также может предоставить отзыв через комментарии, если есть невыполненные проблемы или вопросы, которые препятствуют слиянию.

Используйте автоматизацию комментариев для выполнения важных действий в pr. Автоматизация комментариев позволяет пользователям назначать соответствующую метку своему PR, чтобы обновить его состояние или классифицировать его. Если вы работаете в репозитории, где реализована автоматизация комментариев, используйте примечания хэштега для назначения или изменения меток, закрытия PR или приостановки объединения. Например, когда вы сделаете изменения, введите комментарий#sign-off, чтобы изменить метку PR на do-not-mergeready-for-review.

Используйте примечания в следующей таблице для выполнения ключевых действий в pr:

Комментарий хэштега Что это делает
#sign-off Автоматически назначает ready-to-merge метку, чтобы сообщить рецензентам в репозитории, что pr будет готов к просмотру и слиянию.

Если вы не являетесь перечисленным автором и пытаетесь подтвердить PR в общедоступном репозитории с помощью #sign-off комментария, PR обновляется, чтобы указать, что только автор может присвоить метку.
#hold-off Удаляет ready-to-merge метку в случае изменения вашего ума или ошибки.
#please-close Закрывает pr, если вы решили не объединить изменения.
#please-open Повторно открывает закрытый pr-запрос или проблему.

Чтобы объединить изменения, необходимо ввести #sign-off комментарий. Даже если все проверки проверки и проверки проходят, вы несете ответственность за использование этого комментария, чтобы сообщить рецензентам pr и администраторам репозитория, что ваши изменения готовы к слиянию со стороны вещей. Когда рецензенты определяют, что ваш pr-запрос является бесплатным и подписан, ваши изменения объединяются обратно в родительскую ветвь, и pr закрывается.

Снимок экрана: поле комментария для PR с введённым в поле комментария #sign-off и выделенной кнопкой

Публикация

Помните, что ваш pr-запрос должен быть объединен рецензентом PR, прежде чем изменения могут быть включены в следующий запланированный запуск публикации. Как правило, PR проверяются и объединяются в порядке отправки.

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

После публикации изменений они живут в Microsoft Learn для других пользователей, чтобы начать обучение с!

Сценарий. Публикация изменений в службе приложение Azure

Используя прошлый опыт, вы заметили возможность добавить некоторые полезные сведения на страницу документации Служба приложений и создали PR для добавления изменений. Теперь вы готовы просмотреть и выйти из pr для публикации изменений.