domhanak commented on code in PR #2065: URL: https://github.com/apache/incubator-kie-kogito-examples/pull/2065#discussion_r1942596355
########## README.md: ########## @@ -1,168 +1,59 @@ -# Kogito Examples +# Apache KIE Examples -This module contains a number of examples that you can take a look at and try out yourself. Please take a look at the readme of each individual example for more details on how the example works and how to run it yourself (either locally or on Kubernetes). +This repository contains a number of examples for [Drools](https://github.com/apache/incubator-kie-drools), [jBPM](https://www.jbpm.org), [Kogito](https://github.com/apache/incubator-kie-kogito-runtimes) and [Sonataflow](https://sonataflow.org) that you can take a look at and try out yourself. Please take a look at the readme of each individual example for more details on how the example works and how to run it yourself. -Since Kogito aims at supporting both Quarkus and Spring Boot each example usually provides both type of projects. +Apache KIE Examples showcase use cases, features, applications, know-how's of everything our community's technology has to offer. -- Default branch is `stable`, pointing to the latest released version. -- **[You can also check all versions by looking at releases.](https://github.com/apache/incubator-kie-kogito-examples/releases/latest)** +Apache KIE Examples are currently updated after a stable release. -## Use alternative Quarkus platforms +## Branches -The Quarkus quickstarts by default currently use the Quarkus core BOM. +Current stable branch is `10.0.x`, pointing to the latest released `10.0.0` version. -If you want to use an alternative BOM when building the Quarkus quickstarts you can override the `quarkus.platform.*` properties. The following example shows how to set `quarkus.platform.artifact-id` to use the quarkus-universe-bom. +Current development branch is `main`. + +## Use alternative Quarkus platforms with examples + +The examples that use Quarkus use the Quarkus core BOM by default. + +If you want to use an alternative BOM when building the Apache KIE Quarkus quickstarts you can override the `quarkus.platform.*` properties. The following example shows how to set `quarkus.platform.artifact-id` to use the quarkus-universe-bom. ``` mvn -Dquarkus.platform.artifact-id=quarkus-universe-bom clean install ``` +Currently, only [Drools](https://github.com/apache/incubator-kie-drools) is part of the Quarkus Platform. +> Note: Integration of Kogito and Sonataflow is in progress. -Because the Kogito project is part of the Quarkus Platform, the same applies also to Kogito BOM being used. +## Getting started with the examples -By default `org.kie.kogito:kogito-bom` is used, but, when needed, this can be overridden using Maven properties: -* `kogito.bom.*` for Kogito BOM overrides +1. Clone this repository +``` +git clone [email protected]:apache/incubator-kie-kogito-examples.git +``` +2. Navigate to the root of the example's directory +``` +cd ./incubator-kie-kogito-examples/serverless-workflow-examples/serverless-workflow-funqy +``` +3. Open the README.md and follow its instructions -The properties defined in each of the modules and can be overridden as follows: -* Kogito BOM - ``` - mvn -Dkogito.bom.group-id=io.quarkus.platform -Dkogito.bom.artifact-id=quarkus-kogito-bom -Dkogito.bom.version=2.2.3.Final - ``` -> Note: It's important to keep BOM versions aligned when overriding. In case of Quarkus Platform this means using a single -> version value for all two (`quarkus.platform.version`, `kogito.bom.version`) properties. +> Found an issue? Please report it [here](https://github.com/apache/incubator-kie-kogito-examples/issues/new?template=bug_report.yml) and we will take a look. ## Contribution -Everyone is encouraged to contribute to these examples by +Everyone is encouraged to contribute to these examples by: * trying it out and providing feedback and ideas for improvement -* create new examples -- **in this case, make sure your PR is against the `main` branch!** +* creating new examples by sending a [pull-request](https://github.com/apache/incubator-kie-kogito-examples/compare/main...main) against main branch Review Comment: Yea I think this is ok and quite clear to users -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
