Использование ant — различия между версиями
Материал из DevelopmenOnTheEdge
Asko (обсуждение | вклад) м (Asko переименовал страницу Использование ant в be4 в Использование ant) |
Lan (обсуждение | вклад) (Форматирование, +be.update.modules, be.meta.modules) |
||
| Строка 1: | Строка 1: | ||
В проектах на be4 определены следующие ant-таргеты: | В проектах на be4 определены следующие ant-таргеты: | ||
| − | * be.validate — валидация проекта (вычитывание всех файлов, базовые проверки на корректность, исполнение всего Freemarker; никаких обращений к базе не делается) | + | * '''be.validate''' — валидация [[Project|проекта]] (вычитывание всех файлов, базовые проверки на корректность, исполнение всего [[Freemarker]]; никаких обращений к базе не делается) |
| − | * be.update — инкрементальное обновление схемы, метаданных и локализаций | + | * '''be.update''' — инкрементальное обновление схемы, метаданных и локализаций |
| − | * be.meta — инкрементальное обновление метаданных (включая roles, icons, references, page customizations, pages) | + | * '''be.meta''' — инкрементальное обновление метаданных (включая roles, icons, references, page customizations, pages) |
| + | * '''be.update.modules''' — инкрементальное обновление схемы, метаданных и локализаций включая be4-модули | ||
| + | * '''be.meta.modules''' — инкрементальное обновление метаданных (включая roles, icons, references, page customizations, pages), включая be4-модули | ||
| + | * '''be.locale''' — инкрементальное обновление локализаций | ||
| + | * '''be.db''' — пересоздание таблиц базы данных, определённых в приложении (содержимое таблиц будет удалено) | ||
| + | * '''setup.db''' — полное разворачивание базы с нуля (как в BE) | ||
| − | * | + | * '''setup.meta''' — полное внесение метаданных и локализаций |
| − | * | + | * '''setup.just.meta''' — полное внесение метаданных |
| − | + | ||
| − | * setup. | + | * '''setup.locale''' — полное внесение локализаций |
| − | * setup. | + | * '''setup.adhoc''' — выполнение одного или нескольких FTL-скриптов из custom steps (передаются параметром -DA_SCRIPT='script1;script2'). Можно запускать скрипты из модуля (-DA_SCRIPT='realty:dictionaries') либо из всех модулей, где такой скрипт есть (-DA_SCRIPT='all:dictionaries') |
| − | * | + | * '''main''' (таргет по умолчанию) — сборка war |
| − | + | ||
| − | + | === Переменные === | |
Имеются следующие BE4-специфичные переменные | Имеются следующие BE4-специфичные переменные | ||
| − | * BE4_DIR — каталог с проектом be4 (без него ничего не заработает) | + | * '''BE4_DIR''' — каталог с проектом be4 (без него ничего не заработает) |
| − | * BE4_PROFILE — если задано, указывает профиль соединения к базе данных (из connectionProfiles.*.yaml), который необходимо использовать. | + | * '''BE4_PROFILE''' — если задано, указывает профиль соединения к базе данных (из connectionProfiles.*.yaml), который необходимо использовать. |
| − | * BE4_LOG_DIR — если задано, данный каталог будет использован для логирования BE4-операций. | + | * '''BE4_LOG_DIR''' — если задано, данный каталог будет использован для логирования BE4-операций. |
| − | * BE4_DEBUG — если "true", будет выводиться дополнительная отладочная информация в stderr. | + | * '''BE4_DEBUG''' — если "true", будет выводиться дополнительная отладочная информация в stderr. |
| − | * BE4_CHECK_QUERY="entity.query" — (только с таргетом be.validate) если задано, текст указанного запроса после выполнения FTL будет выведен на экран). | + | * '''BE4_CHECK_QUERY'''="entity.query" — (только с таргетом be.validate) если задано, текст указанного запроса после выполнения FTL будет выведен на экран). |
| − | * BE4_<имя_модуля> — если true, то будут использованы метаданные из BE4-модуля (BE4-модуль должен существовать), иначе — из старого BE-модуля с тем же именем. | + | * '''BE4_<имя_модуля>''' — если true, то будут использованы метаданные из BE4-модуля (BE4-модуль должен существовать), иначе — из старого BE-модуля с тем же именем. |
| + | |||
| + | === Задачи === | ||
При редактировании ant-скриптов можно использовать следующие задачи (tasks): | При редактировании ant-скриптов можно использовать следующие задачи (tasks): | ||
| − | * be4.db — создание базы по BE4-проекту. Параметры: | + | * '''be4.db''' — создание базы по BE4-проекту. Параметры: |
| − | + | :* modules: если true, будут использованы BE4-модули | |
| − | * modules: если true, будут использованы BE4-модули | + | |
| − | + | ||
| − | + | ||
| − | * modules: если true, будут использованы BE4-модули | + | * '''be4.meta''' — синхронизация. Параметры: |
| − | * mode: режим синхронизации (all, meta, locale, ddl, security) | + | :* modules: если true, будут использованы BE4-модули |
| + | :* mode: режим синхронизации (all, meta, locale, ddl, security) | ||
| − | * be4.data — выполнение скрипта или набора скриптов. Параметры: | + | * '''be4.data''' — выполнение скрипта или набора скриптов. Параметры: |
| − | * scriptName: имена скриптов через точку с запятой. Можно написать moduleName:scriptName для выполнения скрипта из модуля, либо all:scriptName для выполнения скрипта с таким именем из всех модулей. | + | :* scriptName: имена скриптов через точку с запятой. Можно написать moduleName:scriptName для выполнения скрипта из модуля, либо all:scriptName для выполнения скрипта с таким именем из всех модулей. |
| − | * be4.validate — валидировать BE4-проект и (для немодульного проекта) заполнить свойства ANT из модели | + | * '''be4.validate''' — валидировать BE4-проект и (для немодульного проекта) заполнить свойства ANT из модели |
У всех задач есть общие параметры: | У всех задач есть общие параметры: | ||
* projectPath (обязательно) — путь к проекту | * projectPath (обязательно) — путь к проекту | ||
Версия 15:41, 3 сентября 2014
В проектах на be4 определены следующие ant-таргеты:
- be.validate — валидация проекта (вычитывание всех файлов, базовые проверки на корректность, исполнение всего Freemarker; никаких обращений к базе не делается)
- be.update — инкрементальное обновление схемы, метаданных и локализаций
- be.meta — инкрементальное обновление метаданных (включая roles, icons, references, page customizations, pages)
- be.update.modules — инкрементальное обновление схемы, метаданных и локализаций включая be4-модули
- be.meta.modules — инкрементальное обновление метаданных (включая roles, icons, references, page customizations, pages), включая be4-модули
- be.locale — инкрементальное обновление локализаций
- be.db — пересоздание таблиц базы данных, определённых в приложении (содержимое таблиц будет удалено)
- setup.db — полное разворачивание базы с нуля (как в BE)
- setup.meta — полное внесение метаданных и локализаций
- setup.just.meta — полное внесение метаданных
- setup.locale — полное внесение локализаций
- setup.adhoc — выполнение одного или нескольких FTL-скриптов из custom steps (передаются параметром -DA_SCRIPT='script1;script2'). Можно запускать скрипты из модуля (-DA_SCRIPT='realty:dictionaries') либо из всех модулей, где такой скрипт есть (-DA_SCRIPT='all:dictionaries')
- main (таргет по умолчанию) — сборка war
Переменные
Имеются следующие BE4-специфичные переменные
- BE4_DIR — каталог с проектом be4 (без него ничего не заработает)
- BE4_PROFILE — если задано, указывает профиль соединения к базе данных (из connectionProfiles.*.yaml), который необходимо использовать.
- BE4_LOG_DIR — если задано, данный каталог будет использован для логирования BE4-операций.
- BE4_DEBUG — если "true", будет выводиться дополнительная отладочная информация в stderr.
- BE4_CHECK_QUERY="entity.query" — (только с таргетом be.validate) если задано, текст указанного запроса после выполнения FTL будет выведен на экран).
- BE4_<имя_модуля> — если true, то будут использованы метаданные из BE4-модуля (BE4-модуль должен существовать), иначе — из старого BE-модуля с тем же именем.
Задачи
При редактировании ant-скриптов можно использовать следующие задачи (tasks):
- be4.db — создание базы по BE4-проекту. Параметры:
- modules: если true, будут использованы BE4-модули
- be4.meta — синхронизация. Параметры:
- modules: если true, будут использованы BE4-модули
- mode: режим синхронизации (all, meta, locale, ddl, security)
- be4.data — выполнение скрипта или набора скриптов. Параметры:
- scriptName: имена скриптов через точку с запятой. Можно написать moduleName:scriptName для выполнения скрипта из модуля, либо all:scriptName для выполнения скрипта с таким именем из всех модулей.
- be4.validate — валидировать BE4-проект и (для немодульного проекта) заполнить свойства ANT из модели
У всех задач есть общие параметры:
- projectPath (обязательно) — путь к проекту
- logDir — каталог для логирования (переопределяет переменную BE4_LOG_DIR)
Для компиляции самого BE4 (в объёме необходимом для последующего использования вышеуказанных ant-таргетов) необходимо набрать ant в каталоге be4/src. Не требуется никаких внешних зависимостей.
