Упражнение. Добавление правила для обязательного просмотра

Завершено

В этом уроке вы настроите правило на GitHub, которое требует утверждения изменений рецензентом перед их слиянием с ветвью main. В качестве бонуса вы также исправите ошибку ввода на домашней странице веб-сайта Space Game .

В настоящее время команда позволяет любому, кто выполняет запрос на вытягивание, объединить код в main ветвь. Так как проверка не требуется, для неправильного или нестабильного кода может возникнуть ошибка.

Энди решает, что он хочет добавить проверка в запрос на вытягивание в виде другой пары глаз. Он хочет настроить GitHub, чтобы кто-то другой, кроме автора запроса на вытягивание, просмотреть код перед объединением. Посмотрим, как это работает.

Энди направляется, чтобы найти Мару и пятно ее на столе работает, ее голова боблинг к музыке в своих ухахах.

Энди: Мара, я был смысл говорить с вами о чем-то.

Мара смотрит вверх.

Мара: Что я могу помочь вам?

Энди: Несколько небольших ошибок делают его через сборку. Только сегодня на домашней странице появилась ошибка ввода. Амита тратит слишком много времени на эти вещи. Мы должны остановить их, прежде чем они делают это в main ветви. Нам нужна еще одна пара глаз на код перед утверждением запроса на вытягивание.

Мара: Я могу настроить это. В GitHub есть способ убедиться, что запрос на вытягивание не объединен, прежде чем кто-то другой проверяет и утверждает его.

Настройка утверждений

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

Добавление правила

  1. В GitHub перейдите в репозиторий проекта Space Game .
  2. Выберите вкладку Параметры в верхней части страницы.
  3. В меню слева выберите "Ветви".
  4. Убедитесь, что ветвью по умолчанию выбрана главная ветвь.
  5. Выберите Add branch protection rule (Добавить правило защиты ветви).
  6. В разделе Шаблон имени ветви введите main (главная).
  7. Выберите запрос на вытягивание перед слиянием проверка поля.
  8. Выберите поле "Требовать утверждения" проверка.
  9. Сохраните значение "Обязательное утверждение отзывов " на уровне 1.
  10. Выберите Создать.
  11. Выберите Сохранить изменения.

Примечание.

В нижней части списка вариантов используется параметр include Администратор istrator. Для этого параметра администраторы репозитория должны следовать правилу. Вы этого не задали, так как вы являетесь администратором репозитория и не существует другого рецензента. В этом уроке вы просматриваете и утверждаете собственные запросы на вытягивание.

Отправка исправления

В этом разделе описано, как отправить исправление в ошибку ввода на домашней странице. Вспомним, что слово "official" указано с ошибкой — "oficial".

Screenshot of the Space Game website showing a typing error.

  1. В Visual Studio Code перейдите в терминал.

  2. Чтобы проверка из ветви, выполните следующую main командуgit checkout:

    git checkout main
    
  3. Чтобы извлечь последние изменения в main ветви из GitHub, выполните следующую команду git pull:

    git pull origin main
    

    Вы увидите, что обновляются два файла:

    • README.md. Содержит код Markdown для отображения значка сборки.
    • Index.cshtml: содержит обновленный текст домашней страницы, содержащий ошибку ввода.
  4. Чтобы устранить ошибку, создайте и проверка из ветви:

    git checkout -B bugfix/home-page-typo
    
  5. В проводник откройте Index.cshtml.

  6. Найдите ошибку:

    <p>Welcome to the oficial Space Game site!</p>
    
  7. Измените строку, чтобы исправить ошибку:

    <p>Welcome to the official Space Game site!</p>
    
  8. Сохраните файл.

  9. В терминале этап и фиксация изменения:

    git status
    git add Tailspin.SpaceGame.Web/Views/Home/Index.cshtml
    git commit -m "Fix typing error on the home page"
    

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

  10. Отправьте ветвь в GitHub.

    git push origin bugfix/home-page-typo
    

Тестирование правила

  1. В GitHub найдите и выберите ветвь bugfix/home-page-typo.

    Screenshot of GitHub showing the recently pushed branch.

  2. Чтобы запустить запрос на вытягивание, выберите пункт Участие и щелкните Открыть запрос на вытягивание.

  3. Задайте вилку репозитория в качестве базового репозитория.

    Screenshot of GitHub confirming that the branch can be merged.

  4. Выберите "Создать запрос на вытягивание".

    Вы увидите, что для объединения изменений требуется проверка человека.

    Screenshot of a pull request on GitHub showing that a review is required in order to merge.

    На практике вы назначите участника группы для просмотра изменений. В этом уроке можно объединить собственный запрос на вытягивание для целей обучения.

  5. Выберите слияние, не ожидая выполнения требований (обход защиты ветви) проверка поле, а затем выберите запрос на вытягивание слиянием.

  6. Выберите команду Подтвердить слияние.

    Изменение объединено.

  7. Чтобы удалить ветвь bugfix/home-page-typo, выберите Delete branch (Удалить ветвь).