This is an automated email from the ASF dual-hosted git repository.
tiagobento pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-kie-tools.git
The following commit(s) were added to refs/heads/main by this push:
new 105e7d3d75b kie-issues#243: Fill the "description" of every env var on
`kie-tools` build and save the report somewhere (1/2) (#2421)
105e7d3d75b is described below
commit 105e7d3d75b7d7bbefbc2998ea82b651bebd8cd5
Author: Tiago Bento <[email protected]>
AuthorDate: Tue Jun 18 18:19:28 2024 -0400
kie-issues#243: Fill the "description" of every env var on `kie-tools`
build and save the report somewhere (1/2) (#2421)
---
.ci/jenkins/Jenkinsfile.daily-dev-publish | 28 +-
.ci/jenkins/release-jobs/Jenkinsfile.cors-proxy | 4 +-
.../Jenkinsfile.dashbuilder-viewer-image | 4 +-
.ci/jenkins/release-jobs/Jenkinsfile.kie-sandbox | 4 +-
.../Jenkinsfile.kie-sandbox-extended-services | 4 +-
...e.serverless-logic-web-tools-base-builder-image | 4 +-
...le.serverless-logic-web-tools-swf-builder-image | 4 +-
...e.serverless-logic-web-tools-swf-dev-mode-image | 4 +-
.ci/jenkins/shared-scripts/buildUtils.groovy | 1 -
.../commit-message-validation-service/env/index.js | 2 +-
.../env/index.js | 2 +-
.../jbpm-compact-architecture-example/env/index.js | 12 +-
.../env/index.js | 2 +-
.../env/index.js | 8 +-
.../env/index.js | 8 +-
packages/cors-proxy-image/README.md | 16 +-
packages/cors-proxy-image/env/index.js | 18 +-
packages/cors-proxy-image/package.json | 3 +-
packages/dashbuilder-viewer-image-env/env/index.js | 15 +-
packages/dashbuilder-viewer-image/env/index.js | 26 +-
packages/dashbuilder-viewer-image/package.json | 6 +-
packages/dev-deployment-base-image/env/index.js | 8 +-
packages/dev-deployment-base-image/package.json | 1 -
.../env/index.js | 8 +-
.../package.json | 1 -
.../env/index.js | 8 +-
.../package.json | 1 -
.../dev-deployment-upload-service/env/index.js | 6 +-
packages/extended-services/env/index.js | 4 +-
packages/feel-input-component/env/index.js | 2 +-
packages/image-builder/README.md | 2 +-
packages/image-builder/src/bin.ts | 2 +-
packages/kie-sandbox-distribution/env/index.js | 42 +--
packages/kie-sandbox-distribution/package.json | 2 +-
.../kie-sandbox-extended-services-image/README.md | 16 +-
.../env/index.js | 21 +-
.../package.json | 3 +-
packages/kie-sandbox-helm-chart/README.md | 3 +-
packages/kie-sandbox-helm-chart/env/index.js | 8 +-
packages/kie-sandbox-webapp-image/README.md | 16 +-
packages/kie-sandbox-webapp-image/env/index.js | 14 +-
packages/kie-sandbox-webapp-image/package.json | 3 +-
packages/kogito-management-console/README.md | 14 +-
packages/kogito-management-console/env/index.js | 10 +-
packages/kogito-management-console/package.json | 3 +-
packages/kogito-task-console/README.md | 14 +-
packages/kogito-task-console/env/index.js | 10 +-
packages/kogito-task-console/package.json | 3 +-
packages/maven-base/env/index.js | 2 +-
packages/maven-m2-repo-via-http-image/env/index.js | 8 +-
packages/online-editor/env/index.js | 326 ++++++++++-----------
packages/playwright-base/env/index.js | 2 +-
.../env/index.js | 15 +-
.../env/index.js | 52 ++--
.../package.json | 3 +-
.../env/index.js | 15 +-
.../env/index.js | 5 -
.../package.json | 3 +-
.../env/index.js | 15 +-
.../env/index.js | 5 -
.../package.json | 5 +-
packages/sonataflow-builder-image/README.md | 8 +-
packages/sonataflow-devmode-image/README.md | 8 +-
packages/sonataflow-devmode-image/env/index.js | 8 +-
packages/sonataflow-image-common/README.md | 2 +-
packages/sonataflow-operator/env/index.js | 8 +-
packages/webpack-base/env/index.js | 12 +-
scripts/bootstrap/bootstrap.js | 4 +-
...d_env_report.mjs => print_build_env_report.mjs} | 23 +-
scripts/build-env/README.md | 18 +-
scripts/build-env/src/bin.ts | 20 +-
scripts/build-env/src/console_logs.ts | 2 +-
scripts/build-env/src/lib.ts | 16 +-
scripts/build-env/src/special_print_cases.ts | 38 ++-
scripts/build-env/src/static_print_cases.ts | 83 ++++++
75 files changed, 554 insertions(+), 552 deletions(-)
diff --git a/.ci/jenkins/Jenkinsfile.daily-dev-publish
b/.ci/jenkins/Jenkinsfile.daily-dev-publish
index d14b25e51b7..d4ac87521b7 100644
--- a/.ci/jenkins/Jenkinsfile.daily-dev-publish
+++ b/.ci/jenkins/Jenkinsfile.daily-dev-publish
@@ -72,17 +72,17 @@ pipeline {
KIE_SANDBOX_WEBAPP_IMAGE__imageRegistry = 'docker.io'
KIE_SANDBOX_WEBAPP_IMAGE__imageAccount = 'apache'
KIE_SANDBOX_WEBAPP_IMAGE__imageName = 'incubator-kie-sandbox-webapp'
- KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTags = 'daily-dev'
+ KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTag = 'daily-dev'
KIE_SANDBOX_EXTENDED_SERVICES__imageRegistry = 'docker.io'
KIE_SANDBOX_EXTENDED_SERVICES__imageAccount = 'apache'
KIE_SANDBOX_EXTENDED_SERVICES__imageName =
'incubator-kie-sandbox-extended-services'
- KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTags = 'daily-dev'
+ KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTag = 'daily-dev'
CORS_PROXY_IMAGE__imageRegistry = 'docker.io'
CORS_PROXY_IMAGE__imageAccount = 'apache'
CORS_PROXY_IMAGE__imageName = 'incubator-kie-cors-proxy'
- CORS_PROXY_IMAGE__imageBuildTags = 'daily-dev'
+ CORS_PROXY_IMAGE__imageBuildTag = 'daily-dev'
KIE_SANDBOX_HELM_CHART__registry = 'docker.io'
KIE_SANDBOX_HELM_CHART__account = 'apache'
@@ -96,24 +96,24 @@ pipeline {
DASHBUILDER__viewerImageRegistry = 'docker.io'
DASHBUILDER__viewerImageAccount = 'apache'
DASHBUILDER__viewerImageName = 'incubator-kie-dashbuilder-viewer'
- DASHBUILDER__viewerImageBuildTags = 'daily-dev'
+ DASHBUILDER__viewerImageBuildTag = 'daily-dev'
SERVERLESS_LOGIC_WEB_TOOLS__dashbuilderViewerImageTag = 'daily-dev'
SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageRegistry = 'docker.io'
SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageAccount = 'apache'
SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageName =
'incubator-kie-serverless-logic-web-tools-swf-builder'
SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageTag = 'daily-dev'
- SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTags = 'daily-dev'
+ SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTag = 'daily-dev'
SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageRegistry = 'docker.io'
SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageAccount = 'apache'
SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageName =
'incubator-kie-serverless-logic-web-tools-base-builder'
SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageTag = 'daily-dev'
- SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTags = 'daily-dev'
+ SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTag = 'daily-dev'
SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageRegistry = 'docker.io'
SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageAccount = 'apache'
SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageName =
'incubator-kie-serverless-logic-web-tools-swf-dev-mode'
SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageTag = 'daily-dev'
- SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTags = 'daily-dev'
+ SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTag = 'daily-dev'
SERVERLESS_LOGIC_WEB_TOOLS__corsProxyUrl =
'https://daily-dev-cors-proxy-kie-sandbox.rhba-0ad6762cc85bcef5745bb684498c2436-0000.us-south.containers.appdomain.cloud'
KOGITO_TASK_CONSOLE__registry = 'docker.io'
@@ -331,7 +331,7 @@ pipeline {
"${env.KIE_SANDBOX_EXTENDED_SERVICES__imageRegistry}",
"${env.KIE_SANDBOX_EXTENDED_SERVICES__imageAccount}",
"${env.KIE_SANDBOX_EXTENDED_SERVICES__imageName}",
- "${env.KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTags}",
+ "${env.KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
@@ -364,7 +364,7 @@ pipeline {
"${env.CORS_PROXY_IMAGE__imageRegistry}",
"${env.CORS_PROXY_IMAGE__imageAccount}",
"${env.CORS_PROXY_IMAGE__imageName}",
- "${env.CORS_PROXY_IMAGE__imageBuildTags}",
+ "${env.CORS_PROXY_IMAGE__imageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
@@ -397,7 +397,7 @@ pipeline {
"${env.KIE_SANDBOX_WEBAPP_IMAGE__imageRegistry}",
"${env.KIE_SANDBOX_WEBAPP_IMAGE__imageAccount}",
"${env.KIE_SANDBOX_WEBAPP_IMAGE__imageName}",
- "${env.KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTags}",
+ "${env.KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
@@ -438,7 +438,7 @@ pipeline {
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageRegistry}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageAccount}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageName}",
-
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTags}",
+
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
@@ -453,7 +453,7 @@ pipeline {
"${env.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageRegistry}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageAccount}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageName}",
-
"${env.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTags}",
+
"${env.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
@@ -468,7 +468,7 @@ pipeline {
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageRegistry}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageAccount}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageName}",
-
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTags}",
+
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
@@ -483,7 +483,7 @@ pipeline {
"${env.DASHBUILDER__viewerImageRegistry}",
"${env.DASHBUILDER__viewerImageAccount}",
"${env.DASHBUILDER__viewerImageName}",
- "${env.DASHBUILDER__viewerImageBuildTags}",
+ "${env.DASHBUILDER__viewerImageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
diff --git a/.ci/jenkins/release-jobs/Jenkinsfile.cors-proxy
b/.ci/jenkins/release-jobs/Jenkinsfile.cors-proxy
index 69968eee694..b19cd5c4c9f 100644
--- a/.ci/jenkins/release-jobs/Jenkinsfile.cors-proxy
+++ b/.ci/jenkins/release-jobs/Jenkinsfile.cors-proxy
@@ -47,7 +47,7 @@ pipeline {
CORS_PROXY_IMAGE__imageRegistry = 'docker.io'
CORS_PROXY_IMAGE__imageAccount = 'apache'
CORS_PROXY_IMAGE__imageName = 'incubator-kie-cors-proxy'
- CORS_PROXY_IMAGE__imageBuildTags = "latest ${params.RELEASE_VERSION}"
+ CORS_PROXY_IMAGE__imageBuildTag = "${params.RELEASE_VERSION}"
RELEASE_ARTIFACTS_DIR = "${WORKSPACE}/release-artifacts"
@@ -148,7 +148,7 @@ pipeline {
"${env.CORS_PROXY_IMAGE__imageRegistry}",
"${env.CORS_PROXY_IMAGE__imageAccount}",
"${env.CORS_PROXY_IMAGE__imageName}",
- "${env.CORS_PROXY_IMAGE__imageBuildTags}",
+ "${env.CORS_PROXY_IMAGE__imageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
diff --git a/.ci/jenkins/release-jobs/Jenkinsfile.dashbuilder-viewer-image
b/.ci/jenkins/release-jobs/Jenkinsfile.dashbuilder-viewer-image
index 6a2c368ce45..2d21fb179c5 100644
--- a/.ci/jenkins/release-jobs/Jenkinsfile.dashbuilder-viewer-image
+++ b/.ci/jenkins/release-jobs/Jenkinsfile.dashbuilder-viewer-image
@@ -43,7 +43,7 @@ pipeline {
DASHBUILDER__viewerImageRegistry = 'docker.io'
DASHBUILDER__viewerImageAccount = 'apache'
DASHBUILDER__viewerImageName = 'incubator-kie-dashbuilder-viewer'
- DASHBUILDER__viewerImageBuildTags = "latest ${params.RELEASE_VERSION}"
+ DASHBUILDER__viewerImageBuildTag = "${params.RELEASE_VERSION}"
RELEASE_ARTIFACTS_DIR = "${WORKSPACE}/release-artifacts"
@@ -143,7 +143,7 @@ pipeline {
"${env.DASHBUILDER__viewerImageRegistry}",
"${env.DASHBUILDER__viewerImageAccount}",
"${env.DASHBUILDER__viewerImageName}",
- "${env.DASHBUILDER__viewerImageBuildTags}",
+ "${env.DASHBUILDER__viewerImageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
diff --git a/.ci/jenkins/release-jobs/Jenkinsfile.kie-sandbox
b/.ci/jenkins/release-jobs/Jenkinsfile.kie-sandbox
index a2fed5c4f11..bdc7099a9df 100644
--- a/.ci/jenkins/release-jobs/Jenkinsfile.kie-sandbox
+++ b/.ci/jenkins/release-jobs/Jenkinsfile.kie-sandbox
@@ -49,7 +49,7 @@ pipeline {
KIE_SANDBOX_WEBAPP_IMAGE__imageRegistry = 'docker.io'
KIE_SANDBOX_WEBAPP_IMAGE__imageAccount = 'apache'
KIE_SANDBOX_WEBAPP_IMAGE__imageName = 'incubator-kie-sandbox-webapp'
- KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTags = "latest
${params.RELEASE_VERSION}"
+ KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTag = "${params.RELEASE_VERSION}"
ONLINE_EDITOR__buildInfo = "${params.RELEASE_VERSION}"
ONLINE_EDITOR__extendedServicesDownloadUrlLinux =
"https://github.com/apache/incubator-kie-tools/releases/download/${params.RELEASE_VERSION}/kie_sandbox_extended_services_linux_${params.RELEASE_VERSION}.tar.gz";
ONLINE_EDITOR__extendedServicesDownloadUrlMacOs =
"https://github.com/apache/incubator-kie-tools/releases/download/${params.RELEASE_VERSION}/kie_sandbox_extended_services_macos_${params.RELEASE_VERSION}.dmg";
@@ -164,7 +164,7 @@ pipeline {
"${env.KIE_SANDBOX_WEBAPP_IMAGE__imageRegistry}",
"${env.KIE_SANDBOX_WEBAPP_IMAGE__imageAccount}",
"${env.KIE_SANDBOX_WEBAPP_IMAGE__imageName}",
- "${env.KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTags}",
+ "${env.KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
diff --git a/.ci/jenkins/release-jobs/Jenkinsfile.kie-sandbox-extended-services
b/.ci/jenkins/release-jobs/Jenkinsfile.kie-sandbox-extended-services
index 80178ceff84..9ea29dc2f65 100644
--- a/.ci/jenkins/release-jobs/Jenkinsfile.kie-sandbox-extended-services
+++ b/.ci/jenkins/release-jobs/Jenkinsfile.kie-sandbox-extended-services
@@ -47,7 +47,7 @@ pipeline {
KIE_SANDBOX_EXTENDED_SERVICES__imageRegistry = 'docker.io'
KIE_SANDBOX_EXTENDED_SERVICES__imageAccount = 'apache'
KIE_SANDBOX_EXTENDED_SERVICES__imageName =
'incubator-kie-sandbox-extended-services'
- KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTags = "latest
${params.RELEASE_VERSION}"
+ KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTag =
"${params.RELEASE_VERSION}"
RELEASE_ARTIFACTS_DIR = "${WORKSPACE}/release-artifacts"
@@ -148,7 +148,7 @@ pipeline {
"${env.KIE_SANDBOX_EXTENDED_SERVICES__imageRegistry}",
"${env.KIE_SANDBOX_EXTENDED_SERVICES__imageAccount}",
"${env.KIE_SANDBOX_EXTENDED_SERVICES__imageName}",
- "${env.KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTags}",
+ "${env.KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
diff --git
a/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-base-builder-image
b/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-base-builder-image
index 2face5f95b4..4d45d7615a5 100644
---
a/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-base-builder-image
+++
b/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-base-builder-image
@@ -43,7 +43,7 @@ pipeline {
SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageRegistry = 'docker.io'
SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageAccount = 'apache'
SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageName =
'incubator-kie-serverless-logic-web-tools-base-builder'
- SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTags = "latest
${params.RELEASE_VERSION}"
+ SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTag =
"${params.RELEASE_VERSION}"
RELEASE_ARTIFACTS_DIR = "${WORKSPACE}/release-artifacts"
@@ -143,7 +143,7 @@ pipeline {
"${env.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageRegistry}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageAccount}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageName}",
-
"${env.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTags}",
+
"${env.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
diff --git
a/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-swf-builder-image
b/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-swf-builder-image
index cf0b4e42d55..74db245e19d 100644
---
a/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-swf-builder-image
+++
b/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-swf-builder-image
@@ -43,7 +43,7 @@ pipeline {
SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageRegistry = 'docker.io'
SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageAccount = 'apache'
SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageName =
'incubator-kie-serverless-logic-web-tools-swf-builder'
- SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTags = "latest
${params.RELEASE_VERSION}"
+ SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTag =
"${params.RELEASE_VERSION}"
RELEASE_ARTIFACTS_DIR = "${WORKSPACE}/release-artifacts"
@@ -143,7 +143,7 @@ pipeline {
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageRegistry}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageAccount}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageName}",
-
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTags}",
+
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
diff --git
a/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-swf-dev-mode-image
b/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-swf-dev-mode-image
index 26208d02a10..f8a8599fed7 100644
---
a/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-swf-dev-mode-image
+++
b/.ci/jenkins/release-jobs/Jenkinsfile.serverless-logic-web-tools-swf-dev-mode-image
@@ -43,7 +43,7 @@ pipeline {
SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageRegistry = 'docker.io'
SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageAccount = 'apache'
SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageName =
'incubator-kie-serverless-logic-web-tools-swf-dev-mode'
- SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTags = "latest
${params.RELEASE_VERSION}"
+ SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTag =
"${params.RELEASE_VERSION}"
RELEASE_ARTIFACTS_DIR = "${WORKSPACE}/release-artifacts"
@@ -143,7 +143,7 @@ pipeline {
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageRegistry}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageAccount}",
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageName}",
-
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTags}",
+
"${env.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTag}",
"${pipelineVars.dockerHubUserCredentialsId}",
"${pipelineVars.dockerHubTokenCredentialsId}"
)
diff --git a/.ci/jenkins/shared-scripts/buildUtils.groovy
b/.ci/jenkins/shared-scripts/buildUtils.groovy
index 01902ab9a29..50733db8dbe 100644
--- a/.ci/jenkins/shared-scripts/buildUtils.groovy
+++ b/.ci/jenkins/shared-scripts/buildUtils.groovy
@@ -53,7 +53,6 @@ def setupPnpm() {
pnpm -r exec 'bash' '-c' 'echo -B > .mvn/maven.config'
pnpm -r exec 'bash' '-c' 'echo -ntp >> .mvn/maven.config'
pnpm -r exec 'bash' '-c' 'echo -Xmx2g > .mvn/jvm.config'
- pnpm -F *-image exec sed -i
's/\\("build:prod.*".*\\)podman:build\\(.*\\)/\\1docker:build\\2/g' package.json
""".trim()
}
diff --git a/examples/commit-message-validation-service/env/index.js
b/examples/commit-message-validation-service/env/index.js
index 03d2269c88d..fcc3cbe1dd7 100644
--- a/examples/commit-message-validation-service/env/index.js
+++ b/examples/commit-message-validation-service/env/index.js
@@ -23,7 +23,7 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
vars: varsWithName({
EXAMPLE_COMMIT_MESSAGE_VALIDATION_SERVICE__port: {
default: "8090",
- description: "Web server port",
+ description: "HTTP server port where the service will run at.",
},
EXAMPLE_COMMIT_MESSAGE_VALIDATION_SERVICE__validators: {
default: "Length:5-72;IssuePrefix:kie-issues#*",
diff --git a/examples/drools-process-usertasks-quarkus-example/env/index.js
b/examples/drools-process-usertasks-quarkus-example/env/index.js
index 3dd70a342fc..e1ec81e83c6 100644
--- a/examples/drools-process-usertasks-quarkus-example/env/index.js
+++ b/examples/drools-process-usertasks-quarkus-example/env/index.js
@@ -17,7 +17,7 @@
* under the License.
*/
-const { varsWithName, composeEnv, getOrDefault } =
require("@kie-tools-scripts/build-env");
+const { varsWithName, composeEnv } = require("@kie-tools-scripts/build-env");
module.exports = composeEnv([require("@kie-tools/root-env/env")], {
vars: varsWithName({}),
diff --git a/examples/jbpm-compact-architecture-example/env/index.js
b/examples/jbpm-compact-architecture-example/env/index.js
index 4b9f86d2fa6..a047ba465e4 100644
--- a/examples/jbpm-compact-architecture-example/env/index.js
+++ b/examples/jbpm-compact-architecture-example/env/index.js
@@ -20,22 +20,22 @@
const { varsWithName, composeEnv, getOrDefault } =
require("@kie-tools-scripts/build-env");
const {
- env: { kogitoManagementConsole: kogitoManagementConsoleEnv },
+ env: { kogitoManagementConsole: kogitoManagementConsoleImageEnv },
} = require("@kie-tools/kogito-management-console/env");
const {
- env: { kogitoTaskConsole: kogitoTaskConsoleEnv },
+ env: { kogitoTaskConsole: kogitoTaskConsoleImageEnv },
} = require("@kie-tools/kogito-task-console/env");
module.exports = composeEnv([require("@kie-tools/root-env/env")], {
vars: varsWithName({
JBPM_COMPACT_ARCHITECTURE_EXAMPLE__managementConsoleImage: {
- default:
`${kogitoManagementConsoleEnv.registry}/${kogitoManagementConsoleEnv.account}/${kogitoManagementConsoleEnv.name}:${kogitoManagementConsoleEnv.buildTag}`,
- description: "The image for the Kogito Management Console Image.",
+ default:
`${kogitoManagementConsoleImageEnv.registry}/${kogitoManagementConsoleImageEnv.account}/${kogitoManagementConsoleImageEnv.name}:${kogitoManagementConsoleImageEnv.buildTag}`,
+ description: "The image for the Kogito Management Console.",
},
JBPM_COMPACT_ARCHITECTURE_EXAMPLE__taskConsoleImage: {
- default:
`${kogitoTaskConsoleEnv.registry}/${kogitoTaskConsoleEnv.account}/${kogitoTaskConsoleEnv.name}:${kogitoTaskConsoleEnv.buildTag}`,
- description: "The image for the Kogito Task Console Image.",
+ default:
`${kogitoTaskConsoleImageEnv.registry}/${kogitoTaskConsoleImageEnv.account}/${kogitoTaskConsoleImageEnv.name}:${kogitoTaskConsoleImageEnv.buildTag}`,
+ description: "The image for the Kogito Task Console.",
},
}),
get env() {
diff --git a/examples/sonataflow-greeting-quarkus-example/env/index.js
b/examples/sonataflow-greeting-quarkus-example/env/index.js
index 7767297ccd4..ef7d8437cb0 100644
--- a/examples/sonataflow-greeting-quarkus-example/env/index.js
+++ b/examples/sonataflow-greeting-quarkus-example/env/index.js
@@ -17,7 +17,7 @@
* under the License.
*/
-const { varsWithName, composeEnv, getOrDefault } =
require("@kie-tools-scripts/build-env");
+const { varsWithName, composeEnv } = require("@kie-tools-scripts/build-env");
module.exports = composeEnv([require("@kie-tools/root-env/env")], {
vars: varsWithName({}),
diff --git a/packages/chrome-extension-pack-kogito-kie-editors/env/index.js
b/packages/chrome-extension-pack-kogito-kie-editors/env/index.js
index ef485322597..a18f76954ee 100644
--- a/packages/chrome-extension-pack-kogito-kie-editors/env/index.js
+++ b/packages/chrome-extension-pack-kogito-kie-editors/env/index.js
@@ -23,19 +23,19 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
vars: varsWithName({
CHROME_EXTENSION__routerTargetOrigin: {
default: "https://localhost:9000";,
- description: "",
+ description: "Route of resources such as Editors and other static
assets.",
},
CHROME_EXTENSION__routerRelativePath: {
default: "",
- description: "",
+ description: "Relative path to applied to
CHROME_EXTENSION__routerTargetOrigin when finding resources.",
},
CHROME_EXTENSION__onlineEditorUrl: {
default: "https://localhost:9001";,
- description: "",
+ description: "The URL pointing to another application that can open a
file or repo.",
},
CHROME_EXTENSION__manifestFile: {
default: "manifest.dev.json",
- description: "",
+ description: "Chrome Extension manifest file path relative to this
package's root dir.",
},
}),
get env() {
diff --git a/packages/chrome-extension-serverless-workflow-editor/env/index.js
b/packages/chrome-extension-serverless-workflow-editor/env/index.js
index 565ac93dc85..1ce2890da28 100644
--- a/packages/chrome-extension-serverless-workflow-editor/env/index.js
+++ b/packages/chrome-extension-serverless-workflow-editor/env/index.js
@@ -23,19 +23,19 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
vars: varsWithName({
SWF_CHROME_EXTENSION__routerTargetOrigin: {
default: "https://localhost:9000";,
- description: "",
+ description: "Route of resources such as Editors and other static
assets.",
},
SWF_CHROME_EXTENSION__routerRelativePath: {
default: "",
- description: "",
+ description: "Relative path to applied to
CHROME_EXTENSION__routerTargetOrigin when finding resources.",
},
SWF_CHROME_EXTENSION__manifestFile: {
default: "manifest.dev.json",
- description: "",
+ description: "Chrome Extension manifest file path relative to this
package's root dir.",
},
SWF_CHROME_EXTENSION__e2eTestingToken: {
default: "",
- description: "",
+ description: "GitHub token used to 'log-in' during E2E tests. 'Log-in'
will be skipeed if it is empty.",
},
}),
get env() {
diff --git a/packages/cors-proxy-image/README.md
b/packages/cors-proxy-image/README.md
index 2f2d02b97c4..a1850b53523 100644
--- a/packages/cors-proxy-image/README.md
+++ b/packages/cors-proxy-image/README.md
@@ -21,7 +21,7 @@ This package contains the `Containerfile` and scripts to
build a container image
## Additional requirements
-- docker or podman
+- docker
## Build
@@ -37,7 +37,7 @@ The image name, tags and port can be customized by setting
the following environ
$ export CORS_PROXY_IMAGE__imageRegistry=<registry>
$ export CORS_PROXY_IMAGE__imageAccount=<account>
$ export CORS_PROXY_IMAGE__imageName=<image-name>
-$ export CORS_PROXY_IMAGE__imageBuildTags=<image-tags>
+$ export CORS_PROXY_IMAGE__imageBuildTag=<image-tag>
$ export CORS_PROXY_IMAGE__imagePort=<port>
$ export CORS_PROXY_IMAGE__imageOrigin=<origin>
$ export CORS_PROXY_IMAGE__imageVerbose=<verbose>
@@ -57,12 +57,6 @@ Then check out the image:
$ docker images
```
-or
-
-```bash
-$ podman images
-```
-
## Run
Start up a new container with:
@@ -71,12 +65,6 @@ Start up a new container with:
$ docker run -p 8080:8080 -i --rm
docker.io/apache/incubator-kie-cors-proxy:latest
```
-or
-
-```bash
-$ podman run -p 8080:8080 -i --rm
docker.io/apache/incubator-kie-cors-proxy:latest
-```
-
The service will be up at http://localhost:8080
---
diff --git a/packages/cors-proxy-image/env/index.js
b/packages/cors-proxy-image/env/index.js
index ef504d5275b..3370b84838f 100644
--- a/packages/cors-proxy-image/env/index.js
+++ b/packages/cors-proxy-image/env/index.js
@@ -26,31 +26,31 @@ module.exports = composeEnv([rootEnv], {
vars: varsWithName({
CORS_PROXY_IMAGE__imageRegistry: {
default: "docker.io",
- description: "",
+ description: "E.g., `docker.io` or `quay.io`.",
},
CORS_PROXY_IMAGE__imageAccount: {
default: "apache",
- description: "",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
CORS_PROXY_IMAGE__imageName: {
default: "incubator-kie-cors-proxy",
- description: "",
+ description: "Name of the image itself.",
},
- CORS_PROXY_IMAGE__imageBuildTags: {
+ CORS_PROXY_IMAGE__imageBuildTag: {
default: rootEnv.env.root.streamName,
- description: "",
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
CORS_PROXY_IMAGE__imagePort: {
default: corsProxyEnv.env.corsProxy.dev.port,
- description: "",
+ description: "HTTP port where the CORS proxy will run inside this
image.",
},
CORS_PROXY_IMAGE__imageOrigin: {
default: corsProxyEnv.env.corsProxy.dev.origin,
- description: "",
+ description: "Origin to be used for the CORS proxy running inside this
image.",
},
CORS_PROXY_IMAGE__imageVerbose: {
default: false,
- description: "",
+ description: "Toggle verbose mode on the CORS proxy logs.",
},
}),
get env() {
@@ -60,7 +60,7 @@ module.exports = composeEnv([rootEnv], {
registry: getOrDefault(this.vars.CORS_PROXY_IMAGE__imageRegistry),
account: getOrDefault(this.vars.CORS_PROXY_IMAGE__imageAccount),
name: getOrDefault(this.vars.CORS_PROXY_IMAGE__imageName),
- buildTags: getOrDefault(this.vars.CORS_PROXY_IMAGE__imageBuildTags),
+ buildTag: getOrDefault(this.vars.CORS_PROXY_IMAGE__imageBuildTag),
port: getOrDefault(this.vars.CORS_PROXY_IMAGE__imagePort),
origin: getOrDefault(this.vars.CORS_PROXY_IMAGE__imageOrigin),
verbose: getOrDefault(this.vars.CORS_PROXY_IMAGE__imageVerbose),
diff --git a/packages/cors-proxy-image/package.json
b/packages/cors-proxy-image/package.json
index 398e3b4effd..0915d4ec041 100644
--- a/packages/cors-proxy-image/package.json
+++ b/packages/cors-proxy-image/package.json
@@ -19,8 +19,7 @@
"copy:cors-proxy-package": "run-script-os",
"copy:cors-proxy-package:linux:darwin": "cp -R
./node_modules/@kie-tools/cors-proxy/dist/ dist-dev/cors-proxy/",
"copy:cors-proxy-package:win32": "pnpm powershell \"Copy-Item -R
./node_modules/@kie-tools/cors-proxy/dist/ dist-dev/cors-proxy/\"",
- "docker:build": "kie-tools--image-builder build -r \"$(build-env
corsProxyImage.image.registry)\" -a \"$(build-env
corsProxyImage.image.account)\" -n \"$(build-env corsProxyImage.image.name)\"
-t \"$(build-env corsProxyImage.image.buildTags)\" --build-arg
\"CORS_PROXY_DEFAULT_HTTP_PORT=$(build-env corsProxyImage.image.port)\"
--build-arg \"CORS_PROXY_DEFAULT_ORIGIN=$(build-env
corsProxyImage.image.origin)\" --build-arg
\"CORS_PROXY_DEFAULT_VERBOSE=$(build-env corsProxyImage.image.ver [...]
- "podman:build": "kie-tools--image-builder build -r \"$(build-env
corsProxyImage.image.registry)\" -a \"$(build-env
corsProxyImage.image.account)\" -n \"$(build-env corsProxyImage.image.name)\"
-t \"$(build-env corsProxyImage.image.buildTags)\" --build-arg
\"CORS_PROXY_DEFAULT_HTTP_PORT=$(build-env corsProxyImage.image.port)\"
--build-arg \"CORS_PROXY_DEFAULT_ORIGIN=$(build-env
corsProxyImage.image.origin)\" --build-arg
\"CORS_PROXY_DEFAULT_VERBOSE=$(build-env corsProxyImage.image.ver [...]
+ "docker:build": "kie-tools--image-builder build -r \"$(build-env
corsProxyImage.image.registry)\" -a \"$(build-env
corsProxyImage.image.account)\" -n \"$(build-env corsProxyImage.image.name)\"
-t \"$(build-env corsProxyImage.image.buildTag)\" --build-arg
\"CORS_PROXY_DEFAULT_HTTP_PORT=$(build-env corsProxyImage.image.port)\"
--build-arg \"CORS_PROXY_DEFAULT_ORIGIN=$(build-env
corsProxyImage.image.origin)\" --build-arg
\"CORS_PROXY_DEFAULT_VERBOSE=$(build-env corsProxyImage.image.verbose)\""
},
"devDependencies": {
"@kie-tools/cors-proxy": "workspace:*",
diff --git a/packages/dashbuilder-viewer-image-env/env/index.js
b/packages/dashbuilder-viewer-image-env/env/index.js
index b98ed873a02..1b8d6dfc8f1 100644
--- a/packages/dashbuilder-viewer-image-env/env/index.js
+++ b/packages/dashbuilder-viewer-image-env/env/index.js
@@ -19,19 +19,25 @@
const { varsWithName, getOrDefault, composeEnv } =
require("@kie-tools-scripts/build-env");
-module.exports = composeEnv([require("@kie-tools/root-env/env")], {
+const rootEnv = require("@kie-tools/root-env/env");
+
+module.exports = composeEnv([rootEnv], {
vars: varsWithName({
DASHBUILDER__viewerImageRegistry: {
default: "docker.io",
- description: "",
+ description: "E.g., `docker.io` or `quay.io`.",
},
DASHBUILDER__viewerImageAccount: {
default: "apache",
- description: "",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
DASHBUILDER__viewerImageName: {
default: "incubator-kie-dashbuilder-viewer",
- description: "",
+ description: "Name of the image itself.",
+ },
+ DASHBUILDER__viewerImageBuildTag: {
+ default: rootEnv.env.root.streamName,
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
}),
get env() {
@@ -40,6 +46,7 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
registry: getOrDefault(this.vars.DASHBUILDER__viewerImageRegistry),
account: getOrDefault(this.vars.DASHBUILDER__viewerImageAccount),
name: getOrDefault(this.vars.DASHBUILDER__viewerImageName),
+ buildTag: getOrDefault(this.vars.DASHBUILDER__viewerImageBuildTag),
},
};
},
diff --git a/packages/dashbuilder-viewer-image/env/index.js
b/packages/dashbuilder-viewer-image/env/index.js
index cae54115b49..5399d704d98 100644
--- a/packages/dashbuilder-viewer-image/env/index.js
+++ b/packages/dashbuilder-viewer-image/env/index.js
@@ -17,22 +17,14 @@
* under the License.
*/
-const { varsWithName, getOrDefault, composeEnv } =
require("@kie-tools-scripts/build-env");
+const { varsWithName, composeEnv } = require("@kie-tools-scripts/build-env");
-const rootEnv = require("@kie-tools/root-env/env");
-
-module.exports = composeEnv([rootEnv,
require("@kie-tools/dashbuilder-viewer-image-env/env")], {
- vars: varsWithName({
- DASHBUILDER__viewerImageBuildTags: {
- default: rootEnv.env.root.streamName,
- description: "",
+module.exports = composeEnv(
+ [require("@kie-tools/root-env/env"),
require("@kie-tools/dashbuilder-viewer-image-env/env")],
+ {
+ vars: varsWithName({}),
+ get env() {
+ return {};
},
- }),
- get env() {
- return {
- dashbuilderViewerImage: {
- buildTags: getOrDefault(this.vars.DASHBUILDER__viewerImageBuildTags),
- },
- };
- },
-});
+ }
+);
diff --git a/packages/dashbuilder-viewer-image/package.json
b/packages/dashbuilder-viewer-image/package.json
index 8e6648b0683..2280d3d544c 100644
--- a/packages/dashbuilder-viewer-image/package.json
+++ b/packages/dashbuilder-viewer-image/package.json
@@ -14,15 +14,13 @@
},
"scripts": {
"build": "run-script-os",
- "build:darwin": "pnpm copy:assets && run-script-if --bool \"$(build-env
containerImages.build)\" --then \"pnpm image:docker:build\"",
"build:dev": "pnpm cleanup && pnpm build",
- "build:linux": "pnpm copy:assets && run-script-if --bool \"$(build-env
containerImages.build)\" --then \"pnpm image:podman:build\"",
+ "build:linux:darwin": "pnpm copy:assets && run-script-if --bool
\"$(build-env containerImages.build)\" --then \"pnpm image:docker:build\"",
"build:prod": "pnpm cleanup && pnpm build",
"build:win32": "echo \"Build not supported on Windows\"",
"cleanup": "rimraf dist-dev && mkdir dist-dev",
"copy:assets": "cp -R
./node_modules/@kie-tools/dashbuilder-viewer-deployment-webapp/dist/
./dist-dev/dashbuilder-viewer-deployment-webapp",
- "image:docker:build": "run-script-if --bool $([ $(command -v docker) ] &&
echo true || echo false) --then \"docker build $(echo $(build-env
dashbuilderViewerImage.buildTags) | xargs printf -- \"-t $(build-env
dashbuilderViewerImageEnv.registry)/$(build-env
dashbuilderViewerImageEnv.account)/$(build-env
dashbuilderViewerImageEnv.name):%s\n\" | xargs echo) .\" --else \"echo Docker
not found, skipping image build.\"",
- "image:podman:build": "run-script-if --bool $([ $(command -v podman) ] &&
echo true || echo false) --then \"podman build $(echo $(build-env
dashbuilderViewerImage.buildTags) | xargs printf -- \"-t $(build-env
dashbuilderViewerImageEnv.registry)/$(build-env
dashbuilderViewerImageEnv.account)/$(build-env
dashbuilderViewerImageEnv.name):%s\n\" | xargs echo) -f Containerfile\" --else
\"echo Podman not found, skipping image build.\""
+ "image:docker:build": "run-script-if --bool $([ $(command -v docker) ] &&
echo true || echo false) --then \"docker build $(echo $(build-env
dashbuilderViewerImageEnv.buildTag) | xargs printf -- \"-t $(build-env
dashbuilderViewerImageEnv.registry)/$(build-env
dashbuilderViewerImageEnv.account)/$(build-env
dashbuilderViewerImageEnv.name):%s\n\" | xargs echo) .\" --else \"echo Docker
not found, skipping image build.\""
},
"devDependencies": {
"@kie-tools/dashbuilder-viewer-deployment-webapp": "workspace:*",
diff --git a/packages/dev-deployment-base-image/env/index.js
b/packages/dev-deployment-base-image/env/index.js
index 41b68d50034..ff93e66e173 100644
--- a/packages/dev-deployment-base-image/env/index.js
+++ b/packages/dev-deployment-base-image/env/index.js
@@ -37,19 +37,19 @@ module.exports = composeEnv([rootEnv], {
},
DEV_DEPLOYMENT_BASE_IMAGE__registry: {
default: "docker.io",
- description: "The image registry.",
+ description: "E.g., `docker.io` or `quay.io`.",
},
DEV_DEPLOYMENT_BASE_IMAGE__account: {
default: "apache",
- description: "The image registry account.",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
DEV_DEPLOYMENT_BASE_IMAGE__name: {
default: "incubator-kie-sandbox-dev-deployment-base",
- description: "The image name.",
+ description: "Name of the image itself.",
},
DEV_DEPLOYMENT_BASE_IMAGE__buildTag: {
default: rootEnv.env.root.streamName,
- description: "The image tag.",
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
}),
get env() {
diff --git a/packages/dev-deployment-base-image/package.json
b/packages/dev-deployment-base-image/package.json
index f71582cdb89..8b2c7b9694f 100644
--- a/packages/dev-deployment-base-image/package.json
+++ b/packages/dev-deployment-base-image/package.json
@@ -24,7 +24,6 @@
"create-test-image:minikube": "kie-tools--image-builder minikube -r
\"$(build-env devDeploymentBaseImage.registry)\" -a \"$(build-env
devDeploymentBaseImage.account)\" -n \"$(build-env
devDeploymentBaseImage.name)\" -t \"$(build-env
devDeploymentBaseImage.buildTag)\" --build-arg BUILDER_IMAGE_ARG=\"$(build-env
devDeploymentBaseImage.builderImage)\"",
"create-test-image:openshift": "kie-tools--image-builder openshift -r
\"$(build-env devDeploymentBaseImage.registry)\" -a \"$(build-env
devDeploymentBaseImage.account)\" -n \"$(build-env
devDeploymentBaseImage.name)\" -t \"$(build-env
devDeploymentBaseImage.buildTag)\" --build-arg BUILDER_IMAGE_ARG=\"$(build-env
devDeploymentBaseImage.builderImage)\"",
"image:docker:build": "kie-tools--image-builder build -r \"$(build-env
devDeploymentBaseImage.registry)\" -a \"$(build-env
devDeploymentBaseImage.account)\" -n \"$(build-env
devDeploymentBaseImage.name)\" -t \"$(build-env
devDeploymentBaseImage.buildTag)\" --build-arg BUILDER_IMAGE_ARG=\"$(build-env
devDeploymentBaseImage.builderImage)\" --build-arg USER_ID_ARG=\"$(build-env
devDeploymentBaseImage.userId)\" --build-arg HOME_PATH_ARG=\"$(build-env
devDeploymentBaseImage.homePath)\"",
- "image:podman:build": "kie-tools--image-builder build -r \"$(build-env
devDeploymentBaseImage.registry)\" -a \"$(build-env
devDeploymentBaseImage.account)\" -n \"$(build-env
devDeploymentBaseImage.name)\" -t \"$(build-env
devDeploymentBaseImage.buildTag)\" --build-arg BUILDER_IMAGE_ARG=\"$(build-env
devDeploymentBaseImage.builderImage)\" --build-arg USER_ID_ARG=\"$(build-env
devDeploymentBaseImage.userId)\" --build-arg HOME_PATH_ARG=\"$(build-env
devDeploymentBaseImage.homePath)\" -e [...]
"install": "node install.js && pnpm install:mvnw",
"install:mvnw": "run-script-os",
"install:mvnw:darwin:linux": "mvn -e
org.apache.maven.plugins:maven-wrapper-plugin:3.3.0:wrapper",
diff --git a/packages/dev-deployment-dmn-form-webapp-image/env/index.js
b/packages/dev-deployment-dmn-form-webapp-image/env/index.js
index a10be8e74ae..29182759481 100644
--- a/packages/dev-deployment-dmn-form-webapp-image/env/index.js
+++ b/packages/dev-deployment-dmn-form-webapp-image/env/index.js
@@ -25,19 +25,19 @@ module.exports = composeEnv([rootEnv], {
vars: varsWithName({
DEV_DEPLOYMENT_DMN_FORM_WEBAPP_IMAGE__registry: {
default: "docker.io",
- description: "The image registry.",
+ description: "E.g., `docker.io` or `quay.io`.",
},
DEV_DEPLOYMENT_DMN_FORM_WEBAPP_IMAGE__account: {
default: "apache",
- description: "The image registry account.",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
DEV_DEPLOYMENT_DMN_FORM_WEBAPP_IMAGE__name: {
default: "incubator-kie-sandbox-dev-deployment-dmn-form-webapp",
- description: "The image name.",
+ description: "Name of the image itself.",
},
DEV_DEPLOYMENT_DMN_FORM_WEBAPP_IMAGE__buildTag: {
default: rootEnv.env.root.streamName,
- description: "The image tag.",
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
}),
get env() {
diff --git a/packages/dev-deployment-dmn-form-webapp-image/package.json
b/packages/dev-deployment-dmn-form-webapp-image/package.json
index a065e628376..4e2e908d831 100644
--- a/packages/dev-deployment-dmn-form-webapp-image/package.json
+++ b/packages/dev-deployment-dmn-form-webapp-image/package.json
@@ -23,7 +23,6 @@
"create-test-image:minikube": "kie-tools--image-builder minikube -r
\"$(pnpm build-env devDeploymentDmnFormWebappImage.registry)\" -a \"$(pnpm
build-env devDeploymentDmnFormWebappImage.account)\" -n \"$(pnpm build-env
devDeploymentDmnFormWebappImage.name)\" -t \"$(pnpm build-env
devDeploymentDmnFormWebappImage.buildTag)\"",
"create-test-image:openshift": "kie-tools--image-builder openshift -r
\"$(pnpm build-env devDeploymentDmnFormWebappImage.registry)\" -a \"$(pnpm
build-env devDeploymentDmnFormWebappImage.account)\" -n \"$(pnpm build-env
devDeploymentDmnFormWebappImage.name)\" -t \"$(pnpm build-env
devDeploymentDmnFormWebappImage.buildTag)\"",
"image:docker:build": "kie-tools--image-builder build -r \"$(pnpm
build-env devDeploymentDmnFormWebappImage.registry)\" -a \"$(pnpm build-env
devDeploymentDmnFormWebappImage.account)\" -n \"$(pnpm build-env
devDeploymentDmnFormWebappImage.name)\" -t \"$(pnpm build-env
devDeploymentDmnFormWebappImage.buildTag)\"",
- "image:podman:build": "kie-tools--image-builder build -r \"$(pnpm
build-env devDeploymentDmnFormWebappImage.registry)\" -a \"$(pnpm build-env
devDeploymentDmnFormWebappImage.account)\" -n \"$(pnpm build-env
devDeploymentDmnFormWebappImage.name)\" -t \"$(pnpm build-env
devDeploymentDmnFormWebappImage.buildTag)\" -e podman",
"powershell": "@powershell -NoProfile -ExecutionPolicy Unrestricted
-Command"
},
"dependencies": {
diff --git
a/packages/dev-deployment-kogito-quarkus-blank-app-image/env/index.js
b/packages/dev-deployment-kogito-quarkus-blank-app-image/env/index.js
index 5e3b3853f15..db4e8b45097 100644
--- a/packages/dev-deployment-kogito-quarkus-blank-app-image/env/index.js
+++ b/packages/dev-deployment-kogito-quarkus-blank-app-image/env/index.js
@@ -37,19 +37,19 @@ module.exports = composeEnv([rootEnv], {
},
DEV_DEPLOYMENT_KOGITO_QUARKUS_BLANK_APP_IMAGE__registry: {
default: "docker.io",
- description: "The image registry.",
+ description: "E.g., `docker.io` or `quay.io`.",
},
DEV_DEPLOYMENT_KOGITO_QUARKUS_BLANK_APP_IMAGE__account: {
default: "apache",
- description: "The image registry account.",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
DEV_DEPLOYMENT_KOGITO_QUARKUS_BLANK_APP_IMAGE__name: {
default: "incubator-kie-sandbox-dev-deployment-kogito-quarkus-blank-app",
- description: "The image name.",
+ description: "Name of the image itself.",
},
DEV_DEPLOYMENT_KOGITO_QUARKUS_BLANK_APP_IMAGE__buildTag: {
default: rootEnv.env.root.streamName,
- description: "The image tag.",
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
DEV_DEPLOYMENT_KOGITO_QUARKUS_BLANK_APP_IMAGE__mavenM2RepoViaHttpImage: {
default:
`${mavenM2RepoViaHttpImageEnv.registry}/${mavenM2RepoViaHttpImageEnv.account}/${mavenM2RepoViaHttpImageEnv.name}:${mavenM2RepoViaHttpImageEnv.tag}`,
diff --git
a/packages/dev-deployment-kogito-quarkus-blank-app-image/package.json
b/packages/dev-deployment-kogito-quarkus-blank-app-image/package.json
index e86e04ea3e1..50ce69ba979 100644
--- a/packages/dev-deployment-kogito-quarkus-blank-app-image/package.json
+++ b/packages/dev-deployment-kogito-quarkus-blank-app-image/package.json
@@ -28,7 +28,6 @@
"create-test-image:minikube": "kie-tools--image-builder minikube -r
\"$(build-env devDeploymentKogitoQuarkusBlankAppImage.registry)\" -a
\"$(build-env devDeploymentKogitoQuarkusBlankAppImage.account)\" -n
\"$(build-env devDeploymentKogitoQuarkusBlankAppImage.name)\" -t \"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.buildTag)\" --build-arg
BUILDER_IMAGE_ARG=\"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.builderImage)\" --build-arg
ROOT_PATH=/",
"create-test-image:openshift": "kie-tools--image-builder openshift -r
\"$(build-env devDeploymentKogitoQuarkusBlankAppImage.registry)\" -a
\"$(build-env devDeploymentKogitoQuarkusBlankAppImage.account)\" -n
\"$(build-env devDeploymentKogitoQuarkusBlankAppImage.name)\" -t \"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.buildTag)\" --build-arg
BUILDER_IMAGE_ARG=\"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.builderImage)\" --build-arg
ROOT_PATH=/",
"image:docker:build": "kie-tools--image-builder build
--allowHostNetworkAccess -r \"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.registry)\" -a \"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.account)\" -n \"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.name)\" -t \"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.buildTag)\" --build-arg
BUILDER_IMAGE_ARG=\"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.builderImage)\" --build-arg
ROOT_PATH=/",
- "image:podman:build": "kie-tools--image-builder build
--allowHostNetworkAccess -r \"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.registry)\" -a \"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.account)\" -n \"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.name)\" -t \"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.buildTag)\" --build-arg
BUILDER_IMAGE_ARG=\"$(build-env
devDeploymentKogitoQuarkusBlankAppImage.builderImage)\" --build-arg ROOT_PATH=/
-e podman",
"install": "node install.js",
"m2-repo-via-http:container:kill": "(docker container kill
m2-repo-via-http || true) && (docker container rm m2-repo-via-http || true)",
"m2-repo-via-http:container:run": "(pnpm m2-repo-via-http:container:kill
|| true) && docker run --name m2-repo-via-http -v \"$(mvn help:evaluate
-Dexpression=settings.localRepository -q -DforceStdout):/var/www/html\" -dit
$(build-env
devDeploymentKogitoQuarkusBlankAppImage.dev.mavenM2RepoViaHttpImage)",
diff --git a/packages/dev-deployment-upload-service/env/index.js
b/packages/dev-deployment-upload-service/env/index.js
index 92d6a814441..c3eacd83d59 100644
--- a/packages/dev-deployment-upload-service/env/index.js
+++ b/packages/dev-deployment-upload-service/env/index.js
@@ -35,15 +35,15 @@ module.exports = composeEnv([rootEnv], {
},
DEV_DEPLOYMENT_UPLOAD_SERVICE__devFileServerPort: {
default: 2340,
- description: "",
+ description: "The host port for the fileserver container used during
tests",
},
DEV_DEPLOYMENT_UPLOAD_SERVICE__devBuildTimeInstallPort: {
default: 2341,
- description: "",
+ description: "The host port for buildtime install test container",
},
DEV_DEPLOYMENT_UPLOAD_SERVICE__devRunTimeInstallPort: {
default: 2342,
- description: "",
+ description: "The host port for the runtime install test container",
},
}),
get env() {
diff --git a/packages/extended-services/env/index.js
b/packages/extended-services/env/index.js
index 790273631a5..0b5a5e0f638 100644
--- a/packages/extended-services/env/index.js
+++ b/packages/extended-services/env/index.js
@@ -27,7 +27,7 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
},
EXTENDED_SERVICES__version: {
default: require("../package.json").version,
- description: "Extended Services version",
+ description: "Extended Services version. Used by clients for checking
compatibility.",
},
EXTENDED_SERVICES__ip: {
default: "0.0.0.0",
@@ -35,7 +35,7 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
},
EXTENDED_SERVICES__port: {
default: "21345",
- description: "Extended Services port",
+ description: "HTTP port",
},
EXTENDED_SERVICES__nativeBinaryPath_macOS: {
default:
"./node_modules/@kie-tools/jitexecutor-native/dist/darwin/jitexecutor",
diff --git a/packages/feel-input-component/env/index.js
b/packages/feel-input-component/env/index.js
index 3da4f5c1567..d1a03e8e3b4 100644
--- a/packages/feel-input-component/env/index.js
+++ b/packages/feel-input-component/env/index.js
@@ -23,7 +23,7 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
vars: varsWithName({
FEEL_INPUT_COMPONENT_DEV_WEBAPP__feelServerUrl: {
default: "",
- description: "",
+ description: "For development only.",
},
}),
get env() {
diff --git a/packages/image-builder/README.md b/packages/image-builder/README.md
index 7da5473806f..3a788bb7893 100644
--- a/packages/image-builder/README.md
+++ b/packages/image-builder/README.md
@@ -22,7 +22,7 @@ Options:
-h, --help Show help [boolean]
Examples:
- $ image-builder --registry "$(build-env myCustomEnv.registry)" --account
"$(build-env myCustomEnv.account)" --name "$(build-env myCustomEnv.name)"
--tags "$(build-env myCustomEnv.buildTags)" --engine docker --push Build an
image using parameters from your myCustomEnv build env variables
+ $ image-builder --registry "$(build-env myCustomEnv.registry)" --account
"$(build-env myCustomEnv.account)" --name "$(build-env myCustomEnv.name)"
--tags "$(build-env myCustomEnv.buildTag)" --engine docker --push Build an
image using parameters from your myCustomEnv build env variables
CLI tool to help building container images using build variables and
different engines on different OSes.
diff --git a/packages/image-builder/src/bin.ts
b/packages/image-builder/src/bin.ts
index d5e5f994de2..d2dd5c99a0e 100644
--- a/packages/image-builder/src/bin.ts
+++ b/packages/image-builder/src/bin.ts
@@ -224,7 +224,7 @@ Also useful to aid on developing images and pushing them to
Kubernetes/OpenShift
`
)
.example(
- `$ image-builder --registry "$(build-env myCustomEnv.registry)"
--account "$(build-env myCustomEnv.account)" --name "$(build-env
myCustomEnv.name)" --tags "$(build-env myCustomEnv.buildTags)" --engine docker
--push`,
+ `$ image-builder --registry "$(build-env myCustomEnv.registry)"
--account "$(build-env myCustomEnv.account)" --name "$(build-env
myCustomEnv.name)" --tags "$(build-env myCustomEnv.buildTag)" --engine docker
--push`,
"Build an image using parameters from your myCustomEnv build env
variables"
)
.options({
diff --git a/packages/kie-sandbox-distribution/env/index.js
b/packages/kie-sandbox-distribution/env/index.js
index 06b068ba66a..daf0b2c0763 100644
--- a/packages/kie-sandbox-distribution/env/index.js
+++ b/packages/kie-sandbox-distribution/env/index.js
@@ -28,75 +28,75 @@ module.exports = composeEnv([rootEnv,
extendedServicesImageEnv, corsProxyImageEn
vars: varsWithName({
KIE_SANDBOX_DISTRIBUTION__kieSandboxImageRegistry: {
default: kieSandboxWebappImageEnv.env.kieSandboxWebappImage.registry,
- description: "",
+ description: "For the KIE Sandbox webapp image. E.g., `docker.io` or
`quay.io`.",
},
KIE_SANDBOX_DISTRIBUTION__kieSandboxImageAccount: {
default: kieSandboxWebappImageEnv.env.kieSandboxWebappImage.account,
- description: "",
+ description: "For the KIE Sandbox webapp image. E.g,. `apache` or
`kie-tools-bot`",
},
KIE_SANDBOX_DISTRIBUTION__kieSandboxImageName: {
default: kieSandboxWebappImageEnv.env.kieSandboxWebappImage.name,
- description: "",
+ description: "Name of the KIE Sandbox webapp image.",
},
KIE_SANDBOX_DISTRIBUTION__kieSandboxImageTag: {
- default:
kieSandboxWebappImageEnv.env.kieSandboxWebappImage.buildTags.split(" ")[0],
- description: "",
+ default: kieSandboxWebappImageEnv.env.kieSandboxWebappImage.buildTag,
+ description: "Tag version of the KIE Sandbox webapp image. E.g., `main`
or `10.0.x` or `10.0.0",
},
KIE_SANDBOX_DISTRIBUTION__kieSandboxContainerPort: {
default: kieSandboxWebappImageEnv.env.kieSandboxWebappImage.port,
- description: "",
+ description: "Internal port in the KIE Sandbox webapp container.",
},
KIE_SANDBOX_DISTRIBUTION__kieSandboxExposedPort: {
default: "9090",
- description: "",
+ description: "Exposed port of the KIE Sandbox webapp container.",
},
KIE_SANDBOX_DISTRIBUTION__extendedServicesImageRegistry: {
default: extendedServicesImageEnv.env.extendedServicesImage.registry,
- description: "",
+ description: "For the Extended Services image. E.g., `docker.io` or
`quay.io`.",
},
KIE_SANDBOX_DISTRIBUTION__extendedServicesImageAccount: {
default: extendedServicesImageEnv.env.extendedServicesImage.account,
- description: "",
+ description: "For the Extended Services image. E.g,. `apache` or
`kie-tools-bot`",
},
KIE_SANDBOX_DISTRIBUTION__extendedServicesImageName: {
default: extendedServicesImageEnv.env.extendedServicesImage.name,
- description: "",
+ description: "Name of the of the Extended Services image.",
},
KIE_SANDBOX_DISTRIBUTION__extendedServicesImageTag: {
- default:
extendedServicesImageEnv.env.extendedServicesImage.buildTags.split(" ")[0],
- description: "",
+ default: extendedServicesImageEnv.env.extendedServicesImage.buildTag,
+ description: "Tag version of the Extended Services image. E.g., `main`
or `10.0.x` or `10.0.0",
},
KIE_SANDBOX_DISTRIBUTION__extendedServicesContainerPort: {
default: "21345",
- description: "",
+ description: "Internal HTTP port in the Extended Services container.",
},
KIE_SANDBOX_DISTRIBUTION__extendedServicesExposedPort: {
default: "21345",
- description: "",
+ description: "Exposed HTTP port of the Extended Services container.",
},
KIE_SANDBOX_DISTRIBUTION__corsProxyImageRegistry: {
default: corsProxyImageEnv.env.corsProxyImage.image.registry,
- description: "",
+ description: "For the CORS proxy image. E.g., `docker.io` or `quay.io`.",
},
KIE_SANDBOX_DISTRIBUTION__corsProxyImageAccount: {
default: corsProxyImageEnv.env.corsProxyImage.image.account,
- description: "",
+ description: "For the CORS proxy image. E.g,. `apache` or
`kie-tools-bot`",
},
KIE_SANDBOX_DISTRIBUTION__corsProxyImageName: {
default: corsProxyImageEnv.env.corsProxyImage.image.name,
- description: "",
+ description: "Name of the CORS proxy image.",
},
KIE_SANDBOX_DISTRIBUTION__corsProxyImageTag: {
- default: corsProxyImageEnv.env.corsProxyImage.image.buildTags.split("
")[0],
- description: "",
+ default: corsProxyImageEnv.env.corsProxyImage.image.buildTag,
+ description: "Tag version of the CORS proxy image. E.g., `main` or
`10.0.x` or `10.0.0",
},
KIE_SANDBOX_DISTRIBUTION__corsProxyContainerPort: {
default: corsProxyImageEnv.env.corsProxyImage.image.port,
- description: "",
+ description: "Internal HTTP port in the CORS proxy container.",
},
KIE_SANDBOX_DISTRIBUTION__corsProxyExposedPort: {
default: "7081",
- description: "",
+ description: "Exposed HTTP port of the CORS proxy container.",
},
}),
get env() {
diff --git a/packages/kie-sandbox-distribution/package.json
b/packages/kie-sandbox-distribution/package.json
index d1a84f46fb9..7327441480d 100644
--- a/packages/kie-sandbox-distribution/package.json
+++ b/packages/kie-sandbox-distribution/package.json
@@ -16,7 +16,7 @@
"build:dev": "pnpm docker:build",
"build:prod": "run-script-if --bool \"$(build-env containerImages.build)\"
--then \"pnpm docker:build\" \"pnpm test\"",
"docker:build": "docker compose build",
- "docker:create-env-file": "rimraf .env && pnpm build-env
--print-env-file:self > .env",
+ "docker:create-env-file": "rimraf .env && pnpm build-env
--print-dotenv:self > .env",
"docker:down": "docker compose down",
"docker:start": "docker compose up -d --wait",
"docker:start-no-pull": "docker compose up -d --wait --pull=never",
diff --git a/packages/kie-sandbox-extended-services-image/README.md
b/packages/kie-sandbox-extended-services-image/README.md
index 88a6b4d3a26..c4baf558fb0 100644
--- a/packages/kie-sandbox-extended-services-image/README.md
+++ b/packages/kie-sandbox-extended-services-image/README.md
@@ -21,7 +21,7 @@ This package contains the `Containerfile` and scripts to
build a container image
## Additional requirements
-- docker or podman
+- docker
## Build
@@ -37,7 +37,7 @@ The image name and tags can be customized by setting the
following environment v
$ export KIE_SANDBOX_EXTENDED_SERVICES__imageRegistry=<registry>
$ export KIE_SANDBOX_EXTENDED_SERVICES__imageAccount=<account>
$ export KIE_SANDBOX_EXTENDED_SERVICES__imageName=<image-name>
-$ export KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTags=<image-tags>
+$ export KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTag=<image-tag>
$ export KIE_SANDBOX_EXTENDED_SERVICES__imagePort=<port>
```
@@ -55,12 +55,6 @@ Then check out the image:
$ docker images
```
-or
-
-```bash
-$ podman images
-```
-
## Run
Start up a new container with:
@@ -69,12 +63,6 @@ Start up a new container with:
$ docker run -p 21345:21345 -i --rm
docker.io/apache/incubator-kie-sandbox-extended-services:latest
```
-or
-
-```bash
-$ podman run -p 21345:21345 -i --rm
docker.io/apache/incubator-kie-sandbox-extended-services:latest
-```
-
The service will be up at http://localhost:21345
---
diff --git a/packages/kie-sandbox-extended-services-image/env/index.js
b/packages/kie-sandbox-extended-services-image/env/index.js
index acafd5fa26b..2e57e606382 100644
--- a/packages/kie-sandbox-extended-services-image/env/index.js
+++ b/packages/kie-sandbox-extended-services-image/env/index.js
@@ -20,7 +20,10 @@
const { varsWithName, getOrDefault, composeEnv } =
require("@kie-tools-scripts/build-env");
const rootEnv = require("@kie-tools/root-env/env");
-const extendedServicesJavaEnv =
require("@kie-tools/extended-services-java/env");
+
+const {
+ env: { extendedServicesJava: extendedServicesJavaEnv },
+} = require("@kie-tools/extended-services-java/env");
module.exports = composeEnv([rootEnv], {
vars: varsWithName({
@@ -30,23 +33,23 @@ module.exports = composeEnv([rootEnv], {
},
KIE_SANDBOX_EXTENDED_SERVICES__imageRegistry: {
default: "docker.io",
- description: "",
+ description: "E.g., `docker.io` or `quay.io`.",
},
KIE_SANDBOX_EXTENDED_SERVICES__imageAccount: {
default: "apache",
- description: "",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
KIE_SANDBOX_EXTENDED_SERVICES__imageName: {
default: "incubator-kie-sandbox-extended-services",
- description: "",
+ description: "Name of the image itself.",
},
- KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTags: {
+ KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTag: {
default: rootEnv.env.root.streamName,
- description: "",
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
KIE_SANDBOX_EXTENDED_SERVICES__imagePort: {
- default: extendedServicesJavaEnv.env.extendedServicesJava.port,
- description: "",
+ default: extendedServicesJavaEnv.port,
+ description: "Internal HTTP port of the Extended Services app.",
},
}),
get env() {
@@ -56,7 +59,7 @@ module.exports = composeEnv([rootEnv], {
registry:
getOrDefault(this.vars.KIE_SANDBOX_EXTENDED_SERVICES__imageRegistry),
account:
getOrDefault(this.vars.KIE_SANDBOX_EXTENDED_SERVICES__imageAccount),
name: getOrDefault(this.vars.KIE_SANDBOX_EXTENDED_SERVICES__imageName),
- buildTags:
getOrDefault(this.vars.KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTags),
+ buildTag:
getOrDefault(this.vars.KIE_SANDBOX_EXTENDED_SERVICES__imageBuildTag),
port: getOrDefault(this.vars.KIE_SANDBOX_EXTENDED_SERVICES__imagePort),
},
};
diff --git a/packages/kie-sandbox-extended-services-image/package.json
b/packages/kie-sandbox-extended-services-image/package.json
index 3deefc031b5..473f72aa2b2 100644
--- a/packages/kie-sandbox-extended-services-image/package.json
+++ b/packages/kie-sandbox-extended-services-image/package.json
@@ -20,8 +20,7 @@
"copy:extended-services-java": "run-script-os",
"copy:extended-services-java:linux:darwin": "cp -R
./node_modules/@kie-tools/extended-services-java/dist/extended-services-java
./dist-dev/kie_sandbox_extended_services",
"copy:extended-services-java:win32": "pnpm powershell \"Copy-Item
./node_modules/@kie-tools/extended-services-java/dist/extended-services-java
./dist-dev/kie_sandbox_extended_services\"",
- "image:docker:build": "kie-tools--image-builder build -r \"$(build-env
extendedServicesImage.registry)\" -a \"$(build-env
extendedServicesImage.account)\" -n \"$(build-env extendedServicesImage.name)\"
-t \"$(build-env extendedServicesImage.buildTags)\" --build-arg
BUILDER_IMAGE_ARG=\"$(build-env extendedServicesImage.builderImage)\"
--build-arg \"EXTENDED_SERVICES_DEFAULT_PORT=$(build-env
extendedServicesImage.port)\" ",
- "image:podman:build": "kie-tools--image-builder build -r \"$(build-env
extendedServicesImage.registry)\" -a \"$(build-env
extendedServicesImage.account)\" -n \"$(build-env extendedServicesImage.name)\"
-t \"$(build-env extendedServicesImage.buildTags)\" --build-arg
BUILDER_IMAGE_ARG=\"$(build-env extendedServicesImage.builderImage)\"
--build-arg \"EXTENDED_SERVICES_DEFAULT_PORT=$(build-env
extendedServicesImage.port)\" -e podman"
+ "image:docker:build": "kie-tools--image-builder build -r \"$(build-env
extendedServicesImage.registry)\" -a \"$(build-env
extendedServicesImage.account)\" -n \"$(build-env extendedServicesImage.name)\"
-t \"$(build-env extendedServicesImage.buildTag)\" --build-arg
BUILDER_IMAGE_ARG=\"$(build-env extendedServicesImage.builderImage)\"
--build-arg \"EXTENDED_SERVICES_DEFAULT_PORT=$(build-env
extendedServicesImage.port)\""
},
"dependencies": {
"@kie-tools/extended-services-java": "workspace:*"
diff --git a/packages/kie-sandbox-helm-chart/README.md
b/packages/kie-sandbox-helm-chart/README.md
index d68aac6b2d1..55c8bfc2dad 100644
--- a/packages/kie-sandbox-helm-chart/README.md
+++ b/packages/kie-sandbox-helm-chart/README.md
@@ -21,8 +21,7 @@ This chart can be used to deploy KIE Sandbox image on a
[Kubernetes](https://kub
## Additional requirements
-- Podman (for Linux)
-- Docker (for macOS)
+- Docker
- Minikube
## Components
diff --git a/packages/kie-sandbox-helm-chart/env/index.js
b/packages/kie-sandbox-helm-chart/env/index.js
index af724183fbb..70dd7d12415 100644
--- a/packages/kie-sandbox-helm-chart/env/index.js
+++ b/packages/kie-sandbox-helm-chart/env/index.js
@@ -25,19 +25,19 @@ module.exports = composeEnv([rootEnv], {
vars: varsWithName({
KIE_SANDBOX_HELM_CHART__registry: {
default: "docker.io",
- description: "",
+ description: "E.g., `docker.io` or `quay.io`.",
},
KIE_SANDBOX_HELM_CHART__account: {
default: "apache",
- description: "",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
KIE_SANDBOX_HELM_CHART__name: {
default: "incubator-kie-sandbox-helm-chart",
- description: "",
+ description: "Name of the chart itself.",
},
KIE_SANDBOX_HELM_CHART__tag: {
default: require("../package.json").version, // Needs to be SemVer, so
we can't use rootEnv.env.root.streamName.
- description: "",
+ description: "Version of the Helm Chart. Needs to be SemVer-compatible.",
},
}),
get env() {
diff --git a/packages/kie-sandbox-webapp-image/README.md
b/packages/kie-sandbox-webapp-image/README.md
index fd53661efa3..ff2e4540699 100644
--- a/packages/kie-sandbox-webapp-image/README.md
+++ b/packages/kie-sandbox-webapp-image/README.md
@@ -21,7 +21,7 @@ This package contains the `Containerfile/Dockerfile` and
scripts to build a cont
## Additional requirements
-- docker or podman
+- docker
## Build
@@ -37,7 +37,7 @@ This package contains the `Containerfile/Dockerfile` and
scripts to build a cont
export KIE_SANDBOX_WEBAPP_IMAGE__imageRegistry=<registry>
export KIE_SANDBOX_WEBAPP_IMAGE__imageAccount=<account>
export KIE_SANDBOX_WEBAPP_IMAGE__imageName=<image-name>
- export KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTags=<image-tags>
+ export KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTag=<image-tag>
export KIE_SANDBOX_WEBAPP_IMAGE__imagePort=<port>
```
@@ -55,12 +55,6 @@ This package contains the `Containerfile/Dockerfile` and
scripts to build a cont
docker images
```
- or
-
- ```bash
- podman images
- ```
-
## Run
- Start up a clean container with:
@@ -69,12 +63,6 @@ This package contains the `Containerfile/Dockerfile` and
scripts to build a cont
docker run -t -p 8080:8080 -i --rm
docker.io/apache/incubator-kie-sandbox-webapp:latest
```
- or
-
- ```bash
- podman run -t -p 8080:8080 -i --rm
docker.io/apache/incubator-kie-sandbox-webapp:latest
- ```
-
KIE Sandbox will be up at http://localhost:8080
## Customization
diff --git a/packages/kie-sandbox-webapp-image/env/index.js
b/packages/kie-sandbox-webapp-image/env/index.js
index 0e3d1d555c9..54ab1a3483d 100644
--- a/packages/kie-sandbox-webapp-image/env/index.js
+++ b/packages/kie-sandbox-webapp-image/env/index.js
@@ -25,23 +25,23 @@ module.exports = composeEnv([rootEnv], {
vars: varsWithName({
KIE_SANDBOX_WEBAPP_IMAGE__imageRegistry: {
default: "docker.io",
- description: "",
+ description: "E.g., `docker.io` or `quay.io`.",
},
KIE_SANDBOX_WEBAPP_IMAGE__imageAccount: {
default: "apache",
- description: "",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
KIE_SANDBOX_WEBAPP_IMAGE__imageName: {
default: "incubator-kie-sandbox-webapp",
- description: "",
+ description: "Name of the image itself.",
},
- KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTags: {
+ KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTag: {
default: rootEnv.env.root.streamName,
- description: "",
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
KIE_SANDBOX_WEBAPP_IMAGE__imagePort: {
default: "8080",
- description: "",
+ description: "The internal container port.",
},
}),
get env() {
@@ -50,7 +50,7 @@ module.exports = composeEnv([rootEnv], {
registry:
getOrDefault(this.vars.KIE_SANDBOX_WEBAPP_IMAGE__imageRegistry),
account:
getOrDefault(this.vars.KIE_SANDBOX_WEBAPP_IMAGE__imageAccount),
name: getOrDefault(this.vars.KIE_SANDBOX_WEBAPP_IMAGE__imageName),
- buildTags:
getOrDefault(this.vars.KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTags),
+ buildTag:
getOrDefault(this.vars.KIE_SANDBOX_WEBAPP_IMAGE__imageBuildTag),
port: getOrDefault(this.vars.KIE_SANDBOX_WEBAPP_IMAGE__imagePort),
},
};
diff --git a/packages/kie-sandbox-webapp-image/package.json
b/packages/kie-sandbox-webapp-image/package.json
index 8362e6d0964..21aaa4745a5 100644
--- a/packages/kie-sandbox-webapp-image/package.json
+++ b/packages/kie-sandbox-webapp-image/package.json
@@ -24,8 +24,7 @@
"copy:online-editor:linux:darwin": "cp -R
./node_modules/@kie-tools/online-editor/dist/ ./dist-dev/online-editor",
"copy:online-editor:win32": "pnpm powershell \"Copy-Item -R
./node_modules/@kie-tools/online-editor/dist/ ./dist-dev/online-editor\"",
"env-json:schema:generate": "ts-json-schema-generator --path
./node_modules/@kie-tools/online-editor/src/env/EnvJson.ts --type EnvJson --id
EnvJson --out ./dist-dev/EnvJson.schema.json",
- "image:docker:build": "kie-tools--image-builder build -r \"$(build-env
kieSandboxWebappImage.registry)\" -a \"$(build-env
kieSandboxWebappImage.account)\" -n \"$(build-env kieSandboxWebappImage.name)\"
-t \"$(build-env kieSandboxWebappImage.buildTags)\" --build-arg
\"KIE_SANDBOX_DEFAULT_PORT=$(build-env kieSandboxWebappImage.port)\"",
- "image:podman:build": "kie-tools--image-builder build -r \"$(build-env
kieSandboxWebappImage.registry)\" -a \"$(build-env
kieSandboxWebappImage.account)\" -n \"$(build-env kieSandboxWebappImage.name)\"
-t \"$(build-env kieSandboxWebappImage.buildTags)\" --build-arg
\"KIE_SANDBOX_DEFAULT_PORT=$(build-env kieSandboxWebappImage.port)\" -e podman"
+ "image:docker:build": "kie-tools--image-builder build -r \"$(build-env
kieSandboxWebappImage.registry)\" -a \"$(build-env
kieSandboxWebappImage.account)\" -n \"$(build-env kieSandboxWebappImage.name)\"
-t \"$(build-env kieSandboxWebappImage.buildTag)\" --build-arg
\"KIE_SANDBOX_DEFAULT_PORT=$(build-env kieSandboxWebappImage.port)\""
},
"dependencies": {
"@kie-tools/image-env-to-json": "workspace:*",
diff --git a/packages/kogito-management-console/README.md
b/packages/kogito-management-console/README.md
index f31bd109d5a..a1928da5719 100644
--- a/packages/kogito-management-console/README.md
+++ b/packages/kogito-management-console/README.md
@@ -21,7 +21,7 @@ This package contains the `Containerfile/Dockerfile` and
scripts to build a cont
## Additional requirements
-- docker or podman
+- docker
## Build
@@ -54,12 +54,6 @@ This package contains the `Containerfile/Dockerfile` and
scripts to build a cont
docker images
```
- or
-
- ```bash
- podman images
- ```
-
## Run
- Start up a clean container with:
@@ -68,12 +62,6 @@ This package contains the `Containerfile/Dockerfile` and
scripts to build a cont
docker run -t -p 8080:8080 -i --rm
docker.io/apache/incubator-kie-kogito-managment-console:daily-dev
```
- or
-
- ```bash
- podman run -t -p 8080:8080 -i --rm
docker.io/apache/incubator-kie-kogito-managment-console:daily-dev
- ```
-
Management Console will be up at http://localhost:8080
## Customization
diff --git a/packages/kogito-management-console/env/index.js
b/packages/kogito-management-console/env/index.js
index b943cfa9aa0..61465401ac4 100644
--- a/packages/kogito-management-console/env/index.js
+++ b/packages/kogito-management-console/env/index.js
@@ -25,23 +25,23 @@ module.exports = composeEnv([rootEnv], {
vars: varsWithName({
KOGITO_MANAGEMENT_CONSOLE__registry: {
default: "docker.io",
- description: "The image registry.",
+ description: "E.g., `docker.io` or `quay.io`.",
},
KOGITO_MANAGEMENT_CONSOLE__account: {
default: "apache",
- description: "The image registry account.",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
KOGITO_MANAGEMENT_CONSOLE__name: {
default: "incubator-kie-kogito-management-console",
- description: "The image name.",
+ description: "Name of the image itself.",
},
KOGITO_MANAGEMENT_CONSOLE__buildTag: {
default: rootEnv.env.root.streamName,
- description: "The image tag.",
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
KOGITO_MANAGEMENT_CONSOLE__port: {
default: 8080,
- description: "The default container port.",
+ description: "The internal container port.",
},
}),
get env() {
diff --git a/packages/kogito-management-console/package.json
b/packages/kogito-management-console/package.json
index 64a977ed1e0..eef7b149cd8 100644
--- a/packages/kogito-management-console/package.json
+++ b/packages/kogito-management-console/package.json
@@ -24,8 +24,7 @@
"copy:webapp-assets:linux:darwin": "cp -R
./node_modules/@kie-tools/runtime-tools-management-console-webapp/dist/
./dist-dev/runtime-tools-management-console-webapp",
"copy:webapp-assets:win32": "pnpm powershell \"Copy-Item -R
./node_modules/@kie-tools/runtime-tools-management-console-webapp/dist/
./dist-dev/runtime-tools-management-console-webapp\"",
"env-json:schema:generate": "ts-json-schema-generator --tsconfig
./node_modules/@kie-tools/runtime-tools-management-console-webapp/tsconfig.json
--path
./node_modules/@kie-tools/runtime-tools-management-console-webapp/src/env/EnvJson.ts
--type EnvJson --id EnvJson --out ./dist-dev/EnvJson.schema.json",
- "image:docker:build": "kie-tools--image-builder build -r \"$(build-env
kogitoManagementConsole.registry)\" -a \"$(build-env
kogitoManagementConsole.account)\" -n \"$(build-env
kogitoManagementConsole.name)\" -t \"$(build-env
kogitoManagementConsole.buildTag)\" --build-arg
KOGITO_MANAGEMENT_CONSOLE_PORT=\"$(build-env kogitoManagementConsole.port)\"",
- "image:podman:build": "kie-tools--image-builder build -r \"$(build-env
kogitoManagementConsole.registry)\" -a \"$(build-env
kogitoManagementConsole.account)\" -n \"$(build-env
kogitoManagementConsole.name)\" -t \"$(build-env
kogitoManagementConsole.buildTag)\" --build-arg
KOGITO_MANAGEMENT_CONSOLE_PORT=\"$(build-env kogitoManagementConsole.port)\" -e
podman"
+ "image:docker:build": "kie-tools--image-builder build -r \"$(build-env
kogitoManagementConsole.registry)\" -a \"$(build-env
kogitoManagementConsole.account)\" -n \"$(build-env
kogitoManagementConsole.name)\" -t \"$(build-env
kogitoManagementConsole.buildTag)\" --build-arg
KOGITO_MANAGEMENT_CONSOLE_PORT=\"$(build-env kogitoManagementConsole.port)\""
},
"devDependencies": {
"@kie-tools/image-builder": "workspace:*",
diff --git a/packages/kogito-task-console/README.md
b/packages/kogito-task-console/README.md
index 1e1aba7b894..539cff27399 100644
--- a/packages/kogito-task-console/README.md
+++ b/packages/kogito-task-console/README.md
@@ -21,7 +21,7 @@ This package contains the `Containerfile/Dockerfile` and
scripts to build a cont
## Additional requirements
-- docker or podman
+- docker
## Build
@@ -54,12 +54,6 @@ This package contains the `Containerfile/Dockerfile` and
scripts to build a cont
docker images
```
- or
-
- ```bash
- podman images
- ```
-
## Run
- Start up a clean container with:
@@ -68,12 +62,6 @@ This package contains the `Containerfile/Dockerfile` and
scripts to build a cont
docker run -t -p 8080:8080 -i --rm
docker.io/apache/incubator-kie-kogito-task-console:daily-dev
```
- or
-
- ```bash
- podman run -t -p 8080:8080 -i --rm
docker.io/apache/incubator-kie-kogito-task-console:daily-dev
- ```
-
Task Console will be up at http://localhost:8080
## Customization
diff --git a/packages/kogito-task-console/env/index.js
b/packages/kogito-task-console/env/index.js
index 814486d59fd..07cac3a780b 100644
--- a/packages/kogito-task-console/env/index.js
+++ b/packages/kogito-task-console/env/index.js
@@ -25,23 +25,23 @@ module.exports = composeEnv([rootEnv], {
vars: varsWithName({
KOGITO_TASK_CONSOLE__registry: {
default: "docker.io",
- description: "The image registry.",
+ description: "E.g., `docker.io` or `quay.io`.",
},
KOGITO_TASK_CONSOLE__account: {
default: "apache",
- description: "The image registry account.",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
KOGITO_TASK_CONSOLE__name: {
default: "incubator-kie-kogito-task-console",
- description: "The image name.",
+ description: "Name of the image itself.",
},
KOGITO_TASK_CONSOLE__buildTag: {
default: rootEnv.env.root.streamName,
- description: "The image tag.",
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
KOGITO_TASK_CONSOLE__port: {
default: 8080,
- description: "The default container port.",
+ description: "The internal container port.",
},
}),
get env() {
diff --git a/packages/kogito-task-console/package.json
b/packages/kogito-task-console/package.json
index fad3636b9bd..50fc8333cdb 100644
--- a/packages/kogito-task-console/package.json
+++ b/packages/kogito-task-console/package.json
@@ -24,8 +24,7 @@
"copy:webapp-assets:linux:darwin": "cp -R
./node_modules/@kie-tools/runtime-tools-task-console-webapp/dist/
./dist-dev/runtime-tools-task-console-webapp",
"copy:webapp-assets:win32": "pnpm powershell \"Copy-Item -R
./node_modules/@kie-tools/runtime-tools-task-console-webapp/dist/
./dist-dev/runtime-tools-task-console-webapp\"",
"env-json:schema:generate": "ts-json-schema-generator --tsconfig
./node_modules/@kie-tools/runtime-tools-task-console-webapp/tsconfig.json
--path
./node_modules/@kie-tools/runtime-tools-task-console-webapp/src/env/EnvJson.ts
--type EnvJson --id EnvJson --out ./dist-dev/EnvJson.schema.json",
- "image:docker:build": "kie-tools--image-builder build -r \"$(build-env
kogitoTaskConsole.registry)\" -a \"$(build-env kogitoTaskConsole.account)\" -n
\"$(build-env kogitoTaskConsole.name)\" -t \"$(build-env
kogitoTaskConsole.buildTag)\" --build-arg
KOGITO_TASK_CONSOLE_PORT=\"$(build-env kogitoTaskConsole.port)\"",
- "image:podman:build": "kie-tools--image-builder build -r \"$(build-env
kogitoTaskConsole.registry)\" -a \"$(build-env kogitoTaskConsole.account)\" -n
\"$(build-env kogitoTaskConsole.name)\" -t \"$(build-env
kogitoTaskConsole.buildTag)\" --build-arg
KOGITO_TASK_CONSOLE_PORT=\"$(build-env kogitoTaskConsole.port)\" -e podman"
+ "image:docker:build": "kie-tools--image-builder build -r \"$(build-env
kogitoTaskConsole.registry)\" -a \"$(build-env kogitoTaskConsole.account)\" -n
\"$(build-env kogitoTaskConsole.name)\" -t \"$(build-env
kogitoTaskConsole.buildTag)\" --build-arg
KOGITO_TASK_CONSOLE_PORT=\"$(build-env kogitoTaskConsole.port)\""
},
"devDependencies": {
"@kie-tools/image-builder": "workspace:*",
diff --git a/packages/maven-base/env/index.js b/packages/maven-base/env/index.js
index 7cba7bac345..96c5d8d4e6f 100644
--- a/packages/maven-base/env/index.js
+++ b/packages/maven-base/env/index.js
@@ -23,7 +23,7 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
vars: varsWithName({
KIE_TOOLS_BUILD__mavenDeploySkip: {
default: "true",
- description: "Determines if a Maven build skips a deploy",
+ description: "Determines if a Maven build skips a deploy. Can be `true`
or `false`.",
},
}),
get env() {
diff --git a/packages/maven-m2-repo-via-http-image/env/index.js
b/packages/maven-m2-repo-via-http-image/env/index.js
index 69b9c5e351a..d989c25bd14 100644
--- a/packages/maven-m2-repo-via-http-image/env/index.js
+++ b/packages/maven-m2-repo-via-http-image/env/index.js
@@ -25,19 +25,19 @@ module.exports = composeEnv([rootEnv], {
vars: varsWithName({
MAVEN_M2_REPO_VIA_HTTP_IMAGE__registry: {
default: "docker.io",
- description: "The image registry.",
+ description: "E.g., `docker.io` or `quay.io`.",
},
MAVEN_M2_REPO_VIA_HTTP_IMAGE__account: {
default: "apache",
- description: "The image registry account.",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
MAVEN_M2_REPO_VIA_HTTP_IMAGE__name: {
default: "incubator-kie-tools-maven-m2-repo-via-http",
- description: "The image name.",
+ description: "Name of the image itself.",
},
MAVEN_M2_REPO_VIA_HTTP_IMAGE__buildTag: {
default: rootEnv.env.root.streamName,
- description: "The image tag.",
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
}),
get env() {
diff --git a/packages/online-editor/env/index.js
b/packages/online-editor/env/index.js
index d4752019701..79ddd31392b 100644
--- a/packages/online-editor/env/index.js
+++ b/packages/online-editor/env/index.js
@@ -23,173 +23,165 @@ const rootEnv = require("@kie-tools/root-env/env");
const extendedServicesEnv = require("@kie-tools/extended-services/env");
const corsProxyEnv = require("@kie-tools/cors-proxy/env");
-module.exports = composeEnv(
- [
- // dependencies
- rootEnv,
- extendedServicesEnv,
- corsProxyEnv,
- ],
- {
- vars: varsWithName({
- ONLINE_EDITOR__buildInfo: {
- default: `dev (${process.env.USER}) @ ${new Date().toISOString()}`,
- description: "Build information to be shown at the bottom of Home
page.",
- },
- ONLINE_EDITOR__extendedServicesDownloadUrlLinux: {
- default:
`https://github.com/apache/incubator-kie-tools/releases/download/${rootEnv.env.root.version}/kie_sandbox_extended_services_linux_${extendedServicesEnv.env.extendedServices.version}.tar.gz`,
- description: "Download URL for Extended Services for Linux.",
- },
- ONLINE_EDITOR__extendedServicesDownloadUrlMacOs: {
- default:
`https://github.com/apache/incubator-kie-tools/releases/download/${rootEnv.env.root.version}/kie_sandbox_extended_services_macos_${extendedServicesEnv.env.extendedServices.version}.dmg`,
- description: "Download URL for Extended Services for macOS.",
- },
- ONLINE_EDITOR__extendedServicesDownloadUrlWindows: {
- default:
`https://github.com/apache/incubator-kie-tools/releases/download/${rootEnv.env.root.version}/kie_sandbox_extended_services_windows_${extendedServicesEnv.env.extendedServices.version}.exe`,
- description: "Download URL for Extended Services for Windows.",
- },
- ONLINE_EDITOR__extendedServicesCompatibleVersion: {
- default: extendedServicesEnv.env.extendedServices.version,
- description:
- "Version Extended Services compatile with KIE Sandbox. Exact match
only. No version ranges are supported.",
- },
- ONLINE_EDITOR__gtmId: {
- default: undefined,
- description: "Google Tag Manager ID. Used for analytics.",
- },
- ONLINE_EDITOR__corsProxyUrl: {
- default: `http://localhost:${corsProxyEnv.env.corsProxy.dev.port}`,
- description: "CORS Proxy URL.",
- },
- ONLINE_EDITOR__extendedServicesUrl: {
- default:
`http://${extendedServicesEnv.env.extendedServices.ip}:${extendedServicesEnv.env.extendedServices.port}`,
- description: "Extended Services URL.",
- },
- ONLINE_EDITOR__feedbackUrl: {
- default:
"https://github.com/apache/incubator-kie-issues/issues/439#issuecomment-1821845917";,
- description: "URL where users can give feedback, currently present in
the New DMN Editor dropdown.",
- },
- ONLINE_EDITOR__requireCustomCommitMessage: {
- default: `${false}`,
- description: "Require users to type a custom commit message when
creating a new commit.",
- },
- ONLINE_EDITOR__customCommitMessageValidationServiceUrl: {
- default: "",
- description: "Service URL to validate commit messages.",
- },
- ONLINE_EDITOR__appName: {
- default: "Apache KIE™ Sandbox",
- description: "The name used to refer to a particular KIE Sandbox
distribution.",
- },
- ONLINE_EDITOR__devDeploymentBaseImageRegistry: {
- default: "docker.io",
- description: "Image registry to be used by Dev deployments when
deploying models.",
- },
- ONLINE_EDITOR__devDeploymentBaseImageAccount: {
- default: "apache",
- description: "Image account to be used by Dev deployments when
deploying models.",
- },
- ONLINE_EDITOR__devDeploymentBaseImageName: {
- default: "incubator-kie-sandbox-dev-deployment-base",
- description: "Image name to be used by Dev deployments when deploying
models.",
- },
- ONLINE_EDITOR__devDeploymentBaseImageTag: {
- default: rootEnv.env.root.streamName,
- description: "Image tag to be used by Dev deployments when deploying
models.",
- },
- ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageRegistry: {
- default: "docker.io",
- description: "Image registry to be used by Dev deployments when
deploying models.",
- },
- ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageAccount: {
- default: "apache",
- description: "Image account to be used by Dev deployments when
deploying models.",
- },
- ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageName: {
- default:
"incubator-kie-sandbox-dev-deployment-kogito-quarkus-blank-app",
- description: "Image name to be used by Dev deployments when deploying
models.",
- },
- ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageTag: {
- default: rootEnv.env.root.streamName,
- description: "Image tag to be used by Dev deployments when deploying
models.",
- },
- ONLINE_EDITOR__devDeploymentDmnFormWebappImageRegistry: {
- default: "docker.io",
- description: "Image registry to be used by Dev deployments to display
a form for deployed DMN models.",
- },
- ONLINE_EDITOR__devDeploymentDmnFormWebappImageAccount: {
- default: "apache",
- description: "Image account to be used by Dev deployments to display a
form for deployed DMN models.",
- },
- ONLINE_EDITOR__devDeploymentDmnFormWebappImageName: {
- default: "incubator-kie-sandbox-dev-deployment-dmn-form-webapp",
- description: "Image name to be used by Dev deployments to display a
form for deployed DMN models.",
- },
- ONLINE_EDITOR__devDeploymentDmnFormWebappImageTag: {
- default: rootEnv.env.root.streamName,
- description: "Image tag to be used by Dev deployments to display a
form for deployed DMN models.",
- },
- ONLINE_EDITOR__devDeploymentImagePullPolicy: {
- default: "IfNotPresent",
- description: "The image pull policy. Can be 'Always', 'IfNotPresent',
or 'Never'.",
- },
- ONLINE_EDITOR_DEV__port: {
- default: 9001,
- description: "The development web server port",
- },
- ONLINE_EDITOR_DEV__https: {
- default: "true",
- description: "Tells if the development web server should use https",
- },
- }),
- get env() {
- return {
- onlineEditor: {
- dev: {
- port: getOrDefault(this.vars.ONLINE_EDITOR_DEV__port),
- https: str2bool(getOrDefault(this.vars.ONLINE_EDITOR_DEV__https)),
- },
- gtmId: getOrDefault(this.vars.ONLINE_EDITOR__gtmId),
- buildInfo: getOrDefault(this.vars.ONLINE_EDITOR__buildInfo),
- extendedServices: {
- compatibleVersion:
getOrDefault(this.vars.ONLINE_EDITOR__extendedServicesCompatibleVersion),
- downloadUrl: {
- linux:
getOrDefault(this.vars.ONLINE_EDITOR__extendedServicesDownloadUrlLinux),
- macOs:
getOrDefault(this.vars.ONLINE_EDITOR__extendedServicesDownloadUrlMacOs),
- windows:
getOrDefault(this.vars.ONLINE_EDITOR__extendedServicesDownloadUrlWindows),
- },
- },
- appName: getOrDefault(this.vars.ONLINE_EDITOR__appName),
- extendedServicesUrl:
getOrDefault(this.vars.ONLINE_EDITOR__extendedServicesUrl),
- corsProxyUrl: getOrDefault(this.vars.ONLINE_EDITOR__corsProxyUrl),
- feedbackUrl: getOrDefault(this.vars.ONLINE_EDITOR__feedbackUrl),
- requireCustomCommitMessage:
str2bool(getOrDefault(this.vars.ONLINE_EDITOR__requireCustomCommitMessage)),
- customCommitMessageValidationServiceUrl: getOrDefault(
- this.vars.ONLINE_EDITOR__customCommitMessageValidationServiceUrl
- ),
+module.exports = composeEnv([rootEnv, extendedServicesEnv, corsProxyEnv], {
+ vars: varsWithName({
+ ONLINE_EDITOR__buildInfo: {
+ default: `dev (${process.env.USER}) @ ${new Date().toISOString()}`,
+ description: "Build information to be shown at the bottom of Home page.",
+ },
+ ONLINE_EDITOR__extendedServicesDownloadUrlLinux: {
+ default:
`https://github.com/apache/incubator-kie-tools/releases/download/${rootEnv.env.root.version}/kie_sandbox_extended_services_linux_${extendedServicesEnv.env.extendedServices.version}.tar.gz`,
+ description: "Download URL for Extended Services for Linux.",
+ },
+ ONLINE_EDITOR__extendedServicesDownloadUrlMacOs: {
+ default:
`https://github.com/apache/incubator-kie-tools/releases/download/${rootEnv.env.root.version}/kie_sandbox_extended_services_macos_${extendedServicesEnv.env.extendedServices.version}.dmg`,
+ description: "Download URL for Extended Services for macOS.",
+ },
+ ONLINE_EDITOR__extendedServicesDownloadUrlWindows: {
+ default:
`https://github.com/apache/incubator-kie-tools/releases/download/${rootEnv.env.root.version}/kie_sandbox_extended_services_windows_${extendedServicesEnv.env.extendedServices.version}.exe`,
+ description: "Download URL for Extended Services for Windows.",
+ },
+ ONLINE_EDITOR__extendedServicesCompatibleVersion: {
+ default: extendedServicesEnv.env.extendedServices.version,
+ description:
+ "Version Extended Services compatile with KIE Sandbox. Exact match
only. No version ranges are supported.",
+ },
+ ONLINE_EDITOR__gtmId: {
+ default: undefined,
+ description: "Google Tag Manager ID. Used for analytics.",
+ },
+ ONLINE_EDITOR__corsProxyUrl: {
+ default: `http://localhost:${corsProxyEnv.env.corsProxy.dev.port}`,
+ description: "CORS Proxy URL.",
+ },
+ ONLINE_EDITOR__extendedServicesUrl: {
+ default:
`http://${extendedServicesEnv.env.extendedServices.ip}:${extendedServicesEnv.env.extendedServices.port}`,
+ description: "Extended Services URL.",
+ },
+ ONLINE_EDITOR__feedbackUrl: {
+ default:
"https://github.com/apache/incubator-kie-issues/issues/439#issuecomment-1821845917";,
+ description: "URL where users can give feedback, currently present in
the New DMN Editor dropdown.",
+ },
+ ONLINE_EDITOR__requireCustomCommitMessage: {
+ default: `${false}`,
+ description: "Require users to type a custom commit message when
creating a new commit.",
+ },
+ ONLINE_EDITOR__customCommitMessageValidationServiceUrl: {
+ default: "",
+ description: "Service URL to validate commit messages.",
+ },
+ ONLINE_EDITOR__appName: {
+ default: "Apache KIE™ Sandbox",
+ description: "The name used to refer to a particular KIE Sandbox
distribution.",
+ },
+ ONLINE_EDITOR__devDeploymentBaseImageRegistry: {
+ default: "docker.io",
+ description: "Image registry to be used by Dev deployments when
deploying models.",
+ },
+ ONLINE_EDITOR__devDeploymentBaseImageAccount: {
+ default: "apache",
+ description: "Image account to be used by Dev deployments when deploying
models.",
+ },
+ ONLINE_EDITOR__devDeploymentBaseImageName: {
+ default: "incubator-kie-sandbox-dev-deployment-base",
+ description: "Image name to be used by Dev deployments when deploying
models.",
+ },
+ ONLINE_EDITOR__devDeploymentBaseImageTag: {
+ default: rootEnv.env.root.streamName,
+ description: "Image tag to be used by Dev deployments when deploying
models.",
+ },
+ ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageRegistry: {
+ default: "docker.io",
+ description: "Image registry to be used by Dev deployments when
deploying models.",
+ },
+ ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageAccount: {
+ default: "apache",
+ description: "Image account to be used by Dev deployments when deploying
models.",
+ },
+ ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageName: {
+ default: "incubator-kie-sandbox-dev-deployment-kogito-quarkus-blank-app",
+ description: "Image name to be used by Dev deployments when deploying
models.",
+ },
+ ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageTag: {
+ default: rootEnv.env.root.streamName,
+ description: "Image tag to be used by Dev deployments when deploying
models.",
+ },
+ ONLINE_EDITOR__devDeploymentDmnFormWebappImageRegistry: {
+ default: "docker.io",
+ description: "Image registry to be used by Dev deployments to display a
form for deployed DMN models.",
+ },
+ ONLINE_EDITOR__devDeploymentDmnFormWebappImageAccount: {
+ default: "apache",
+ description: "Image account to be used by Dev deployments to display a
form for deployed DMN models.",
+ },
+ ONLINE_EDITOR__devDeploymentDmnFormWebappImageName: {
+ default: "incubator-kie-sandbox-dev-deployment-dmn-form-webapp",
+ description: "Image name to be used by Dev deployments to display a form
for deployed DMN models.",
+ },
+ ONLINE_EDITOR__devDeploymentDmnFormWebappImageTag: {
+ default: rootEnv.env.root.streamName,
+ description: "Image tag to be used by Dev deployments to display a form
for deployed DMN models.",
+ },
+ ONLINE_EDITOR__devDeploymentImagePullPolicy: {
+ default: "IfNotPresent",
+ description: "The image pull policy. Can be 'Always', 'IfNotPresent', or
'Never'.",
+ },
+ ONLINE_EDITOR_DEV__port: {
+ default: 9001,
+ description: "The development web server port",
+ },
+ ONLINE_EDITOR_DEV__https: {
+ default: "true",
+ description: "Tells if the development web server should use https",
+ },
+ }),
+ get env() {
+ return {
+ onlineEditor: {
+ dev: {
+ port: getOrDefault(this.vars.ONLINE_EDITOR_DEV__port),
+ https: str2bool(getOrDefault(this.vars.ONLINE_EDITOR_DEV__https)),
},
- devDeployments: {
- imagePullPolicy:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentImagePullPolicy),
- baseImage: {
- tag:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentBaseImageTag),
- registry:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentBaseImageRegistry),
- account:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentBaseImageAccount),
- name:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentBaseImageName),
- },
- kogitoQuarkusBlankAppImage: {
- tag:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageTag),
- registry:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageRegistry),
- account:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageAccount),
- name:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageName),
- },
- dmnFormWebappImage: {
- tag:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentDmnFormWebappImageTag),
- registry:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentDmnFormWebappImageRegistry),
- account:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentDmnFormWebappImageAccount),
- name:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentDmnFormWebappImageName),
+ gtmId: getOrDefault(this.vars.ONLINE_EDITOR__gtmId),
+ buildInfo: getOrDefault(this.vars.ONLINE_EDITOR__buildInfo),
+ extendedServices: {
+ compatibleVersion:
getOrDefault(this.vars.ONLINE_EDITOR__extendedServicesCompatibleVersion),
+ downloadUrl: {
+ linux:
getOrDefault(this.vars.ONLINE_EDITOR__extendedServicesDownloadUrlLinux),
+ macOs:
getOrDefault(this.vars.ONLINE_EDITOR__extendedServicesDownloadUrlMacOs),
+ windows:
getOrDefault(this.vars.ONLINE_EDITOR__extendedServicesDownloadUrlWindows),
},
},
- };
- },
- }
-);
+ appName: getOrDefault(this.vars.ONLINE_EDITOR__appName),
+ extendedServicesUrl:
getOrDefault(this.vars.ONLINE_EDITOR__extendedServicesUrl),
+ corsProxyUrl: getOrDefault(this.vars.ONLINE_EDITOR__corsProxyUrl),
+ feedbackUrl: getOrDefault(this.vars.ONLINE_EDITOR__feedbackUrl),
+ requireCustomCommitMessage:
str2bool(getOrDefault(this.vars.ONLINE_EDITOR__requireCustomCommitMessage)),
+ customCommitMessageValidationServiceUrl: getOrDefault(
+ this.vars.ONLINE_EDITOR__customCommitMessageValidationServiceUrl
+ ),
+ },
+ devDeployments: {
+ imagePullPolicy:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentImagePullPolicy),
+ baseImage: {
+ tag:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentBaseImageTag),
+ registry:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentBaseImageRegistry),
+ account:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentBaseImageAccount),
+ name:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentBaseImageName),
+ },
+ kogitoQuarkusBlankAppImage: {
+ tag:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageTag),
+ registry:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageRegistry),
+ account:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageAccount),
+ name:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentKogitoQuarkusBlankAppImageName),
+ },
+ dmnFormWebappImage: {
+ tag:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentDmnFormWebappImageTag),
+ registry:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentDmnFormWebappImageRegistry),
+ account:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentDmnFormWebappImageAccount),
+ name:
getOrDefault(this.vars.ONLINE_EDITOR__devDeploymentDmnFormWebappImageName),
+ },
+ },
+ };
+ },
+});
diff --git a/packages/playwright-base/env/index.js
b/packages/playwright-base/env/index.js
index aa985129957..eeee0430036 100644
--- a/packages/playwright-base/env/index.js
+++ b/packages/playwright-base/env/index.js
@@ -23,7 +23,7 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
vars: varsWithName({
PLAYWRIGHT_BASE__installDeps: {
default: "false",
- description: "Install Playwright dependencies",
+ description: "Toggles the installation of Playwright dependencies. Can
be `true` or `false`.",
},
}),
get env() {
diff --git
a/packages/serverless-logic-web-tools-base-builder-image-env/env/index.js
b/packages/serverless-logic-web-tools-base-builder-image-env/env/index.js
index 866e47e312c..afdfe513458 100644
--- a/packages/serverless-logic-web-tools-base-builder-image-env/env/index.js
+++ b/packages/serverless-logic-web-tools-base-builder-image-env/env/index.js
@@ -19,19 +19,25 @@
const { varsWithName, getOrDefault, composeEnv } =
require("@kie-tools-scripts/build-env");
-module.exports = composeEnv([require("@kie-tools/root-env/env")], {
+const rootEnv = require("@kie-tools/root-env/env");
+
+module.exports = composeEnv([rootEnv], {
vars: varsWithName({
SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageRegistry: {
default: "docker.io",
- description: "",
+ description: "E.g., `docker.io` or `quay.io`.",
},
SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageAccount: {
default: "apache",
- description: "",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageName: {
default: "incubator-kie-serverless-logic-web-tools-base-builder",
- description: "",
+ description: "Name of the image itself.",
+ },
+ SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTag: {
+ default: rootEnv.env.root.streamName,
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
}),
get env() {
@@ -40,6 +46,7 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
registry:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageRegistry),
account:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageAccount),
name:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageName),
+ buildTag:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTag),
},
};
},
diff --git
a/packages/serverless-logic-web-tools-base-builder-image/env/index.js
b/packages/serverless-logic-web-tools-base-builder-image/env/index.js
index e6c412f5db1..7e5ce6d62f9 100644
--- a/packages/serverless-logic-web-tools-base-builder-image/env/index.js
+++ b/packages/serverless-logic-web-tools-base-builder-image/env/index.js
@@ -19,32 +19,28 @@
const { varsWithName, getOrDefault, composeEnv } =
require("@kie-tools-scripts/build-env");
-const rootEnv = require("@kie-tools/root-env/env");
-
-module.exports = composeEnv([rootEnv,
require("@kie-tools/serverless-logic-web-tools-base-builder-image-env/env")], {
- vars: varsWithName({
- SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTags: {
- default: rootEnv.env.root.streamName,
- description: "",
- },
- SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderKubectlVersion: {
- default: "v1.27.3",
- description: "",
- },
- /* (begin) This part of the file is referenced in
`scripts/update-kogito-version` */
- SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderKogitoImageTag: {
- default: "999-20240509",
- description: "",
- },
- /* end */
- }),
- get env() {
- return {
- baseBuilderImage: {
- buildTags:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderImageBuildTags),
- kubectlVersion:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderKubectlVersion),
- kogitoImageTag:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderKogitoImageTag),
+module.exports = composeEnv(
+ [require("@kie-tools/root-env/env"),
require("@kie-tools/serverless-logic-web-tools-base-builder-image-env/env")],
+ {
+ vars: varsWithName({
+ SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderKubectlVersion: {
+ default: "v1.27.3",
+ description: "",
+ },
+ /* (begin) This part of the file is referenced in
`scripts/update-kogito-version` */
+ SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderKogitoImageTag: {
+ default: "999-20240509",
+ description: "",
},
- };
- },
-});
+ /* end */
+ }),
+ get env() {
+ return {
+ baseBuilderImage: {
+ kubectlVersion:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderKubectlVersion),
+ kogitoImageTag:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__baseBuilderKogitoImageTag),
+ },
+ };
+ },
+ }
+);
diff --git
a/packages/serverless-logic-web-tools-base-builder-image/package.json
b/packages/serverless-logic-web-tools-base-builder-image/package.json
index c2ee3852645..6716c9f443e 100644
--- a/packages/serverless-logic-web-tools-base-builder-image/package.json
+++ b/packages/serverless-logic-web-tools-base-builder-image/package.json
@@ -18,8 +18,7 @@
"build:prod:linux:darwin": "run-script-if --bool \"$(build-env
containerImages.build)\" --then \"pnpm image:docker:build\"",
"build:prod:win32": "echo \"Build not supported on Windows\"",
"cleanup": "rimraf dist-dev && mkdir dist-dev",
- "image:docker:build": "run-script-if --bool $([ $(command -v docker) ] &&
echo true || echo false) --then \"docker build --ulimit nofile=5000:5000 $(echo
$(build-env baseBuilderImage.buildTags) | xargs printf -- \"-t $(build-env
baseBuilderImageEnv.registry)/$(build-env
baseBuilderImageEnv.account)/$(build-env baseBuilderImageEnv.name):%s\n\" |
xargs echo) --build-arg KOGITO_IMAGE_TAG=$(build-env
baseBuilderImage.kogitoImageTag) --build-arg KUBECTL_VERSION=$(build-env
baseBuilderImag [...]
- "image:podman:build": "run-script-if --bool $([ $(command -v podman) ] &&
echo true || echo false) --then \"podman build --ulimit nofile=5000:5000 $(echo
$(build-env baseBuilderImage.buildTags) | xargs printf -- \"-t $(build-env
baseBuilderImageEnv.registry)/$(build-env
baseBuilderImageEnv.account)/$(build-env baseBuilderImageEnv.name):%s\n\" |
xargs echo) --build-arg KOGITO_IMAGE_TAG=$(build-env
baseBuilderImage.kogitoImageTag) --build-arg KUBECTL_VERSION=$(build-env
baseBuilderImag [...]
+ "image:docker:build": "run-script-if --bool $([ $(command -v docker) ] &&
echo true || echo false) --then \"docker build --ulimit nofile=5000:5000 $(echo
$(build-env baseBuilderImageEnv.buildTag) | xargs printf -- \"-t $(build-env
baseBuilderImageEnv.registry)/$(build-env
baseBuilderImageEnv.account)/$(build-env baseBuilderImageEnv.name):%s\n\" |
xargs echo) --build-arg KOGITO_IMAGE_TAG=$(build-env
baseBuilderImage.kogitoImageTag) --build-arg KUBECTL_VERSION=$(build-env
baseBuilderIm [...]
},
"devDependencies": {
"@kie-tools/root-env": "workspace:*",
diff --git
a/packages/serverless-logic-web-tools-swf-builder-image-env/env/index.js
b/packages/serverless-logic-web-tools-swf-builder-image-env/env/index.js
index f1db2afcf73..12c1289cada 100644
--- a/packages/serverless-logic-web-tools-swf-builder-image-env/env/index.js
+++ b/packages/serverless-logic-web-tools-swf-builder-image-env/env/index.js
@@ -19,19 +19,25 @@
const { varsWithName, getOrDefault, composeEnv } =
require("@kie-tools-scripts/build-env");
-module.exports = composeEnv([require("@kie-tools/root-env/env")], {
+const rootEnv = require("@kie-tools/root-env/env");
+
+module.exports = composeEnv([rootEnv], {
vars: varsWithName({
SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageRegistry: {
default: "docker.io",
- description: "",
+ description: "E.g., `docker.io` or `quay.io`.",
},
SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageAccount: {
default: "apache",
- description: "",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageName: {
default: "incubator-kie-serverless-logic-web-tools-swf-builder",
- description: "",
+ description: "Name of the image itself.",
+ },
+ SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTag: {
+ default: rootEnv.env.root.streamName,
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
}),
get env() {
@@ -40,6 +46,7 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
registry:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageRegistry),
account:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageAccount),
name:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageName),
+ buildTag:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTag),
},
};
},
diff --git a/packages/serverless-logic-web-tools-swf-builder-image/env/index.js
b/packages/serverless-logic-web-tools-swf-builder-image/env/index.js
index 17e98228e36..86df3331a33 100644
--- a/packages/serverless-logic-web-tools-swf-builder-image/env/index.js
+++ b/packages/serverless-logic-web-tools-swf-builder-image/env/index.js
@@ -25,10 +25,6 @@ const sonataflowBuilderImageEnv =
require("@kie-tools/sonataflow-builder-image/e
module.exports = composeEnv([rootEnv,
serverlessLogicWebToolsSwfBuilderImageEnv, sonataflowBuilderImageEnv], {
vars: varsWithName({
- SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTags: {
- default: rootEnv.env.root.streamName,
- description: "",
- },
SERVERLESS_LOGIC_WEB_TOOLS_SWF_BUILDER_IMAGE__baseImageUrl: {
default:
`${sonataflowBuilderImageEnv.env.sonataflowBuilderImage.registry}/${sonataflowBuilderImageEnv.env.sonataflowBuilderImage.account}/${sonataflowBuilderImageEnv.env.sonataflowBuilderImage.name}:${sonataflowBuilderImageEnv.env.sonataflowBuilderImage.tag}`,
description: "The image used in the FROM import.",
@@ -37,7 +33,6 @@ module.exports = composeEnv([rootEnv,
serverlessLogicWebToolsSwfBuilderImageEnv,
get env() {
return {
swfBuilderImage: {
- buildTags:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__swfBuilderImageBuildTags),
baseImageUrl:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS_SWF_BUILDER_IMAGE__baseImageUrl),
},
};
diff --git a/packages/serverless-logic-web-tools-swf-builder-image/package.json
b/packages/serverless-logic-web-tools-swf-builder-image/package.json
index 70e1ffccea2..a31dc584cff 100644
--- a/packages/serverless-logic-web-tools-swf-builder-image/package.json
+++ b/packages/serverless-logic-web-tools-swf-builder-image/package.json
@@ -21,8 +21,7 @@
"cleanup": "rimraf dist-dev && mkdir dist-dev",
"copy:assets": "pnpm copy:webapp",
"copy:webapp": "cp -r ./node_modules/sonataflow-deployment-webapp/dist
dist-dev/webapp",
- "image:docker:build": "run-script-if --bool $([ $(command -v docker) ] &&
echo true || echo false) --then \"docker build --ulimit nofile=5000:5000 $(echo
$(build-env swfBuilderImage.buildTags) | xargs printf -- \"-t $(build-env
swfBuilderImageEnv.registry)/$(build-env
swfBuilderImageEnv.account)/$(build-env swfBuilderImageEnv.name):%s\n\" | xargs
echo) --build-arg BASE_IMAGE_URL=$(build-env swfBuilderImage.baseImageUrl) .\"
--else \"echo Docker not found, skipping image build.\"",
- "image:podman:build": "run-script-if --bool $([ $(command -v podman) ] &&
echo true || echo false) --then \"podman build --ulimit nofile=5000:5000 $(echo
$(build-env swfBuilderImage.buildTags) | xargs printf -- \"-t $(build-env
swfBuilderImageEnv.registry)/$(build-env
swfBuilderImageEnv.account)/$(build-env swfBuilderImageEnv.name):%s\n\" | xargs
echo) --build-arg BASE_IMAGE_URL=$(build-env swfBuilderImage.baseImageUrl) -f
Containerfile\" --else \"echo Podman not found, skipping imag [...]
+ "image:docker:build": "run-script-if --bool $([ $(command -v docker) ] &&
echo true || echo false) --then \"docker build --ulimit nofile=5000:5000 $(echo
$(build-env swfBuilderImageEnv.buildTag) | xargs printf -- \"-t $(build-env
swfBuilderImageEnv.registry)/$(build-env
swfBuilderImageEnv.account)/$(build-env swfBuilderImageEnv.name):%s\n\" | xargs
echo) --build-arg BASE_IMAGE_URL=$(build-env swfBuilderImage.baseImageUrl) .\"
--else \"echo Docker not found, skipping image build.\""
},
"devDependencies": {
"@kie-tools/root-env": "workspace:*",
diff --git
a/packages/serverless-logic-web-tools-swf-dev-mode-image-env/env/index.js
b/packages/serverless-logic-web-tools-swf-dev-mode-image-env/env/index.js
index 2b4502e0575..bc9514484a1 100644
--- a/packages/serverless-logic-web-tools-swf-dev-mode-image-env/env/index.js
+++ b/packages/serverless-logic-web-tools-swf-dev-mode-image-env/env/index.js
@@ -19,19 +19,25 @@
const { varsWithName, getOrDefault, composeEnv } =
require("@kie-tools-scripts/build-env");
-module.exports = composeEnv([require("@kie-tools/root-env/env")], {
+const rootEnv = require("@kie-tools/root-env/env");
+
+module.exports = composeEnv([rootEnv], {
vars: varsWithName({
SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageRegistry: {
default: "docker.io",
- description: "",
+ description: "E.g., `docker.io` or `quay.io`.",
},
SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageAccount: {
default: "apache",
- description: "",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageName: {
default: "incubator-serverless-logic-web-tools-swf-dev-mode",
- description: "",
+ description: "Name of the image itself.",
+ },
+ SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTag: {
+ default: rootEnv.env.root.streamName,
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
}),
get env() {
@@ -40,6 +46,7 @@ module.exports =
composeEnv([require("@kie-tools/root-env/env")], {
registry:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageRegistry),
account:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageAccount),
name:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageName),
+ buildTag:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTag),
},
};
},
diff --git
a/packages/serverless-logic-web-tools-swf-dev-mode-image/env/index.js
b/packages/serverless-logic-web-tools-swf-dev-mode-image/env/index.js
index d994c06bb01..91c37628755 100644
--- a/packages/serverless-logic-web-tools-swf-dev-mode-image/env/index.js
+++ b/packages/serverless-logic-web-tools-swf-dev-mode-image/env/index.js
@@ -23,10 +23,6 @@ const rootEnv = require("@kie-tools/root-env/env");
module.exports = composeEnv([rootEnv,
require("@kie-tools/serverless-logic-web-tools-swf-dev-mode-image-env/env")], {
vars: varsWithName({
- SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTags: {
- default: rootEnv.env.root.streamName,
- description: "",
- },
/* (begin) This part of the file is referenced in
`scripts/update-kogito-version` */
SERVERLESS_LOGIC_WEB_TOOLS_DEVMODE_IMAGE__kogitoBaseBuilderImageTag: {
default: "999-20240509",
@@ -38,7 +34,6 @@ module.exports = composeEnv([rootEnv,
require("@kie-tools/serverless-logic-web-t
return {
swfDevModeImage: {
version: require("../package.json").version,
- buildTags:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS__swfDevModeImageBuildTags),
kogitoImageTag:
getOrDefault(this.vars.SERVERLESS_LOGIC_WEB_TOOLS_DEVMODE_IMAGE__kogitoBaseBuilderImageTag),
},
};
diff --git
a/packages/serverless-logic-web-tools-swf-dev-mode-image/package.json
b/packages/serverless-logic-web-tools-swf-dev-mode-image/package.json
index d7620ed198a..791a7d5f1b2 100644
--- a/packages/serverless-logic-web-tools-swf-dev-mode-image/package.json
+++ b/packages/serverless-logic-web-tools-swf-dev-mode-image/package.json
@@ -15,15 +15,14 @@
"scripts": {
"build:dev": "echo Nothing to do",
"build:prod": "pnpm cleanup && run-script-os",
- "build:prod:darwin:linux": "run-script-if --bool \"$(build-env
containerImages.build)\" --then \"pnpm copy:assets\" \"pnpm
image:podman:build\"",
+ "build:prod:darwin:linux": "run-script-if --bool \"$(build-env
containerImages.build)\" --then \"pnpm copy:assets\" \"pnpm
image:docker:build\"",
"build:prod:win32": "echo \"Build not supported on Windows\"",
"cleanup": "rimraf dist-dev && mkdir dist-dev",
"copy:assets": "pnpm copy:quarkus-app && pnpm
copy:sonataflow-deployment-webapp && pnpm copy:m2-for-sonataflow-quarkus-devui",
"copy:m2-for-sonataflow-quarkus-devui": "mvn dependency:copy-dependencies
-Dmdep.useRepositoryLayout=true -Dmdep.copyPom=true -DexcludeTransitive=true
-DoutputDirectory=./dist-dev/quarkus-app-m2",
"copy:quarkus-app": "cp -R
./node_modules/@kie-tools/serverless-logic-web-tools-swf-deployment-quarkus-app/
./dist-dev/quarkus-app && mkdir -p
./dist-dev/quarkus-app/src/main/resources/META-INF/resources/ && rm -rf
./dist-dev/quarkus-app/node_modules ./dist-dev/quarkus-app/install.js
./dist-dev/quarkus-app/env ./dist-dev/quarkus-app/package.json",
"copy:sonataflow-deployment-webapp": "cp -R
./node_modules/sonataflow-deployment-webapp/dist/*
./dist-dev/quarkus-app/src/main/resources/META-INF/resources",
- "image:docker:build": "run-script-if --bool $([ $(command -v docker) ] &&
echo true || echo false) --then \"docker build --ulimit nofile=5000:5000 $(echo
$(build-env swfDevModeImage.buildTags) | xargs printf -- \"-t $(build-env
swfDevModeImageEnv.registry)/$(build-env
swfDevModeImageEnv.account)/$(build-env swfDevModeImageEnv.name):%s\n\" | xargs
echo) --build-arg KOGITO_IMAGE_TAG=$(build-env swfDevModeImage.kogitoImageTag)
.\" --else \"echo Docker not found, skipping image build.\"",
- "image:podman:build": "run-script-if --bool $([ $(command -v podman) ] &&
echo true || echo false) --then \"podman build --ulimit nofile=5000:5000 $(echo
$(build-env swfDevModeImage.buildTags) | xargs printf -- \"-t $(build-env
swfDevModeImageEnv.registry)/$(build-env
swfDevModeImageEnv.account)/$(build-env swfDevModeImageEnv.name):%s\n\" | xargs
echo) --build-arg KOGITO_IMAGE_TAG=$(build-env swfDevModeImage.kogitoImageTag)
-f Containerfile\" --else \"echo Podman not found, skipping [...]
+ "image:docker:build": "run-script-if --bool $([ $(command -v docker) ] &&
echo true || echo false) --then \"docker build --ulimit nofile=5000:5000 $(echo
$(build-env swfDevModeImageEnv.buildTag) | xargs printf -- \"-t $(build-env
swfDevModeImageEnv.registry)/$(build-env
swfDevModeImageEnv.account)/$(build-env swfDevModeImageEnv.name):%s\n\" | xargs
echo) --build-arg KOGITO_IMAGE_TAG=$(build-env swfDevModeImage.kogitoImageTag)
.\" --else \"echo Docker not found, skipping image build.\"",
"install": "node install.js"
},
"devDependencies": {
diff --git a/packages/sonataflow-builder-image/README.md
b/packages/sonataflow-builder-image/README.md
index fb89fcf73fc..ed37ca271a5 100644
--- a/packages/sonataflow-builder-image/README.md
+++ b/packages/sonataflow-builder-image/README.md
@@ -27,7 +27,7 @@ image along with the modules and scripts provided in
`@kie-tools/sonataflow-imag
- **cekit 4.11.0**: [docs.cekit.io](https://docs.cekit.io/en/latest/index.html)
- **s2i**: [source-to-image](https://github.com/openshift/source-to-image)
- **make**
-- **docker** or **podman**
+- **docker**
## Build
@@ -60,12 +60,6 @@ image along with the modules and scripts provided in
`@kie-tools/sonataflow-imag
docker images
```
- or
-
- ```bash
- podman images
- ```
-
## Testing the generated image (only for Linux)
- With the image generated, run:
diff --git a/packages/sonataflow-devmode-image/README.md
b/packages/sonataflow-devmode-image/README.md
index 0ee2fda5fd0..7c68e439b3e 100644
--- a/packages/sonataflow-devmode-image/README.md
+++ b/packages/sonataflow-devmode-image/README.md
@@ -27,7 +27,7 @@ image along with the modules and scripts provided in
`@kie-tools/sonataflow-imag
- **cekit 4.11.0**: [docs.cekit.io](https://docs.cekit.io/en/latest/index.html)
- **s2i**: [source-to-image](https://github.com/openshift/source-to-image)
- **make**
-- **docker** or **podman**
+- **docker**
## Build
@@ -60,12 +60,6 @@ image along with the modules and scripts provided in
`@kie-tools/sonataflow-imag
docker images
```
- or
-
- ```bash
- podman images
- ```
-
## Testing the generated image (only for Linux)
- With the image generated, run:
diff --git a/packages/sonataflow-devmode-image/env/index.js
b/packages/sonataflow-devmode-image/env/index.js
index d700e5b3914..660f9197301 100644
--- a/packages/sonataflow-devmode-image/env/index.js
+++ b/packages/sonataflow-devmode-image/env/index.js
@@ -26,19 +26,19 @@ module.exports = composeEnv([rootEnv], {
vars: varsWithName({
SONATAFLOW_DEVMODE_IMAGE__registry: {
default: "docker.io",
- description: "The image registry.",
+ description: "E.g., `docker.io` or `quay.io`.",
},
SONATAFLOW_DEVMODE_IMAGE__account: {
default: "apache",
- description: "The image registry account.",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
SONATAFLOW_DEVMODE_IMAGE__name: {
default: "incubator-kie-sonataflow-devmode",
- description: "The image name.",
+ description: "Name of the image itself.",
},
SONATAFLOW_DEVMODE_IMAGE__buildTag: {
default: rootEnv.env.root.streamName,
- description: "The image tag.",
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
SONATAFLOW_DEVMODE_IMAGE__sonataflowQuarkusDevUiVersion: {
default:
sonataFlowQuarkusDevUiEnv.env.sonataflowQuarkusDevuiExtension.version,
diff --git a/packages/sonataflow-image-common/README.md
b/packages/sonataflow-image-common/README.md
index 1d6ae9d253e..96f1e6bf146 100644
--- a/packages/sonataflow-image-common/README.md
+++ b/packages/sonataflow-image-common/README.md
@@ -32,7 +32,7 @@ The contents of this package are:
- `behave` `lxml` `docker` `docker-squash` `elementPath` `pyyaml`
`ruamel.yaml` `python-dateutil` `Jinja2` `pykwalify` `colorlog` `click`
- **cekit 4.11.0**: [docs.cekit.io](https://docs.cekit.io/en/latest/index.html)
- **make**
-- **docker** or **podman**
+- **docker**
## Using the Makefile
diff --git a/packages/sonataflow-operator/env/index.js
b/packages/sonataflow-operator/env/index.js
index 768e48196f8..bb7dff616d4 100644
--- a/packages/sonataflow-operator/env/index.js
+++ b/packages/sonataflow-operator/env/index.js
@@ -27,19 +27,19 @@ module.exports = composeEnv([rootEnv,
sonataflowBuilderImageEnv, sonataflowDevMo
vars: varsWithName({
SONATAFLOW_OPERATOR__registry: {
default: "docker.io",
- description: "The image registry.",
+ description: "E.g., `docker.io` or `quay.io`.",
},
SONATAFLOW_OPERATOR__account: {
default: "apache",
- description: "The image registry account.",
+ description: "E.g,. `apache` or `kie-tools-bot`",
},
SONATAFLOW_OPERATOR__name: {
default: "incubator-kie-sonataflow-operator",
- description: "The image name.",
+ description: "Name of the image itself.",
},
SONATAFLOW_OPERATOR__buildTag: {
default: rootEnv.env.root.streamName,
- description: "The image tag",
+ description: "Tag version of this image. E.g., `main` or `10.0.x` or
`10.0.0",
},
SONATAFLOW_OPERATOR__sonataflowBuilderImage: {
default:
`${sonataflowBuilderImageEnv.env.sonataflowBuilderImage.registry}/${sonataflowBuilderImageEnv.env.sonataflowBuilderImage.account}/${sonataflowBuilderImageEnv.env.sonataflowBuilderImage.name}:${sonataflowBuilderImageEnv.env.sonataflowBuilderImage.tag}`,
diff --git a/packages/webpack-base/env/index.js
b/packages/webpack-base/env/index.js
index 1b0289ea9f7..b6197258853 100644
--- a/packages/webpack-base/env/index.js
+++ b/packages/webpack-base/env/index.js
@@ -23,19 +23,23 @@ module.exports = composeEnv([], {
vars: varsWithName({
WEBPACK__minimize: {
default: undefined,
- description: "",
+ description:
+ "Whether or not `webpack` should minimize its bundled files. Can be
`true` or `false`. Works for all packages on invocations of `webpack` during a
`kie-tools` build.",
},
WEBPACK__tsLoaderTranspileOnly: {
default: undefined,
- description: "",
+ description:
+ "Whether or not `webpack` should skip type-checking TypeScript files.
Can be `true` or `false`. Works for all packages on invocations of `webpack`
during a `kie-tools` build.",
},
WEBPACK__sourceMaps: {
default: undefined,
- description: "",
+ description:
+ "Whether or not `webpack` should include source maps for its bundled
files. Can be `true` or `false`. Works for all packages on invocations of
`webpack` during a `kie-tools` build.",
},
WEBPACK__mode: {
default: undefined,
- description: "",
+ description:
+ "Can be `development` or `production`. Works for all packages on
invocations of `webpack` during a `kie-tools` build.",
},
}),
get env() {
diff --git a/scripts/bootstrap/bootstrap.js b/scripts/bootstrap/bootstrap.js
index 1d8c0c9a77c..ae097f7f6df 100755
--- a/scripts/bootstrap/bootstrap.js
+++ b/scripts/bootstrap/bootstrap.js
@@ -44,8 +44,8 @@ execSync(`node
${require.resolve("./link_packages_with_self.js")}`, execOpts);
console.info("\n\n[bootstrap] Generating packages graph...");
execSync(`node ${require.resolve("./generate_packages_graph.js")}
${path.resolve(__dirname, "../../repo")}`, execOpts);
-console.info("\n\n[bootstrap] Generating build-env report...");
-execSync(`node ${require.resolve("./generate_build_env_report.mjs")}
${pnpmFilterString}`, execOpts);
+console.info("\n\n[bootstrap] Printing build-env report...");
+execSync(`node ${require.resolve("./print_build_env_report.mjs")}
${pnpmFilterString}`, execOpts);
console.info("\n\n[bootstrap] Checking required preinstalled CLI commands...");
execSync(`node
${require.resolve("./check_required_preinstalled_cli_commands.mjs")}
${pnpmFilterString}`, execOpts);
diff --git a/scripts/bootstrap/generate_build_env_report.mjs
b/scripts/bootstrap/print_build_env_report.mjs
similarity index 82%
rename from scripts/bootstrap/generate_build_env_report.mjs
rename to scripts/bootstrap/print_build_env_report.mjs
index af1d99bf7a4..e850a38c94c 100644
--- a/scripts/bootstrap/generate_build_env_report.mjs
+++ b/scripts/bootstrap/print_build_env_report.mjs
@@ -20,7 +20,8 @@
import * as path from "path";
import * as fs from "fs";
import { markdownTable } from "markdown-table";
-import { treatVarToPrint, requireEnv } from
"@kie-tools-scripts/build-env/dist/lib.js";
+import { requireEnv } from "@kie-tools-scripts/build-env/dist/lib.js";
+import { getOrDefault } from "@kie-tools-scripts/build-env/dist/index.js";
import { pnpmFilter } from "./pnpm_filter.js";
let pnpmFilterString;
@@ -41,11 +42,9 @@ if (process.argv[2] === "--write-to") {
async function main() {
if (pnpmFilterString.length === 0) {
- console.info("[generate-build-env-report] Generating build-env report of
all packages...");
+ console.info("[print-build-env-report] Printing build-env report of all
packages...");
} else {
- console.info(
- `[generate-build-env-report] Generating build-env report of packages
filtered by '${pnpmFilterString}'`
- );
+ console.info(`[print-build-env-report] Printing build-env report of
packages filtered by '${pnpmFilterString}'`);
}
// NOTE: This is not recursive as build-env
@@ -91,7 +90,7 @@ async function main() {
console.info(JSON.stringify(shortReport, undefined, 2));
}
- console.info("[generate-build-env-report] Done.");
+ console.info("[print-build-env-report] Done.");
}
function buildVarsReport(pkgs) {
@@ -126,4 +125,16 @@ function concatArraysWithoutDuplicates(a, b) {
return new Set([...(a ?? []), ...(b ?? [])]);
}
+function treatVarToPrint(varWithName) {
+ let value = getOrDefault(varWithName);
+ if (varWithName.default === undefined && value) {
+ value += " <- CHANGED 👀️ ";
+ } else if (value === undefined) {
+ value = "[unset] Default value may vary ⚠️ ";
+ } else if (value !== varWithName.default) {
+ value += " <- CHANGED 👀️ ";
+ }
+ return value;
+}
+
await main();
diff --git a/scripts/build-env/README.md b/scripts/build-env/README.md
index bbe0ed6adcb..249946f4acb 100644
--- a/scripts/build-env/README.md
+++ b/scripts/build-env/README.md
@@ -27,19 +27,19 @@ Env definition files are plain JavaScript, allowing for
better flexibility and u
### Usage
-- `build-env --print-vars`
-
- - Prints the env variables in JSON format.
-
-- `build-env --print-env`
-
- - Prints the env properties in JSON format.
-
- `build-env {dot.separated.property}`
- Returns the value of a property. See available properties with `build-env
--print-env`.
- e.g. `build-env root.version` prints `0.0.0`.
- It's possible to negate boolean values with the `--not flag.`
- e.g. If `build-env build.runTests` prints `true`, then e.g. `build-env
build.runTests --not` prints `false`
+- `build-env --print-vars`
+ - Prints the env var names.
+- `build-env --print-env-json`
+ - Prints the JSON object for this env.
+- `build-env --print-dotenv`
+ - Prints variables assigned to values in .env format.
+
+> You can append `:self` to any of the three commands above to see results
that ignore composition with other envs.
### Configuration
@@ -102,7 +102,7 @@ $ build-env myProperty
foo
$ build-env myOtherProperty
[build-env] Env property 'myOtherProperty' not found.
-[build-env] See all env properties with 'build-env --print-env'
+[build-env] See all env properties with 'build-env --print-env-json'
$ cd ~/[my-repo]/packages/b
$ build-env myProperty
diff --git a/scripts/build-env/src/bin.ts b/scripts/build-env/src/bin.ts
index 7ebb2b471eb..f35a4dbf123 100644
--- a/scripts/build-env/src/bin.ts
+++ b/scripts/build-env/src/bin.ts
@@ -25,15 +25,19 @@ import * as fs from "fs";
import * as os from "os";
import { treatSpecialPrintCases } from "./special_print_cases";
+import { treatStaticPrintCases } from "./static_print_cases";
const opt = process.argv[2];
const flag = process.argv[3];
async function main() {
+ // This will exit the process if a static print case is requested using `opt`
+ treatStaticPrintCases({ opt });
+
const { env, vars, self } = await findEnv(path.resolve("."),
path.resolve("."));
// This will exit the process if a special print case is requested using
`opt`.
- treatSpecialPrintCases({ opt, vars, self });
+ treatSpecialPrintCases({ opt, env, vars, self });
const propertyPath = opt;
if (!propertyPath) {
@@ -76,18 +80,18 @@ async function main() {
}
main().catch((e) => {
- const suppliedPath =
process.env[ERROR_ACCESS_LOG_FILE_ABSOLUTE_PATH_ENV_VAR_NAME];
- const defaultPath = path.join(os.tmpdir(), "build-env-access-errors.log");
+ const suppliedLogFilePath =
process.env[ERROR_ACCESS_LOG_FILE_ABSOLUTE_PATH_ENV_VAR_NAME];
+ const defaultLogFilePath = path.join(os.tmpdir(),
"build-env-access-errors.log");
let logFilePath;
- if (!suppliedPath) {
- logFilePath = defaultPath;
+ if (!suppliedLogFilePath) {
+ logFilePath = defaultLogFilePath;
console.error(LOGS.warn.defaultingAccessErrorsLogFileToTmpDirBecauseNotSupplied({
logFilePath }));
- } else if (!path.isAbsolute(suppliedPath)) {
- logFilePath = defaultPath;
+ } else if (!path.isAbsolute(suppliedLogFilePath)) {
+ logFilePath = defaultLogFilePath;
console.error(LOGS.warn.defaultingAccessErrorsLogFileToTmpDirBecauseNotSupplied({
logFilePath }));
} else {
- logFilePath = suppliedPath;
+ logFilePath = suppliedLogFilePath;
console.error(LOGS.error.usingConfiguredAccessErrorLogFile({ logFilePath
}));
}
diff --git a/scripts/build-env/src/console_logs.ts
b/scripts/build-env/src/console_logs.ts
index 2ce7dcba018..8c85a89c15f 100644
--- a/scripts/build-env/src/console_logs.ts
+++ b/scripts/build-env/src/console_logs.ts
@@ -65,7 +65,7 @@ export const LOGS = {
},
info: {
seeAllEnvProperties() {
- return `[build-env] See all env properties with 'build-env --print-env'`;
+ return `[build-env] See all env properties with 'build-env
--print-env-json'`;
},
wroteAccessErrorLog(args: { logFilePath: string }) {
return `[build-env] Wrote access error to: '${args.logFilePath}'.`;
diff --git a/scripts/build-env/src/lib.ts b/scripts/build-env/src/lib.ts
index d432e040734..d79ee8eceed 100644
--- a/scripts/build-env/src/lib.ts
+++ b/scripts/build-env/src/lib.ts
@@ -65,22 +65,10 @@ export async function findEnv(startDir: string, curDir:
string): Promise<EnvAndV
return findEnv(startDir, path.dirname(curDir));
}
-export function treatVarToPrint<T>(varr: VarWithName) {
- let value = getOrDefault(varr);
- if (varr.default === undefined && value) {
- value += " <- CHANGED 👀️ ";
- } else if (value === undefined) {
- value = "[unset] Default value may vary ⚠️ ";
- } else if (value !== varr.default) {
- value += " <- CHANGED 👀️ ";
- }
- return value;
-}
-
-export function parseVars<T>(vars: { [K in keyof T]: VarWithName }) {
+export function parseVarsForDotEnvPrint<T>(vars: { [K in keyof T]: VarWithName
}) {
const result: Record<string, string | undefined> = {};
for (const v in vars) {
- result[v] = treatVarToPrint(vars[v]);
+ result[v] = getOrDefault(vars[v]) ?? "";
}
return result;
}
diff --git a/scripts/build-env/src/special_print_cases.ts
b/scripts/build-env/src/special_print_cases.ts
index 33d3c0f728d..1f938edd3b6 100644
--- a/scripts/build-env/src/special_print_cases.ts
+++ b/scripts/build-env/src/special_print_cases.ts
@@ -17,51 +17,49 @@
* under the License.
*/
-import { env } from "process";
-import { flattenObj, parseVars } from "./lib";
+import { flattenObj, parseVarsForDotEnvPrint } from "./lib";
import { EnvAndVarsWithName } from "./types";
export function treatSpecialPrintCases({
opt,
vars,
self,
+ env,
}: {
opt: string;
vars: EnvAndVarsWithName<any>["vars"];
self: EnvAndVarsWithName<any>["self"];
+ env: EnvAndVarsWithName<any>["env"];
}) {
+ // vars
if (opt === "--print-vars") {
- console.log(JSON.stringify(flattenObj(parseVars(vars)), undefined, 2));
+ console.log(Object.keys(vars ?? {}).join("\n"));
+ process.exit(0);
+ } else if (opt === "--print-vars:self") {
+ console.log(Object.keys(self.vars ?? {}).join("\n"));
process.exit(0);
}
- if (opt === "--print-env") {
+ // env json
+ if (opt === "--print-env-json") {
console.log(JSON.stringify(flattenObj(env), undefined, 2));
process.exit(0);
+ } else if (opt === "--print-env-json:self") {
+ console.log(JSON.stringify(flattenObj(self.env), undefined, 2));
+ process.exit(0);
}
- if (opt === "--print-env-file") {
- const flattenedParsedVars = flattenObj(parseVars(vars));
+ // dotenv
+ if (opt === "--print-dotenv") {
+ const flattenedParsedVars = parseVarsForDotEnvPrint(vars);
let envFile = "";
for (const key of Object.keys(flattenedParsedVars)) {
envFile += `${key}=${flattenedParsedVars[key]}\n`;
}
console.log(envFile);
process.exit(0);
- }
-
- if (opt === "--print-vars:self") {
- console.log(JSON.stringify(flattenObj(parseVars(self.vars)), undefined,
2));
- process.exit(0);
- }
-
- if (opt === "--print-env:self") {
- console.log(JSON.stringify(flattenObj(self.env), undefined, 2));
- process.exit(0);
- }
-
- if (opt === "--print-env-file:self") {
- const flattenedParsedVars = flattenObj(parseVars(self.vars));
+ } else if (opt === "--print-dotenv:self") {
+ const flattenedParsedVars = parseVarsForDotEnvPrint(self.vars);
let envFile = "";
for (const key of Object.keys(flattenedParsedVars)) {
envFile += `${key}=${flattenedParsedVars[key]}\n`;
diff --git a/scripts/build-env/src/static_print_cases.ts
b/scripts/build-env/src/static_print_cases.ts
new file mode 100644
index 00000000000..01301dc495a
--- /dev/null
+++ b/scripts/build-env/src/static_print_cases.ts
@@ -0,0 +1,83 @@
+/*
+ * 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.
+ */
+
+import { LOGS } from "./console_logs";
+
+export function treatStaticPrintCases({ opt }: { opt: string }) {
+ //help
+ if (opt === "--help") {
+ console.log(
+ `
+build-env is a tool to manage environment variables inside packages.
+It maps environment variables into a JSON object and makes them accessible via
JSON paths byparsing 'env/index.js' files exporting an object of type
'EnvAndVarsWithName'.
+
+Usage:
+ build-env my.custom.property
+ Prints a value.
+
+ build-env my.custom.bool --not
+ Prints a negated boolean. Will error out if value is different
than 'true' or 'false'.
+or
+ build-env --print-vars
+ Prints the env var names.
+ build-env --print-vars:self
+ Same as above, but ignores composition with other envs.
+
+ build-env --print-env-json
+ Prints the JSON object for this env.
+ build-env --print-env-json:self
+ Same as above, but ignores composition with other envs.
+
+ build-env --print-dotenv
+ Prints variables assigned to values in .env format.
+ build-env --print-dotenv:self
+ Same as above, but ignores composition with other envs.
+
+ build-env --generate-empty-env-index-js
+ Generates an empty env/index.js file with the correct structure
and imports.
+
+ build-env --help
+ Prints this message.
+`.trim()
+ );
+ process.exit(0);
+ }
+
+ // generate empty env/index.js
+ if (opt === "--generate-empty-env-index-js") {
+ console.log(
+ `
+const { varsWithName, composeEnv, getOrDefault, str2bool } =
require("@kie-tools-scripts/build-env");
+
+module.exports = composeEnv([require("@kie-tools/root-env/env")], {
+ vars: varsWithName({
+ MY_CUSTOM_PROPERTY: {
+ default: "true",
+ description: "My custom property"
+ }
+ }),
+ get env() {
+ return { my: { custom: { property:
str2bool(getOrDefault(this.vars.MY_CUSTOM_PROPERTY)) } } };
+ },
+});
+`.trim()
+ );
+ process.exit(0);
+ }
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
