Alpha.Community

В разделе Документация вы найдете все для уверенного старта и работы с Альфа платформой: от пошаговых инструкций по установке и конфигурированию до подробного описания работы компонентов и подсистем. Для поиска необходимых тем и вопросов в документации, воспользуйтесь поиском и фильтрацией результатов.

Построение

Команда в ОС Windows:

devstudio.cli build --solution-path PATH
  [--project PROJECT]
  [--version VERSION]
  [--action ACTION]
  [--describe-tree]
  [--runtime-environment RTE]
  [--output-folder FOLDER]
  [--output-format FORMAT]

Чтобы вызвать эту команду в ОС Linux, укажите ./ перед вызовом devstudio.cli.

Параметры
Параметр Описание
Обязательный параметр
--solution-path PATH

Путь к файлу решения *.solution.

Необязательные параметры
--project PROJECT

Название проекта в решении, для которого должно быть выполнено построение.

Если этот параметр не указан, построение будет выполняться для всех проектов в решении.

Можно построить несколько проектов. Для этого название каждого из них нужно передать в виде отдельного параметра --project PROJECT.

--version VERSION

Версия.

По умолчанию используется значение, заданное в свойствах проекта.

--action ACTION

Действие, которое будет выполнено.

Возможные значения:

  • status – вернуть информацию о построенных конфигурациях; построение выполняться не будет.

    Структура возвращаемых данных приведена ниже.

    Данные не выводятся, если выбран формат вывода plain (параметр --output-format).

  • build – выполнить построение; построение не будет выполняться, если результаты предыдущего построения актуальны: конфигурации для всех компонентов построены и после построения решение не менялось.
  • rebuild – выполнить принудительное построение: решение будет построено даже если результаты предыдущего построения актуальны.
  • clean – удалить результаты построения.

По умолчанию используется значение build.

--describe-tree

Если указан, при выполнении команды будет выведен список элементов решения, к которым применимы операции построения и развёртывания.

Структура возвращаемых данных приведена ниже.

Данные не выводятся, если выбран формат вывода plain (параметр --output-format).

--runtime-environment RTE

Среда исполнения. Подробнее о настройке среды исполнения можно почитать в разделе Подготовка среды исполнения и хранилища состояния.

По умолчанию используется активная среда исполнения, указанная в проекте.

--output-folder FOLDER

Папка вывода.

По умолчанию используется значение, заданное в свойствах проекта модуля.

--output-format FORMAT

Формат вывода. Подробное описание приведено здесь.

При выполнении команды будет выполнено действие, указанное параметром --action: построение решения, проверка наличия построенных конфигураций или удаление построенных конфигураций.

Примеры

Построить конфигурации в ОС Windows:

devstudio.cli build --solution-path C:\My-project\My-solution.solution

Построить конфигурации в ОС Linux:

./devstudio.cli build --solution-path /home/user/Projects/My-solution.solution

Принудительно перестроить конфигурации в ОС Windows:

devstudio.cli build --solution-path C:\My-project\My-solution.solution --action rebuild

Принудительно перестроить конфигурации в ОС Linux:

./devstudio.cli build --solution-path /home/user/Projects/My-solution.solution --action rebuild

Удалить построенные конфигурации в ОС Windows:

devstudio.cli build --solution-path C:\My-project\My-solution.solution --action clean

Удалить построенные конфигурации в ОС Linux:

./devstudio.cli build --solution-path /home/user/Projects/My-solution.solution --action clean

Построить конфигурации в среде NewEnvironment (в ОС Windows):

devstudio.cli build --solution-path C:\My-project\My-solution.solution --runtime-environment NewEnvironment

Построить конфигурации в среде NewEnvironment (в ОС Linux):

./devstudio.cli build --solution-path /home/user/Projects/My-solution.solution --runtime-environment NewEnvironment

Построить конфигурации в указанной папке и с версией 1.0.0 (в ОС Windows):

devstudio.cli build --solution-path C:\My-project\My-solution.solution --version 1.0.0
  --output-folder c:\my-configs

Построить конфигурации в указанной папке и с версией 1.0.0 (в ОС Linux):

./devstudio.cli build --solution-path /home/user/Projects/My-solution.solution --version 1.0.0
  --output-folder /home/user/my-configs

Структуры возвращаемых данных

Вызов с параметром --action status

Вызов команды build с параметром --action status возвращает структуру вида

{
  "source": "build",
  "build-status": [
    {
      "qualifier": "<квалификатор элемента>",
      "last_build": LAST_BUILD
    },
    ...
  ]
}

, где LAST_BUILD – информация о результатах построения:

  • если результатов построения нет – пустое значение null.
  • если результаты построения есть – структура вида

    {
      "version": "<версия сборки>",
      "artifacts-root": "<путь к папке с построенными артефактами>",
      "artifacts": [
        {   
          "type": "<тип файла>",                         
          "file-path": "<путь к папке артефактов относительно artifacts-root>",
          "timestamp": <время последнего изменения>
        },
        ...
      ]
    }

Если результатов построения нет:

{
  "source": "build",
  "build-status": [{
    "last-build": null,
    "qualifier": "My-project\/Domain.host.Server"
  }]
}

Если результаты построения есть (в ОС Windows):

{
  "source": "build",
  "build-status": [{
    "last-build": {
      "version": "1.0.0",
      "artifacts-folder": "E:\\Projects\\My-project\\bin\\локальная\\Domain\\host\\Server",
      "artifacts": [{
        "file-path": "alpha.server.cfg",
        "timestamp": 637927710083053257,
        "type": "cfg"
      }]
    },
    "qualifier": "My-project\/Domain.host.Server"
  }]
}

Если результаты построения есть (в ОС Linux):

{
  "source": "build",
  "build-status": [{
    "last-build": {
      "version": "1.0.0",
      "artifacts-folder": "\/home\/user\/Projects\/My-project\/bin\/локальная\/Domain\/host\/Server",
      "artifacts": [{
        "file-path": "alpha.server.cfg",
        "timestamp": 637927710083053257,
        "type": "cfg"
      }]
    },
    "qualifier": "My-project\/Domain.host.Server"
  }]
}

Вызов с параметром --describe-tree

Вызов команды build с параметром --describe-tree возвращает структуру вида

{
  "source": "build",
  "build-tree-desc": [
    {
      "type": "<тип элемента>",
      "qualifier": "<квалификатор элемента>",
      "parent-qualifier": "<квалификатор родительского элемента>",
      "build-target": <true/false>,
      "deploy-target": <true/false>
    },
    ...
  ]
}

В списке build-tree-desc будут приведены все существующие в решении квалификаторы элементов, включая родительские (всех уровней).

Результат вызова команды build с параметром --describe-tree

{
  "source": "build",
  "build-tree-desc": [
    {
      "build-target": true,
      "deploy-target": true,
      "parent-qualifier": "My-project\/Domain.host",
      "qualifier": "My-project\/Domain.host.Server",
      "type": "srv:io-server"
    }, {
      "parent-qualifier": "My-project\/Domain",
      "qualifier": "My-project\/Domain.host",
      "type": "dp:domain-node"
    }, {
      "parent-qualifier": "My-project",
      "qualifier": "My-project\/Domain",
      "type": "dp:domain"
    }, {
      "qualifier": "My-project",
      "type": "unit"
    }
  ]
}