From b3b1fb0ff4dd05a5f09d3b6b6213a19acbf845fb Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Tue, 31 Oct 2023 08:45:20 +0000 Subject: [PATCH] Site checkin for project Bonita Project Maven Plugin Parent --- analyze-mojo.html | 231 ++--- business-archive-mojo.html | 293 ++---- ci-management.html | 6 +- copy-provided-pages-mojo.html | 44 +- create-bdm-module-mojo.html | 79 +- create-extensions-module-mojo.html | 79 +- dependencies.html | 154 ++-- dependency-info.html | 18 +- dependency-management.html | 1364 ++++++++++++++-------------- distribution-management.html | 6 +- extract-configuration-mojo.html | 161 +--- generate-bdm-dao-client-mojo.html | 121 +-- generate-bdm-model-mojo.html | 121 +-- help-mojo.html | 161 +--- index.html | 6 +- install-mojo.html | 79 +- issue-management.html | 6 +- licenses.html | 6 +- merge-configuration-mojo.html | 159 +--- plugin-info.html | 8 +- plugin-management.html | 12 +- plugins.html | 14 +- project-info.html | 6 +- project-reports.html | 6 +- scm.html | 6 +- summary.html | 8 +- team.html | 6 +- uid-page-mojo.html | 156 +--- validate-mojo.html | 137 +-- 29 files changed, 1299 insertions(+), 2154 deletions(-) diff --git a/analyze-mojo.html b/analyze-mojo.html index f74873d..6d70ee4 100644 --- a/analyze-mojo.html +++ b/analyze-mojo.html @@ -2,7 +2,7 @@ @@ -30,8 +30,8 @@
- - -
-

bonita-project:analyze

- -

Full name:

- -

org.bonitasoft.maven:bonita-project-maven-plugin:1.0.0-beta-02:analyze

- -

Description:

- -
This mojo runs an analysis on the current project dependencies to detect Bonita specific extensions.
- -

Attributes:

- +
+

bonita-project:analyze

+

Full name:

+

org.bonitasoft.maven:bonita-project-maven-plugin:1.0.0:analyze

+

Description:

+

This mojo runs an analysis on the current project dependencies to detect Bonita specific extensions.

+

Attributes:

    -
  • Requires a Maven project to be executed.
    • -
  • Executes as an aggregator goal.
    • - -
  • The goal is not marked as thread-safe and thus does not support parallel builds.
    • -
-
-

Optional Parameters

- +
  • The goal is not marked as thread-safe and thus does not support parallel builds.
    • +

    Optional Parameters

    - - - - - - - - + - - - + - - - - +
  • runtime exclude scope excludes runtime and compile dependencies,
    • +
  • compile exclude scope excludes compile, provided, and system dependencies,
    • +
  • test exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile
    • +
  • provided exclude scope just excludes provided dependencies,
    • +
  • system exclude scope just excludes system dependencies.
    • +
    User Property: excludeScope - - - + - - - - +
  • runtime include scope gives runtime and compile dependencies,
    • +
  • compile include scope gives compile, provided, and system dependencies,
    • +
  • test include scope gives all dependencies (equivalent to default),
    • +
  • provided include scope just gives provided dependencies,
    • +
  • system include scope just gives system dependencies.
    • +
    Default: runtime
    User Property: includeScope - - - + - - - - - + - - - + - - - - -
    NameTypeSinceDescription
    Description
    <excludeScope><excludeScope> String0.1.0Scope threshold to exclude, if no value is defined for include. An empty string indicates no dependencies (default).
    The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary: -
      - -
    • runtime exclude scope excludes runtime and compile dependencies,
      • - -
    • compile exclude scope excludes compile, provided, and system dependencies,
      • - -
    • test exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile
      • - -
    • provided exclude scope just excludes provided dependencies,
      • - -
    • system exclude scope just excludes system dependencies.
      • -

    User property is: excludeScope.
    <includeScope><includeScope> String0.1.0Scope threshold to include. An empty string indicates include all dependencies. Default value is runtime.
    The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary: -
      - -
    • runtime include scope gives runtime and compile dependencies,
      • - -
    • compile include scope gives compile, provided, and system dependencies,
      • - -
    • test include scope gives all dependencies (equivalent to default),
      • - -
    • provided include scope just gives provided dependencies,
      • - -
    • system include scope just gives system dependencies.
      • -

    Default value is: runtime.
    User property is: includeScope.
    <outputFile><outputFile> File-Analysis report output file.
    Default value is: ${project.build.directory}/bonita-dependencies.json.
    User property is: bonita.analyze.outputFile.
    Analysis report output file.
    Default: ${project.build.directory}/bonita-dependencies.json
    User Property: bonita.analyze.outputFile
    <validateDeps><validateDeps> boolean-Look for incompatible dependencies.
    Default value is: true.
    User property is: bonita.validateDependencies.
    -
    -
    -

    Parameter Details

    -
    -

    <excludeScope>

    - +Look for incompatible dependencies.
    Default: true
    User Property: bonita.validateDependencies
    +

    Parameter Details

    +

    <excludeScope>

    Scope threshold to exclude, if no value is defined for include. An empty string indicates no dependencies (default).
    The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary: -
      - -
    • runtime exclude scope excludes runtime and compile dependencies,
      • - -
    • compile exclude scope excludes compile, provided, and system dependencies,
      • - -
    • test exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile
      • - -
    • provided exclude scope just excludes provided dependencies,
      • - -
    • system exclude scope just excludes system dependencies.
      • +
    • runtime exclude scope excludes runtime and compile dependencies,
      • +
    • compile exclude scope excludes compile, provided, and system dependencies,
      • +
    • test exclude scope excludes all dependencies, then not really a legitimate option: it will fail, you probably meant to configure includeScope = compile
      • +
    • provided exclude scope just excludes provided dependencies,
      • +
    • system exclude scope just excludes system dependencies.
    -
      - -
    • Type: java.lang.String
      • - -
    • Since: 0.1.0
      • - -
    • Required: No
      • - -
    • User Property: excludeScope
      • -
    -

    <includeScope>

    - +
  • Type: java.lang.String
    • +
  • Since: 0.1.0
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: excludeScope
    • +

    <includeScope>

    Scope threshold to include. An empty string indicates include all dependencies. Default value is runtime.
    The scope threshold value being interpreted is the scope as Maven filters for creating a classpath, not as specified in the pom. In summary: -
      - -
    • runtime include scope gives runtime and compile dependencies,
      • - -
    • compile include scope gives compile, provided, and system dependencies,
      • - -
    • test include scope gives all dependencies (equivalent to default),
      • - -
    • provided include scope just gives provided dependencies,
      • - -
    • system include scope just gives system dependencies.
      • +
    • runtime include scope gives runtime and compile dependencies,
      • +
    • compile include scope gives compile, provided, and system dependencies,
      • +
    • test include scope gives all dependencies (equivalent to default),
      • +
    • provided include scope just gives provided dependencies,
      • +
    • system include scope just gives system dependencies.
    -
      - -
    • Type: java.lang.String
      • - -
    • Since: 0.1.0
      • - -
    • Required: No
      • - -
    • User Property: includeScope
      • - -
    • Default: runtime
      • -
    -

    <outputFile>

    - +
  • Type: java.lang.String
    • +
  • Since: 0.1.0
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: includeScope
    • +
  • Default: runtime
    • +

    <outputFile>

    Analysis report output file.
    -
      - -
    • Type: java.io.File
      • - -
    • Required: No
      • - -
    • User Property: bonita.analyze.outputFile
      • - -
    • Default: ${project.build.directory}/bonita-dependencies.json
      • -
    -

    <validateDeps>

    - +
  • Type: java.io.File
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: bonita.analyze.outputFile
    • +
  • Default: ${project.build.directory}/bonita-dependencies.json
    • +

    <validateDeps>

    Look for incompatible dependencies.
    -
      - -
    • Type: boolean
      • - -
    • Required: No
      • - -
    • User Property: bonita.validateDependencies
      • - -
    • Default: true
      • -
    -
    -
    - - +
  • Type: boolean
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: bonita.validateDependencies
    • +
  • Default: true
    • diff --git a/business-archive-mojo.html b/business-archive-mojo.html index 09b2afb..3b4cc0d 100644 --- a/business-archive-mojo.html +++ b/business-archive-mojo.html @@ -2,7 +2,7 @@ @@ -30,8 +30,8 @@
    - - -
    -

    bonita-project:business-archive

    - -

    Full name:

    - -

    org.bonitasoft.maven:bonita-project-maven-plugin:1.0.0-beta-02:business-archive

    - -

    Description:

    - -
    This mojo builds Business archives from diagram sources.
    - -

    Attributes:

    - +
    +

    bonita-project:business-archive

    +

    Full name:

    +

    org.bonitasoft.maven:bonita-project-maven-plugin:1.0.0:business-archive

    +

    Description:

    +

    This mojo builds Business archives from diagram sources.

    +

    Attributes:

      -
    • Requires a Maven project to be executed.
      • -
    • Requires dependency resolution of artifacts in scope: compile+runtime.
      • -
    • The goal is not marked as thread-safe and thus does not support parallel builds.
      • - -
    • Binds by default to the lifecycle phase: process-resources.
      • - -
    • Invokes the execution of this plugin's goal analyze prior to executing itself.
      • -
    -
    -

    Optional Parameters

    - +
  • Binds by default to the lifecycle phase: process-resources.
    • +
  • Invokes the execution of the following plugin's goal prior to executing itself: analyze.
    • +

    Optional Parameters

    - - - - - - - - + - - - + - - - - - + - - - + - - - - - + - - - + - - - - - + - - - + - - - - - + - - - + - - - - - + - - - + - - - - - + - - - + - - - - - + - - - + - - - - - + - - - + - - - - -
    NameTypeSinceDescription
    Description
    <allowEmptyFormMapping><allowEmptyFormMapping> boolean-Whether task and process instantiation form mapping is required at build time or not. Only Enterprise edition may update the form mapping at runtime. Default to false
    Default value is: false.
    User property is: bonita.allowEmptyFormMapping.
    Whether task and process instantiation form mapping is required at build time or not. Only Enterprise edition may update the form mapping at runtime. Default to false
    Default: false
    User Property: bonita.allowEmptyFormMapping
    <configurationFileName><configurationFileName> String-The name of the Bonita configuration file name. Default is ${project.artifactId}-${project.version}-${bonita.environment}.bconf
    User property is: bonita.configurationFile.
    The name of the Bonita configuration file name. Default is ${project.artifactId}-${project.version}-${bonita.environment}.bconf
    User Property: bonita.configurationFile
    <environment><environment> String-The configuration environment. Default to Local.
    Default value is: local.
    User property is: bonita.environment.
    The configuration environment. Default to Local.
    Default: local
    User Property: bonita.environment
    <excludes><excludes> String[]-List of process diagram files to exclude.
    User property is: proc.excludes.
    List of process diagram files to exclude.
    User Property: proc.excludes
    <includeParameters><includeParameters> boolean-Whether process parameter values are embedded in the Business archive file or not. Only Enterprise edition may update the parameters values at runtime. Default to true
    Default value is: false.
    User property is: bonita.includeParameters.
    Whether process parameter values are embedded in the Business archive file or not. Only Enterprise edition may update the parameters values at runtime. Default to true
    Default: false
    User Property: bonita.includeParameters
    <includes><includes> String[]-List of process diagram files to include.
    User property is: proc.includes.
    List of process diagram files to include.
    User Property: proc.includes
    <migrateIfNeeded><migrateIfNeeded> boolean-Whether process diagram files should try to migrate their content if needed or not. Default to false
    Default value is: false.
    User property is: bonita.migrateIfNeeded.
    Whether process diagram files should try to migrate their content if needed or not. Default to false
    Default: false
    User Property: bonita.migrateIfNeeded
    <outputDirectory><outputDirectory> File-The build output directory. Default to ${project.build.directory}
    Default value is: ${project.build.directory}.
    User property is: outputDirectory.
    The build output directory. Default to ${project.build.directory}
    Default: ${project.build.directory}
    User Property: outputDirectory
    <uidWorkspace><uidWorkspace> Map<String,String>-Specify the UI Designer workspace locations. workspacePath : Default to ${project.basedir} pagesFolderName : Default to web_page fragmentsFolderName : Default to web_fragments widgetsFolderName : Default to web_widgets
    User property is: uid.workspace.
    -
    -
    -

    Parameter Details

    -
    -

    <allowEmptyFormMapping>

    - +Specify the UI Designer workspace locations. workspacePath : Default to ${project.basedir} pagesFolderName : Default to web_page fragmentsFolderName : Default to web_fragments widgetsFolderName : Default to web_widgets
    User Property: uid.workspace
    +

    Parameter Details

    +

    <allowEmptyFormMapping>

    Whether task and process instantiation form mapping is required at build time or not. Only Enterprise edition may update the form mapping at runtime. Default to false
    -
      - -
    • Type: boolean
      • - -
    • Required: No
      • - -
    • User Property: bonita.allowEmptyFormMapping
      • - -
    • Default: false
      • -
    -

    <configurationFileName>

    - +
  • Type: boolean
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: bonita.allowEmptyFormMapping
    • +
  • Default: false
    • +

    <configurationFileName>

    The name of the Bonita configuration file name. Default is ${project.artifactId}-${project.version}-${bonita.environment}.bconf
    -
      - -
    • Type: java.lang.String
      • - -
    • Required: No
      • - -
    • User Property: bonita.configurationFile
      • -
    -

    <environment>

    - +
  • Type: java.lang.String
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: bonita.configurationFile
    • +

    <environment>

    The configuration environment. Default to Local.
    -
      - -
    • Type: java.lang.String
      • - -
    • Required: No
      • - -
    • User Property: bonita.environment
      • - -
    • Default: local
      • -
    -

    <excludes>

    - +
  • Type: java.lang.String
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: bonita.environment
    • +
  • Default: local
    • +

    <excludes>

    List of process diagram files to exclude.
    -
      - -
    • Type: java.lang.String[]
      • - -
    • Required: No
      • - -
    • User Property: proc.excludes
      • -
    -

    <includeParameters>

    - +
  • Type: java.lang.String[]
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: proc.excludes
    • +

    <includeParameters>

    Whether process parameter values are embedded in the Business archive file or not. Only Enterprise edition may update the parameters values at runtime. Default to true
    -
      - -
    • Type: boolean
      • - -
    • Required: No
      • - -
    • User Property: bonita.includeParameters
      • - -
    • Default: false
      • -
    -

    <includes>

    - +
  • Type: boolean
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: bonita.includeParameters
    • +
  • Default: false
    • +

    <includes>

    List of process diagram files to include.
    -
      - -
    • Type: java.lang.String[]
      • - -
    • Required: No
      • - -
    • User Property: proc.includes
      • -
    -

    <migrateIfNeeded>

    - +
  • Type: java.lang.String[]
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: proc.includes
    • +

    <migrateIfNeeded>

    Whether process diagram files should try to migrate their content if needed or not. Default to false
    -
      - -
    • Type: boolean
      • - -
    • Required: No
      • - -
    • User Property: bonita.migrateIfNeeded
      • - -
    • Default: false
      • -
    -

    <outputDirectory>

    - +
  • Type: boolean
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: bonita.migrateIfNeeded
    • +
  • Default: false
    • +

    <outputDirectory>

    The build output directory. Default to ${project.build.directory}
    -
      - -
    • Type: java.io.File
      • - -
    • Required: No
      • - -
    • User Property: outputDirectory
      • - -
    • Default: ${project.build.directory}
      • -
    -

    <uidWorkspace>

    - -
    Specify the UI Designer workspace locations. workspacePath : Default to ${project.basedir} pagesFolderName : Default to web_page fragmentsFolderName : Default to web_fragments widgetsFolderName : Default to web_widgets
    - +
  • Type: java.io.File
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: outputDirectory
    • +
  • Default: ${project.build.directory}
    • +

    <uidWorkspace>

    +
    Specify the UI Designer workspace locations. workspacePath : Default to ${project.basedir} pagesFolderName : Default to web_page fragmentsFolderName : Default to web_fragments widgetsFolderName : Default to web_widgets
      - -
    • Type: java.util.Map<java.lang.String, java.lang.String>
      • - -
    • Required: No
      • - -
    • User Property: uid.workspace
      • -
    -
    -
    - - +
  • Type: java.util.Map<java.lang.String, java.lang.String>
    • +
  • Required: report.plugin.goal.no
    • +
  • User Property: uid.workspace
    • diff --git a/ci-management.html b/ci-management.html index bf1f851..5deb2ac 100644 --- a/ci-management.html +++ b/ci-management.html @@ -2,7 +2,7 @@ @@ -30,8 +30,8 @@ diff --git a/create-bdm-module-mojo.html b/create-bdm-module-mojo.html index dc4a072..4d8c951 100644 --- a/create-bdm-module-mojo.html +++ b/create-bdm-module-mojo.html @@ -2,7 +2,7 @@ @@ -30,8 +30,8 @@
    - - -
    -

    bonita-project:create-bdm-module

    - -

    Full name:

    - -

    org.bonitasoft.maven:bonita-project-maven-plugin:1.0.0-beta-02:create-bdm-module

    - -

    Description:

    - -
    This mojo creates a bdm module and its submodules in the current project with a Business Object Model descriptor sample file.
    - -

    Attributes:

    - +
    +

    bonita-project:create-bdm-module

    +

    Full name:

    +

    org.bonitasoft.maven:bonita-project-maven-plugin:1.0.0:create-bdm-module

    +

    Description:

    +

    This mojo creates a bdm module and its submodules in the current project with a Business Object Model descriptor sample file.

    +

    Attributes:

      -
    • Requires a Maven project to be executed.
      • - -
    • The goal is not marked as thread-safe and thus does not support parallel builds.
      • -
    -
    -

    Required Parameters

    - +
  • The goal is not marked as thread-safe and thus does not support parallel builds.
    • +

    Required Parameters

    - - - - - - - - + - - - + - - - - -
    NameTypeSinceDescription
    Description
    <bonitaProjectId><bonitaProjectId> String-Specify the Bonita project id that will determine the artifact ids of the generated modules. This id must be consistent with the parent project.
    User property is: bonitaProjectId.
    -
    -
    -

    Parameter Details

    -
    -

    <bonitaProjectId>

    - +Specify the Bonita project id that will determine the artifact ids of the generated modules. This id must be consistent with the parent project.
    User Property: bonitaProjectId
    +

    Parameter Details

    +

    <bonitaProjectId>

    Specify the Bonita project id that will determine the artifact ids of the generated modules. This id must be consistent with the parent project.
    -
      - -
    • Type: java.lang.String
      • - -
    • Required: Yes
      • - -
    • User Property: bonitaProjectId
      • -
    -
    -
    - - +
  • Type: java.lang.String
    • +
  • Required: report.plugin.goal.yes
    • +
  • User Property: bonitaProjectId
    • diff --git a/create-extensions-module-mojo.html b/create-extensions-module-mojo.html index ad10d58..25bbd5d 100644 --- a/create-extensions-module-mojo.html +++ b/create-extensions-module-mojo.html @@ -2,7 +2,7 @@ @@ -30,8 +30,8 @@
    - - -
    -

    bonita-project:create-extensions-module

    - -

    Full name:

    - -

    org.bonitasoft.maven:bonita-project-maven-plugin:1.0.0-beta-02:create-extensions-module

    - -

    Description:

    - -
    This mojo creates an extensions module in the current project.
    - -

    Attributes:

    - +
    +

    bonita-project:create-extensions-module

    +

    Full name:

    +

    org.bonitasoft.maven:bonita-project-maven-plugin:1.0.0:create-extensions-module

    +

    Description:

    +

    This mojo creates an extensions module in the current project.

    +

    Attributes:

      -
    • Requires a Maven project to be executed.
      • - -
    • The goal is not marked as thread-safe and thus does not support parallel builds.
      • -
    -
    -

    Required Parameters

    - +
  • The goal is not marked as thread-safe and thus does not support parallel builds.
    • +

    Required Parameters

    - - - - - - - - + - - - + - - - - -
    NameTypeSinceDescription
    Description
    <bonitaProjectId><bonitaProjectId> String-Specify the Bonita project id that will determine the artifact ids of the generated modules. This id must be consistent with the parent project.
    User property is: bonitaProjectId.
    -
    -
    -

    Parameter Details

    -
    -

    <bonitaProjectId>

    - +Specify the Bonita project id that will determine the artifact ids of the generated modules. This id must be consistent with the parent project.
    User Property: bonitaProjectId
    +

    Parameter Details

    +

    <bonitaProjectId>

    Specify the Bonita project id that will determine the artifact ids of the generated modules. This id must be consistent with the parent project.
    -
      - -
    • Type: java.lang.String
      • - -
    • Required: Yes
      • - -
    • User Property: bonitaProjectId
      • -
    -
    -
    - - +
  • Type: java.lang.String
    • +
  • Required: report.plugin.goal.yes
    • +
  • User Property: bonitaProjectId
    • diff --git a/dependencies.html b/dependencies.html index 9b7d4a1..399af8d 100644 --- a/dependencies.html +++ b/dependencies.html @@ -2,7 +2,7 @@ @@ -30,8 +30,8 @@