A fast, easy-to-use, open source AI constraint solver for software developers
OptaPlanner’s quickstarts are located in the optaplanner-quickstarts repository.
To build and run from source:
$ mvn clean install -Dquickly $ cd optaplanner-examples $ mvn exec:java
To develop with IntelliJ IDEA, Eclipse or VSCode, open the root pom.xml
as a new project
and configure a Run/Debug configuration like this:
-
Type: Application
-
Main class:
org.optaplanner.examples.app.OptaPlannerExamplesApp
-
VM options:
-Xmx2G -server
(memory only needed when using the big datasets in the examples) -
Program arguments: (none)
-
Working directory:
$MODULE_DIR$
(must resolve to optaplanner-examples directory) -
Use classpath of module:
optaplanner-examples
This is an open source project, and you are more than welcome to contribute ❤️!
-
If you’re just starting out with OptaPlanner and want to contribute, take a look at our starter issues. They’re specifically chosen to be easier for first time contributors.
-
If you want to contribute or start an opinionated discussion, join our discussion or send an e-mail directly to optaplanner-dev@googlegroups.com.
-
If you want to submit an issue, check out the OptaPlanner Jira project.
Every change must be submitted through a GitHub pull request (PR). OptaPlanner uses continuous integration (CI). The OptaPlanner CI runs checks against your branch after you submit the PR to ensure that your PR doesn’t introduce errors. If the CI identifies a potential problem, our friendly PR maintainers will help you resolve it.
-
Fork it (https://github.com/kiegroup/optaplanner).
-
Create your feature branch: (
git checkout -b feature
). -
Commit your changes with a comment: (
git commit -am 'Add some feature'
). -
Push to the branch to GitHub: (
git push origin feature
). -
Create a new pull request.
Your code is automatically formatted according to the Import and Code Style conventions during every Maven build. CI checks enforce those conventions too, so be sure to build your project with maven before creating your PR:
mvn clean install
For information about how to set up code style checks, see IDE Setup Instructions.
Use one of the following ways to build your OptaPlanner project:
-
🚀 build-fast:
mvn clean install -Dquickly
skips any checks and code analysis (~1 min) -
🔨 build-normally:
mvn clean install
runs tests, checks code style, skips documentation (~17 min) -
🧾 build-doc:
mvn clean install
atoptaplanner/optaplanner-docs
creates asciidoctor documentationtarget/optaplanner-docs-*/html_single/index.html
(~2 min) -
🦾 build-all:
mvn clean install -Dfull
runs all checks + creates documentation and distribution files (~20 min)
You can check the CI status of the OptaPlanner repositories from the Chain Status webpage.
All Jenkins jobs can be found under the OptaPlanner folder: https://eng-jenkins-csb-business-automation.apps.ocp-c1.prod.psi.redhat.com/job/KIE/job/optaplanner
Interesting Jenkins CI jobs (need VPN access):
-
Release pipeline (only available on release branches)
-
Post-Release pipeline (only available on release branches)