Введение

Gitee Jenkins Plugin — это плагин для Jenkins, разработанный на основе GitLab Plugin. Он используется для настройки триггеров Jenkins и позволяет автоматизировать непрерывную интеграцию или непрерывное развёртывание при получении WebHook-уведомлений от платформы Gitee. Плагин также может отправлять отзывы о состоянии сборки обратно в Gitee после завершения процесса.

Текущие функции:

• Триггер сборки при отправке кода в Gitee;
• Триггер сборки по комментариям к коммитам;
• Триггер сборки при создании, обновлении, принятии, закрытии, прохождении проверки или тестировании Pull Request (PR);
• Возможность пропустить сборку с помощью команд ci-skip или ci-build;
• Фильтрация уже построенных коммитов;
• Раздельная фильтрация для push-событий и PR;
• Использование регулярных выражений для фильтрации веток;
• Настройка пароля для проверки подлинности WebHook;
• Отправка комментариев о сборке в PR после её завершения;
• Автоматическое объединение PR после успешной сборки;
• Блокировка сборки при конфликте кода в PR, если не настроена отправка комментариев;
• Запуск сборки по комментарию в PR (полезно для повторной попытки сборки после неудачной попытки);
• Сборка без тестирования, если PR не требует тестирования;
• Отмена незавершённой сборки при запуске новой сборки того же PR.

Планируемые функции:

1. Триггер сборки после прохождения проверки и тестирования PR;
2. Автоматическая настройка WebHook при выборе способа триггера.

Установка плагина

Плагин можно установить двумя способами: онлайн и вручную. Для онлайн-установки необходимо перейти в раздел Manage Jenkins -> Manage Plugins -> Available, ввести «Gitee» в поле Filter и выбрать плагин из списка. Затем нужно нажать Download now and install after restart.

Для ручной установки необходимо скачать файл плагина с сайта Gitee и загрузить его через Manage Jenkins -> Manage Plugins -> Advanced. После загрузки необходимо перезапустить Jenkins.

Конфигурация плагина

Добавление ссылки на Gitee

Чтобы добавить ссылку на Gitee, необходимо выполнить следующие шаги:

1. Перейти в Jenkins -> Manage Jenkins -> Configure System -> Gitee Configuration -> Gitee connections;
2. Ввести имя соединения, например, «Gitee»;
3. Вписать URL-адрес Gitee в поле Gitee host URL;
4. Настроить учётные данные, выбрав тип «Gitee API Token» и указав токен доступа, полученный на сайте Gitee;
5. Выбрать настроенные учётные данные;
6. При необходимости настроить параметры SSL и время ожидания соединения;
7. Проверить соединение, нажав Test Connection.

После успешной настройки ссылка на Gitee будет отображаться в списке соединений.

Создание задачи сборки

Необходимо создать новый проект в Jenkins, выбрав Freestyle project.

Глобальная конфигурация задачи

В конфигурации задачи необходимо выбрать ранее настроенное соединение с Gitee.

Настройка управления исходным кодом

На этой вкладке необходимо указать адрес репозитория Git и настроить учётные данные для доступа к нему. Также можно указать спецификацию ветки и дополнительные параметры поведения.

Это перевод основного текста запроса. Если у вас есть вопросы или уточнения, пожалуйста, сообщите мне. Текст запроса написан на языке Java.

Перевод текста запроса:

Разрешить запуск сборки для определённых ветвей

// Разрешить запускать сборку для всех ветвей: разрешить запуск для всех ветвей. branchFilterType: "All",

// На основе имени ветви: включить указанные ветви. includeBranchesSpec: "include",

// На основе имени ветви: исключить указанные ветви. excludeBranchesSpec: "exclude",

// На основе регулярного выражения: регулярное выражение для целевой ветви. targetBranchRegex: "regex",

// Пароль Gitee WebHook. secretToken: "123456" ) }

stages { stage('Build') { steps{ echo 'Hello world!' } } }

Переменные среды

В настоящее время поддерживаются переменные среды, которые можно увидеть в следующих функциях. Различные триггеры WebHook могут привести к тому, что некоторые переменные будут пустыми. Для получения более подробной информации установите плагин EnvInject Plugin, а затем проверьте переменные среды в процессе сборки.

public Map<String, String> getBuildVariables() {
    MapWrapper<String, String> variables = new MapWrapper<>(new HashMap<String, String>());
    variables.put("giteeBranch", branch);
    variables.put("giteeSourceBranch", sourceBranch);
    ...
    return variables;
}

Поддержка пользователей

Если у вас есть какие-либо вопросы во время использования, вы можете оставить отзыв на Gitee Jenkins Issue.

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

1. Перейдите в Jenkins -> Manage Jenkins -> System Log.
2. Нажмите Add new log recorder.
3. Введите «Gitee Jenkins Plugin».
4. На следующей странице нажмите Add в Logger, введите «com.gitee.jenkins» в поле ввода и выберите все в Log level, затем сохраните.
5. После выполнения вышеуказанных шагов вы сможете просмотреть журнал в «Gitee Jenkins Plugin».

Вклад участников

Мы приветствуем предложения по улучшению CI или прямые вклады кода через PR.

Упаковка или выполнение тестов

Упакуйте hpi-файл в каталоге репозитория и выполните: mvn. Запуск теста: mvn hpi:run.