Упражнение. Добавление значка сборки

  • 7 мин

Важно знать состояние сборки участникам команды. Простой способ быстро определить состояние сборки — добавить значок сборки в файл README.md на GitHub. Давайте вернемся к команде, чтобы узнать, как это сделано.

Энди находится на столе, просеив его сообщения электронной почты. Он отвечает на третье сообщение электронной почты, связанное с состоянием сборки для веб-сайта Space Game .

Энди: Необходимо автоматизировать сообщение о состоянии. У нас есть конвейер, поэтому мы должны иметь возможность поместить состояние где-то. Может быть, Мара знает, как мы можем это сделать.

Энди находит Мару говорить с Амитой в комнате перерыва.

Энди: Привет, Амита. Имейте в виду, если я заимствую Мару на секунду?

Амита: Я должен добраться до встречи в любом случае. Заимствование.

Мара: Привет Энди. Привет!

Энди: Мне очень нравится изменения, внесенные в конвейер сборки с помощью Azure Pipelines, и Git — это отличная система управления версиями. Мне было интересно, есть ли способ сообщить людям о состоянии сборки?

Мара: Да, на самом деле. Мы можем использовать значок сборки.

Что такое значок сборки?

Значок является частью Microsoft Azure Pipelines. Он содержит методы, которые можно использовать для добавления образа SVG, отображающего состояние сборки в репозитории GitHub.

Большинство репозиториев GitHub включают файл с именем README.md, который является файлом Markdown, который содержит важные сведения и документацию по проекту. GitHub отображает этот файл на домашней странице проекта.

Ниже приведен пример индикатора сборки:

Снимок экрана GitHub с индикатором сборки. Его состояние показывает, что недавняя сборка выполнена.

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

Чтобы убедиться, что индикатор сборки отображается:

  1. В Azure DevOps перейдите в организацию.

  2. Выберите параметры организации в нижнем углу.

  3. В разделе "Конвейеры" выберите "Параметры".

  4. Отключите анонимный доступ к значкам.

    Снимок экрана Azure DevOps, показывающий, как отключить анонимный доступ к индикаторам.

Необходимо внести аналогичные изменения в проект:

  1. Перейдите к своему проекту.
  2. Из нижнего угла откройте Параметры проекта.
  3. В разделе "Конвейеры" выберите "Параметры".
  4. Отключите анонимный доступ к значкам.

Добавление значка сборки

До сих пор вы создали ветви Git локально, чтобы внести изменения в проект Space Game . Вы также можете предложить изменения непосредственно через GitHub. В этом разделе описано, как настроить индикатор состояния.

  1. В Azure DevOps в левой области выберите "Конвейеры", а затем выберите конвейер.

  2. Выберите многоточие (...) в правом верхнем углу, а затем щелкните значок состояния.

    Снимок экрана Azure Pipelines с меню для выбора индикатора сборки.

  3. В разделе "Пример Markdown" нажмите кнопку "Копировать", чтобы скопировать код Markdown в буфер обмена.

  4. В GitHub перейдите в проект.

  5. Убедитесь, что находитесь в ветви main. В области файлов откройте файл README.md .

  6. Нажмите кнопку "Изменить этот файл " (значок карандаша), чтобы открыть файл в редакторе.

  7. В верхней части страницы добавьте пустую строку и вставьте содержимое буфера обмена.

  8. Откройте вкладку Предварительный просмотр, чтобы увидеть предлагаемые изменения.

    GitHub отображает файл Markdown и отображает значок сборки.

    Снимок экрана GitHub с предварительным просмотром индикатора сборки.

Фиксация изменений в главной ветви

В этом разделе вы зафиксируйте изменения в main ветви на GitHub.

  1. Выберите " Зафиксировать изменения".

  2. В области сообщения "Фиксация" укажите сообщение фиксации, например "Добавить значок сборки".

    Снимок экрана GitHub с сообщением о фиксации.

  3. Оставьте параметр "Фиксация" непосредственно main в ветвью, а затем нажмите кнопку "Зафиксировать изменения", чтобы зафиксировать изменения в main ветви.

    Значок отображается на странице README.md .

    Снимок экрана с итоговым индикатором сборки на странице README.

    Этот процесс является более простым способом слияния кода на GitHub. Вместо фиксации напрямую вы могли бы создать запрос на вытягивание с вашими изменениями, чтобы их могли просматривать другие пользователи.

    На практике вы перейдете в main ветвь и извлеките последние изменения из GitHub при следующем добавлении компонента или адресе ошибки.

Энди: Мара, ты только что внесла изменения непосредственно в main. Почему вы не использовали поток, который вы научили мне? Знаешь, с ветвь компонента.

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

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

Энди: Я был смысл говорить с вами об этом.

Энди и Мара продолжают эту беседу, вернувшись в свои офисы.