Администратор Code Stream или разработчик может интегрировать Code Stream с процессом проверки кода Gerrit на протяжении всего жизненного цикла с помощью триггера Gerrit. Событие запускает конвейер при создании набора исправлений, публикации черновиков, объединении изменений кода в проекте Gerrit или прямой отправке изменений в ветвь Git.
В этом примере сначала настраивается прослушиватель Gerrit, который затем используется в триггере Gerrit с двумя событиями для трех разных конвейеров.
Необходимые условия
- Проверьте, являетесь ли вы участником проекта в Code Stream. Если нет, попросите администратора Code Stream добавить вас в проект в качестве участника. См. раздел Добавление проекта в Code Stream.
- Убедитесь, что существует конечная точка Gerrit, настроенная в Code Stream. См. раздел Интеграция Gerrit со службой Code Stream.
- Убедитесь, что вы знаете версию выпуска Gerrit.
- Чтобы обеспечить запуск конвейеров, убедитесь, что входные свойства конвейера заданы как Gerrit. Это позволит конвейеру получать параметры Gerrit в качестве входных данных во время работы конвейера.
Дополнительные сведения о входных параметрах см. в разделе Планирование собственной сборки по модели непрерывной интеграции и предоставления в Code Stream перед добавлением задач вручную.
Процедура
- (Необязательно) Перейдите на вкладку Прослушиватели и щелкните Создать прослушиватель.
Примечание: Пропустите этот шаг, если прослушиватель Gerrit, который планируется использовать для триггера Gerrit, уже определен.
- а. Выберите проект.
- б. Введите имя прослушивателя Gerrit.
- в. Выберите конечную точку Gerrit.
- г. Введите маркер API-интерфейса.
Маркер API-интерфейса CSP выполняет проверку подлинности для внешних соединений API-интерфейса с Code Stream. Чтобы получить маркер API-интерфейса, выполните следующие действия.
- Выберите Создать маркер.
- Введите адрес электронной почты, связанный с именем пользователя и паролем, а затем нажмите Создать.
Созданный маркер действителен в течение шести месяцев. Он также называется маркером обновления.
- Чтобы сохранить маркер в виде переменной для использования в будущем, щелкните Создать переменную, введите имя переменной и нажмите кнопку Сохранить.
- Чтобы сохранить маркер как текстовое значение для использования в будущем, нажмите кнопку Копировать и вставьте маркер в текстовый файл для сохранения в локальной системе.
- Нажмите кнопку Закрыть.
Если была создана переменная, в маркере API-интерфейса отображается введенное имя переменной с помощью привязки в виде значка доллара. Если был скопирован маркер, в маркере API-интерфейса отображается маскированный маркер.
- д. Чтобы проверить сведения о маркере и конечной точке, щелкните Проверить.
Срок действия маркера истекает через 90 дн.
- е. Щелкните Создать.
- ё. На карточке прослушивателя щелкните Подключить.
Прослушиватель начинает мониторинг всех действий на сервере Gerrit и прослушивает все активированные триггеры на этом сервере. Чтобы остановить прослушивание триггера на этом сервере, данный триггер необходимо деактивировать.Примечание: Чтобы обновить конечную точку Gerrit, подключенную к прослушивателю, сначала необходимо отключить прослушиватель.
- Выберите .
- Перейдите на вкладку Прослушиватели.
- Нажмите кнопку Отключить для прослушивателя, подключенного к конечной точке, которую необходимо обновить.
- (Необязательно) В качестве условий триггера укажите условия включения или исключения файлов.
- Укажите условия включения файлов, которые будут запускать конвейеры. В случае совпадения какого-либо из файлов в отправленной партии с файлами, указанными в путях включения или в регулярном выражении, выполняется запуск конвейеров. Если задано регулярное выражение, Code Stream запускает только конвейеры с именами файлов в наборе изменений, которые совпадают с заданным выражением. Фильтр регулярных выражений полезен при настройке триггера для нескольких конвейеров в одном репозитории.
- Чтобы предотвратить запуск конвейеров, необходимо указать исключения файлов. Если все файлы в отправленной партии совпадают с файлами, указанными в путях исключения или регулярном выражении, конвейеры не запускаются.
- Если параметр Указание приоритета исключения включен, это гарантирует, что конвейеры не будут запускаться. Конвейеры не будут запускаться даже в том случае, если какой-либо из файлов в отправленной партии совпадает с файлами, указанными в путях исключения или регулярном выражении. По умолчанию параметр Указание приоритета исключения выключен.
В следующем примере для триггера используются условия включения и исключения файлов.
- Включение файлов: при отправке кода с любым изменением в runtime/src/main/a.java или любом файле Java будут запускаться конвейеры, настроенные в конфигурации событий.
- Исключения файлов: при отправке кода с изменениями только в обоих файлах конвейеры, настроенные в конфигурации событий, не будут запускаться.
- Щелкните Создать конфигурацию.
- а. Для события Gerrit выберите тип Набор исправлений создан, Черновик опубликован или Изменение объединено. Или для прямой отправки в Git, минуя Gerrit, выберите Прямая отправка в Git.
Примечание: Начиная с версии 2.15 выпуска Gerrit, черновики изменений и наборы черновиков изменений больше не поддерживаются. Поэтому если вы используете выпуск Gerrit версии 2.15 или более поздней, событие Опубликованный черновик не поддерживается.
- б. Выберите конвейер, который будет запускаться.
Если конвейер включает в себя добавленные настраиваемые входные параметры, в списке «Входные параметры» отображаются параметры и значения. Можно ввести значения для входных параметров, которые требуется передать в конвейер с событием триггера. Кроме того, можно оставить значения пустыми или использовать значения по умолчанию.Примечание: Если значения по умолчанию определены:
- Любые вводимые значения входных параметров будут переопределять значения по умолчанию, заданные в модели конвейера.
- Значения по умолчанию в конфигурации триггера не будут изменяться, если будут изменены значения параметров в модели конвейера.
Дополнительные сведения о настройках автоматической вставки входных параметров для триггеров Gerrit см. в разделе Предварительные условия.
- в. Для типов Набор исправлений создан, Черновик опубликован и Изменение объединено, некоторые действия по умолчанию появляются с метками. Можно изменить метку или добавить комментарии. При запуске конвейера метка или комментарий отображаются на вкладке Действия данного конвейера как Выполненное действие.
Конфигурация события Gerrit позволяет вводить комментарии с помощью переменной для комментария «Успешно» или «Сбой». Например:
${var.success}и${var.failure}. - г. Нажмите Сохранить.
Чтобы добавить несколько событий триггеров в нескольких конвейерах, снова щелкните Создать конфигурацию.В следующем примере показаны события для трех конвейеров:- Если в проекте Gerrit происходит событие Изменение объединено, запускается конвейер с именем Конвейер Gerrit.
- Если в проекте Gerrit происходит событие Набор исправлений создан, запускаются Конвейер триггера Gerrit и Демоконвейер Gerrit.
- а. Для события Gerrit выберите тип Набор исправлений создан, Черновик опубликован или Изменение объединено. Или для прямой отправки в Git, минуя Gerrit, выберите Прямая отправка в Git.
Результаты
Дальнейшие действия
После фиксации изменения кода в проекте Gerrit проверьте на вкладке Действие наличие события Gerrit в Code Stream. Убедитесь, что список действий включает в себя записи, соответствующие каждому циклу выполнения конвейера в конфигурации триггера.
При возникновении события могут запускаться только те конвейеры в триггере Gerrit, которые относятся к конкретному типу события. В этом примере, если создан набор исправлений, будут выполняться только Конвейер триггера Gerrit и Демо-конвейер Gerrit.
Сведения в столбцах на вкладке
Действие описывают каждое событие триггера Gerrit. Чтобы выбрать столбцы для отображения, щелкните значок столбца под таблицей.
- Столбцы Изменение темы и Выполнение являются пустыми, если в качестве триггера используется «Прямая отправка в Git».
- В столбце Триггер для Gerrit отображается триггер, создавший событие.
- По умолчанию флажок столбца Прослушиватель снят. Если этот флажок установлен, в данном столбце отображается прослушиватель Gerrit, получивший событие. Один прослушиватель может отображаться как связанный с несколькими триггерами.
- По умолчанию флажок столбца Тип триггера снят. Если этот флажок установлен, в столбце будет отображаться тип триггера «АВТОМАТИЧЕСКИЙ» или «ВРУЧНУЮ».
- Другие столбцы: Время фиксации, Ном. изменения, Состояние, Сообщение, Действия, Пользователь, Проект Gerrit, Ветвь и Событие.
Для контроля успешного или неудачного цикла выполнения конвейера щелкните три точки слева от любой записи на экране «Действия».
- Если конвейер не выполняется из-за ошибки в модели конвейера или из-за другой проблемы, исправьте соответствующую ошибку и нажмите Выполнить заново, чтобы запустить конвейер снова.
- Если конвейер не выполняется из-за сбоя подключения к сети или из-за другой проблемы, нажмите Возобновить, чтобы перезапустить тот же цикл выполнения конвейера и сократить время выполнения.
- Нажмите Просмотреть выполнение, чтобы открыть представление выполнения конвейера. См. раздел Запуск конвейера и просмотр результатов.
- Для удаления записи на экране «Действия» нажмите Удалить.
Если событие Gerrit не запускает конвейер, нажмите
Запуск вручную, а затем выберите триггер для Gerrit, введите «ИД изменения» и нажмите
Запустить.
Примечание:
Запуск вручную работает только для допустимых событий Gerrit, например
Набор исправлений создан,
Изменение объединено и
Черновик опубликован.
