Проверки автоматизаций и отчётов Pilot

Общие проверки GitLab CI для групп automation и reports. Файлов CI в самих репозиториях нет: у каждого проекта настройка ci_config_path указывает сюда.

Файл Для чего Значение ci_config_path
automation.yml, check_automations.py JSON триггеров (только в корне папки автоматизаций), версия в _comment_ первого триггера указана и повышена (в том числе при изменении одного .cs), пара .json/.cs, одна автоматизация в изменении. JSON в подпапке и .cs не в Имя/Имя.cs - ошибка: сервер их не читает. Скрытые папки (.vscode и т. п.) и удаляемые файлы не проверяются. В .cs ищется объявление действия (public string Name => "…", как в админке): его отсутствие - предупреждение, не ошибка. .cs и JSON должны быть в UTF-8 automation.yml@pilot-ci/checks
report.yml, check_reports.py каждый .repx на любой глубине папок разбирается как XML без DOCTYPE и сущностей, корневой элемент XtraReportsLayoutSerializer report.yml@pilot-ci/checks

Новые репозитории получают настройку от веб-админки (Настройки / «Проверки автоматизаций» и «Проверки отчётов»). Репозиторию, созданному в обход админки, она ставит настройку при первой публикации.

Что проверки не делают: не компилируют .cs (компиляция идёт на сервере Pilot при отправке из админки), не ищут в .cs и в скриптах .repx (атрибут ScriptsSource) запрещённые конструкции и не проверяют схему макета DevExpress. Списка запрещённого в коде проект не задаёт ни в админке, ни в шаблонах CI, поэтому проверка не придумывает его: появится правило - добавьте его в check_automations.py и check_reports.py вместе с тестом. Это защита от ошибок, а не от злого умысла: ревью Merge Request обязательно.

Базовый коммит: у Merge Request - CI_MERGE_REQUEST_DIFF_BASE_SHA, у push в существующую ветку - предыдущий коммит ветки, у push новой ветки - точка ответвления от dev или main (ближайшая). Если ни одной из этих веток в репозитории нет, проверяются все файлы.

Переменные CI (задаются в группах automation и reports или в variables: yml):

Переменная Значение по умолчанию Назначение
CHECKS_PROJECT pilot-ci/checks проект, откуда берутся скрипты; если проект назван иначе, задайте его путь
CHECKS_REF main ветка, тег или SHA скриптов; для надёжности закрепите тег или SHA
CHECKS_IMAGE python:3.12.16-alpine с digest образ задания; нужен python3 и git

Образ по умолчанию не содержит git, и задание ставит его через apk add, то есть ходит в интернет. В закрытой сети соберите образ с python3 и git, положите его на runner и задайте CHECKS_IMAGE: тогда apk add не вызывается.

Самопроверка скриптов: python -m unittest test_checks из этой папки (нужны python3 и git).

Проект публичный: job скачивает отсюда скрипт без токена. Секретов здесь быть не должно. Правка main сразу действует на все репозитории, поэтому защитите main (push - No one, merge - Maintainers) и меняйте его через Merge Request.