modules/kogito-maven/common/module.yaml

#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
#
schema_version: 1
name: org.kie.kogito.maven.common
version: "main"

envs:
  - name: "MAVEN_VERSION"
    description: "The Maven version to setup with this module"
  - name: "MAVEN_HOME"
    value: "/usr/share/maven"
  - name: "MAVEN_SETTINGS_PATH"
    description: "The location of the settings.xml file"
    value: '${KOGITO_HOME}/.m2/settings.xml'
  - name: "HTTP_PROXY"
    description: "The location of the http proxy, will be used for both Maven builds and Java runtime."
    example: "http://127.0.0.1:8080"
  - name: "HTTP_PROXY_HOST"
    description: "Proxy Host, don't need to be set if HTTP_PROXY is used."
    example: "127.0.0.1"
  - name: "HTTP_PROXY_PORT"
    description: "Proxy Port, don't need to be set if HTTP_PROXY is used."
    example: "8181"
  - name: "HTTP_PROXY_PASSWORD"
    description: "Proxy Password"
  - name: "HTTP_PROXY_USERNAME"
    description: "Proxy Username"
  - name: "HTTP_PROXY_NONPROXYHOSTS"
    description: "Non proxy hosts, list of hosts that will ot be proxied."
    example: "localhost"
  - name: "MAVEN_MIRROR_URL"
    description: "The base URL of a mirror used for retrieving artifacts."
    example: "http://10.0.0.1:8080/repository/internal/"
  - name: "MAVEN_DOWNLOAD_OUTPUT"
    description: "If set to true will print the transfer logs for downloading/uploading of maven dependencies. Defaults to false"
    example: "true"
  - name: "DEFAULT_MAVEN_REPO_URL"
    value: "https://repository.apache.org/content/groups/public/"
    description: "Defines the default Maven repository for Kogito artifacts."
  - name: "MAVEN_REPO_URL"
    description: "Defines an extra Maven repository."
    example: "https://nexus.test.com/group/public"
  - name: "MAVEN_REPO_ID"
    description: "Defines the id of the new Repository"
    example: "nexus-test"
  - name: "MAVEN_REPO_LAYOUT"
    description: "The type of layout this repository uses for locating and storing artifacts - can be 'legacy' or 'default'.Defaults to 'default'."
    example: "legacy"
  - name: "MAVEN_REPO_RELEASES_ENABLED"
    description: "Whether to use this repository for downloading this type of artifact. Default value is: true."
    example: "false"
  - name: "MAVEN_REPO_RELEASES_UPDATE_POLICY"
    description: "The frequency for downloading updates - can be 'always', 'daily', 'interval:XXX' (in minutes) or 'never'. Defaults to always."
    example: "never"
  - name: "MAVEN_REPO_RELEASES_CHECKSUM_POLICY"
    description: "What to do when verification of an artifact checksum fails - warn, fail, etc. Valid values are 'fail' or 'warn'. Defaults to warn"
    example: "fail"
  - name: "MAVEN_REPO_SNAPSHOTS_ENABLED"
    description: "Whether to use this repository for downloading this type of artifact. Default value is: true."
    example: "false"
  - name: "MAVEN_REPO_SNAPSHOTS_UPDATE_POLICY"
    description: "The frequency for downloading updates - can be 'always', 'daily', 'interval:XXX' (in minutes) or 'never'. Defaults to always."
    example: "never"
  - name: "MAVEN_REPO_SNAPSHOTS_CHECKSUM_POLICY"
    description: "What to do when verification of an artifact checksum fails - warn, fail, etc. Valid values are 'fail' or 'warn'. Defaults to warn"
    example: "fail"
  - name: "MAVEN_REPOS"
    description: "Used to define multiple repositories, this env defines a prefix that will be used to create different repositories."
    example: "CENTRAL,INTERNAL"
  - name: "MAVEN_IGNORE_SELF_SIGNED_CERTIFICATE"
    description: "When set, use of relaxed SSL check for user generated certificates. Default value is false"
    example: "true"
  - name: "MAVEN_OFFLINE_MODE"
    description: "When set to true, tells Maven to work in offline mode. See Maven `-o` option for more information."
    example: "true"

execute:
  - script: configure