Контекстные параметры
Модуль PIPE позволяет задавать переменные и использовать их в задачах при выполнении. Поддерживаются следующие типы переменных:
- Пользовательские параметры. Задаются пользователями в глобальных параметрах пайплайна и в частных параметрах этапа;
- Динамические параметры, которые определяются при выполнении задач и могут быть использованы в последующих задачах.
Gitlife PIPE поддерживает наборы макросов, которые позволяют назначать переменным значения динамически из текущего контекста.
Все параметры независимо от их типа можно использовать в пользовательских скриптах, в параметрах задач, в правилах выполнения/пропуска задач и этапов. Вызов значения производится по ключу параметра используя макрос ${parameter key}.
Системные параметры
Глобальные системные параметры
| Ключ | Описание | Пример |
|---|---|---|
| AGILE_COMPANY | Идентификатор компании | IT_ONE.RU |
| AGILE_WORKSPACE | Идентификатор рабочего пространства | easydltest |
| AGILE_PIPELINE_TYPE | Тип пайплайна | MODULE |
| AGILE_PIPELINE_BUILD_NUMBER | Номер запуска пайплайна | 1 |
| AGILE_PIPELINE_BUILD_ID | Идентификатор запуска пайплайна | 996018 |
| AGILE_TRIGGER_USER | Пользователь, который инициировал выполнение | dmde_0516 |
AGILE_PIPELINE_BUILD_NUMBER: номер сборки обычно используется как часть лейбла артефакта сборки, например докер образа.
Параметры источника
Gitlife / Gitlab
| Ключ | Описание | Пример |
|---|---|---|
| AGILE_MODULE_TYPE | Тип системы – репозитория исходного кода | Gitlife/GITLAB |
| AGILE_MODULE_NAME | Путь URL кодовой базы | enterprise__pipedemo/java_maven_pipe_repo |
| AGILE_COMMENTS | Сообщение коммита | |
| AGILE_CODE_SUBMITTER | Пользователь – автор коммита | osc-admin |
| AGILE_COMPILE_BRANCH | Целевая ветка | uat-2023Q1 (code branch)/v1.0.0 (tag version number) |
| AGILE_REVISION | Идентификатор коммита | bdce63e40e952df068fe649675b5e4e62ee93e3f |
| AGILE_SOURCE_BRANCH | Действительно для запроса на слияние, исходная ветка | |
| AGILE_SOURCE_REVISION | Действительно для запроса на слияние, идентификатор исходного коммита |
SVN
| Ключ | Описание |
|---|---|
| AGILE_MODULE_TYPE | Тип источника материала |
| AGILE_MODULE_NAME | Путь URL кодовой базы |
| AGILE_COMMENTS | Сообщение коммита |
| AGILE_CODE_SUBMITTER | Пользователь – автор коммита |
| AGILE_REVISION | Идентификатор коммита |
Источник Пайплайн
Пайплайн-источник передает все свои экспортируемые параметры.
Параметры плагинов
Плагин Ключ Описание Пример
| Плагин | Ключ | Описание | Пример |
|---|---|---|---|
| compile plugin | AGILE_PRODUCT_PATH | URI артефакта | http://192.168.80.97:9090/artifactory/DEV/test-pipeline/maven/1608776954996_maveDemo.tar |
| Image build | IPIPE_DOCKER_IMAGE_NAME | Название образа | poc-images/ipipe-test-demo |
| Image build | IPIPE_DOCKER_IMAGE_URL | URL полного пути | registry.gitlife.com/gitlife-poc/ipipe-test-demo:16 |
| Image build | IPIPE_DOCKER_IMAGE_VERSION | Версия образа | v1.1.0 |
Динамические пользовательские параметры
В задачах, предполагающих возможность задания пользовательских скриптов есть возможность инициализировать новые параметры и задавать их значения. В качестве значений параметра могут выступать текстовые строки и файлы. Задачи, исполняемые в докер контейнерах и задачи, исполняемые на внешних хостах, имеют различный синтаксис задания атрибутов.
Задачи исполняемые в контейнерах
Присвоение параметру текстового значения:
out -k parameter_name -val parameter_value
Пример:
out -k date -val 20.03.2023
Присвоение параметру ссылки на текстовый файл:
out -k имя -f (путь до файла в текущей среде исполнение)`
out -k имя -f /opt/server.tar
Задачи исполняемые на внешних хостах
Применимо для следующих задач:
- Shell Command Execution
- BAT Command Execution
Присвоению параметру текстового значения либо ссылок на файлы:
echo "parameter name=parameter value" >> AGILE_OUT
Пример:
echo "IPIPE_AGILE_PRODUCT_PATH_AAA= http://osc.gitlife.work:9000/job-center/staging-area/2022-01/1642957224/artifact_mavendemo.zip" >> AGILE_OUT