Описание задачи

ОписаниеЗадачи — центральная модель библиотеки. Создаётся только через фабрику:

Задача = Фабрика.Новая();

Под-объекты (образ, кэш, артефакты, сервисы и т.д.) создаются лениво при первом обращении — отдельной инициализации не требуется.

Базовые поля

Поле	Тип	Ключ YAML	Описание
Наименование	Строка	имя джобы	Имя джобы в пайплайне
Стадия	Строка	stage	Стадия выполнения
Скрипты	Массив	script	Команды — добавляйте через Скрипты.Добавить("...")
Когда	Строка	when	Условие запуска. Сахар: СобытияПайплайна.ПриУспехе(), .РучнойЗапуск(), .ПриНеудаче(), .Всегда()
ТегиРаннера	Массив	tags	Теги раннера
Таймаут	Строка	timeout	Например "2h", "30m"
Прерываемый	Булево	interruptible	Отмена при новом пуше
РазрешитьПадение	Булево	allow_failure	Не валить пайплайн при падении
СтартоватьСразу	Булево	needs: []	Немедленный старт, игнорируя стадии. Взаимоисключающее с Нуждается
ГруппаРесурсов	Строка	resource_group	Сериализация запусков (deploy-джобы не должны бежать параллельно)

Пример

Задача.Наименование = "deploy-prod";
Задача.Стадия = "deploy";
Задача.Таймаут = "2h";
Задача.Прерываемый = Истина;
Задача.ГруппаРесурсов = "production";
Задача.Скрипты.Добавить("make deploy");

Нуждается (needs)

Массив имён джоб, от которых зависит запуск (DAG). Валидируется при генерации: ссылка на несуществующую джобу роняет генерацию с перечнем доступных.

Задача.Нуждается.Добавить("build");
Задача.Нуждается.Добавить("test");

Зависимости (dependencies)

Какие артефакты тащить из предыдущих стадий. Валидации нет (это отдельный механизм GitLab).

Задача.Зависимости.Добавить("build");

Образ (image)

Задача.Образ.Имя = "docker:latest";
Задача.Образ.УказатьПолитику("always");   // с валидацией
// или сахар:
Задача.Образ.Всегда();
Задача.Образ.Никогда();
Задача.Образ.ЕслиОтсутствует();
Задача.Образ.Принудительно();             // pull, GitLab/раннер >= 15.1
Задача.Образ.ДобавитьКомандуЭнтрипоинт("/bin/sh");

Сервисы (services)

Массив сервис-контейнеров, фабрика НовыйСервис():

База = Задача.НовыйСервис();
База.Имя = "postgres:14";
База.Алиас = "db";
База.ДобавитьПеременную("POSTGRES_PASSWORD", "secret");

Кэш (cache)

Задача.Кэш.ДобавитьПуть("vendor/");
Задача.Кэш.КлючПоФайлам.Добавить("packagedef");

Артефакты (artifacts)

Задача.Артефакты.ДобавитьПуть("dist/");
Задача.Артефакты.ДобавитьИсключение("dist/*.tmp");
Задача.Артефакты.ВремяХранения = "1 week";

Отчёты (reports)

Виды отчётов — через модуль ВидыОтчетов с валидацией:

Задача.Артефакты.ДобавитьОтчет(ВидыОтчетов.Юнит(), "junit.xml");
Задача.Артефакты.ДобавитьОтчет(ВидыОтчетов.САСТ(), "gl-sast-report.json");
Задача.Артефакты.ДобавитьОтчетПокрытия(ВидыОтчетов.Кобертура(), "coverage.xml");

Допустимые виды: Юнит, САСТ, ДАСТ, Дотенв, СканированиеЗависимостей, ПоискСекретов, КачествоКода, СканированиеКонтейнеров, САРИФ, ЦиклонДХ, Терраформ и другие — полный список в модуле ВидыОтчетов.os.

Повтор (retry)

Задача.Повтор.Повторы = 2;
Задача.Повтор.ДобавитьУсловие(УсловияПовтора.СбойСкрипта());
Задача.Повтор.ДобавитьУсловие(УсловияПовтора.СбойРаннера());
Задача.Повтор.ДобавитьКодВыхода(42);

Условия валидируются против набора GitLab (22 значения, см. УсловияПовтора.os). При нескольких условиях выводится массив, при одном — строка. Дубли сворачиваются.

Параллельность (parallel)

// Число копий
Задача.Параллельность.Количество = 5;

// Матрица: декартово произведение в одном ряду
Ряд = Новый Соответствие();
Ряд.Вставить("OS", ОС);
Ряд.Вставить("VERSION", Версии);
Задача.Параллельность.ДобавитьРяд(Ряд);

// Или независимые ряды
Задача.Параллельность.ДобавитьРядМатрицы("OS", ОС);

Число и матрица взаимоисключающие — одновременное задание роняет генерацию.

Окружение (environment)

Деплой.Окружение.Имя = "production";
Деплой.Окружение.УРЛ = "https://prod.example.com";
Деплой.Окружение.ПриОстановке = "stop-prod";
Деплой.Окружение.АвтоОстановка = "1 week";

// Стоп-джоба:
СтопДжоба.Окружение.Действие = ДействияОкружения.Остановка();

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

Релиз (release)

Задача.Релиз.Тег = "$CI_COMMIT_TAG";
Задача.Релиз.Описание = "Что нового";
Задача.Релиз.Имя = "Версия 1.2.3";
Задача.Релиз.ДобавитьВеху("Milestone 1");
Задача.Релиз.ДобавитьСсылку("Установщик", "https://example.com/setup.exe");

Тег и описание обязательны — без них генерация падает с именем задачи.

GitLab Pages

// Джоба с именем "pages", стадия deploy
Страницы.Наименование = "pages";
Страницы.Стадия = "deploy";
Страницы.Страницы.Публиковать("dist");

publish автоматически добавляется в artifacts:paths (GitLab 17.10+). Валидации: pages без артефактов и не в стадии deploy роняют генерацию.

Переменные джобы

Задача.ДобавитьПеременную("BUILD_TYPE", "release");