Merge pull request #29 from fantonangeli/sync-main-pr-2024-06-10

Sync main branch with Apache main branch

.gitignore

@@ -1,3 +1,21 @@
+###
+# 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.
+
 ## ci
 !/.ci
 
@@ -187,18 +205,18 @@ packages/kie-sandbox-fs/coverage
 packages/kie-sandbox-fs/junit
 packages/kie-sandbox-fs/*-0.0.0-development.tgz
 
-# kogito-serverless-operator
+# sonataflow-operator
 # These files are generated by Cekit, we can ignore the operator-sdk ones.
-packages/kogito-serverless-operator/bundle.Dockerfile
-packages/kogito-serverless-operator/Dockerfile
+packages/sonataflow-operator/bundle.Dockerfile
+packages/sonataflow-operator/Dockerfile
 # Test binary, built with `go test -c`
-packages/kogito-serverless-operator/**/*.test
+packages/sonataflow-operator/**/*.test
 # Output of the go coverage tool, specifically when used with LiteIDE
-packages/kogito-serverless-operator/**/*.out
+packages/sonataflow-operator/**/*.out
 # Build
-packages/kogito-serverless-operator/bin/
-packages/kogito-serverless-operator/target/
-packages/kogito-serverless-operator/e2e-test-report.xml
+packages/sonataflow-operator/bin/
+packages/sonataflow-operator/target/
+packages/sonataflow-operator/e2e-test-report.xml
 
 #angular
 **/.angular
@@ -293,12 +311,12 @@ packages/dmn-marshaller/**/ts-gen
 packages/scesim-marshaller/**/ts-gen
 
 # kogito-sf-{builder|devmode}-image: excluding module build folders
-!packages/kogito-swf-common/resources/**/build
-!packages/kogito-swf-builder/resources/**/build
-!packages/kogito-swf-devmode/resources/**/build
-!packages/kogito-swf-common/test-resources/
-!packages/kogito-swf-builder/test-resources/
-!packages/kogito-swf-devmode/test-resources/
+!packages/sonataflow-image-common/resources/**/build
+!packages/sonataflow-builder-image/resources/**/build
+!packages/sonataflow-devmode-image/resources/**/build
+!packages/sonataflow-image-common/test-resources/
+!packages/sonataflow-builder-image/test-resources/
+!packages/sonataflow-devmode-image/test-resources/
 
 __pycache__
 packages/python-venv/venv

DISCLAIMER

@@ -15,6 +15,11 @@ aware of (note that this list, by definition, is likely to be incomplete):
 * Some files, particularly test files, and those not supporting comments, may be missing the ASF Licensing Header
 * 
 
+* Hibernate, an LGPL project, is being used. Hibernate is in the process of
+  relicensing to ASL v2
+* Some files, particularly test files, and those not supporting comments, may
+  be missing the ASF Licensing Header
+
 If you are planning to incorporate this work into your product/project, please
 be aware that you will need to conduct a thorough licensing review to determine
 the overall implications of including this work. For the current status of this

KOGITO_UPGRADE_PROCESS.md

@@ -1,3 +1,20 @@
+<!--
+   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.
+-->
+
 This guide aims to assist you in the process of upgrading all Kogito dependencies versions present in the kie-tools repository.
 Typically, these dependencies point to backend-side modules or images
 
@@ -56,7 +73,6 @@ You can find an example of the Java / Maven versions upgrade in [this PR](https:
 
 The Quarkus version is present in the following file categories:
 
-- `install.js` files
 - `root-env/env/index.js` file
 - go test files
 
@@ -70,16 +86,7 @@ You can find an example of the Quarkus upgrade in [this PR](https://github.com/a
 
 # Upgrading Kogito
 
-The Kogito version is present in the following file categories:
-
-- `install.js` files
-- `root-env/env/index.js` file
-- `package.json` files (eg. jit-executor reference in `extended-service`)
-
-The best (and fastest) way to catch all the Kogito versions is to perform a search a grep (or the IDE integrated search) and replace it with the new version. So, as a key, you can use:
-
-- The version number: `X.Y.Z` or `X.Y.Z-YYYYMMDD-SNAPSHOT` format (eg. `10.0.0` or `10.1.0-20240424-SNAPSHOT`);
-- Images references: `main-YYYY-MM-DD` (Daily builds) or `X.Y.Z-YYYYMMDD` (Weekly builds) format (eg. `main-2024-04-24` or `10.1.0-20240424` in case of snapshot version)
+In the root directory, run `pnpm update-kogito-version-to --maven [version] --images-tag [tag]`.
 
 Of course, a new Kogito version may lead to incompatibilities in the code and with other dependencies. In such a case, an investigation and evetually a fix is required to complete the process.
 
@@ -98,3 +105,14 @@ To test the `kie-sandbox-quarkus-accelerator` module with the updated version, p
 - Run `pnpm -F @kie-tools/online-editor... build:dev` and `pnpm -F @kie-tools/online-editor start` to test it.
 
 You can find an example of the Kogito version upgrade in [this PR](https://github.com/apache/incubator-kie-sandbox-quarkus-accelerator/pull/8)
+
+# Upgrading GraphQL schemas in `@kie-tools/runtime-tools-process-gateway-api`& `@kie-tools/runtime-tools-swf-gateway-api`
+
+The following commands will help to sync up the gateway apis the GraphQL schema with the new Kogito Data Index GraphQL schema:
+
+- Start a blank Data Index Container, for example `docker run -p8180:8080 docker.io/apache/incubator-kie-kogito-data-index-ephemeral:{$KOGITO_VERSION}`
+- Run `pnpm -F @kie-tools/runtime-tools-process-gateway-api graphql:codegen`
+- Run `pnpm -F @kie-tools/runtime-tools-swf-gateway-api graphql:codegen`
+
+After upgrading the GraphQL schemas it is recommended to verify that the incoming changes aren't breaking the consoles or
+devui's and fix any possible conflict if needed.

NIX_DEV_ENV.md

@@ -1,3 +1,20 @@
+<!--
+   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.
+-->
+
 ## Nix-based development environment shell
 
 ### Installing

README.md

@@ -1,3 +1,20 @@
+<!--
+   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.
+-->
+
 <p align="center"><img width=40% src="docs/kie.svg"></p>
 
 ---

RELEASE_PROCESS.md

@@ -1,3 +1,20 @@
+<!--
+   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.
+-->
+
 Release workflow (post 0.13.0)
 
 Make sure an associated tag to the release is created on: