Important

JeKa 0.11.0 has been released!!!

This release brings major and drastic changes compared to previous JeKa versions.

The content of this page reflects the new version and does not apply to 0.10.x.

The existing IDE plugin for IntelliJ still works with Jeka 0.10.x but is no longer compatible with the new version. A new plugin for Jeka 0.11.x is under development.

The official documentation provides information for both versions and a migration guide.

What is JeKa ?

JeKa is a Java build tool for building or executing Java applications and scripts, directly from source code.

Its key features include:

• JDKs Management: Automatically downloads and selects the appropriate JDKs. No need to have Java already installed on the host machine.

• Direct App Execution: Run applications directly from their Git repository, providing a means to distribute Java applications as source.

• Portable Builds: JeKa downloads everything needed for building your projects (JDKs, Maven deps, NodeJs, OpenAPI tooling, etc. including JeKa itself!)

• Customizable and Extendable: JeKa can be configured with a concise property file for generic cases, or by Java code for specific needs. Also, JeKa provides a simple plugin mechanism that allows for easy extension.

• Kotlin Support: Scripts or applications can also be implemented using the Kotlin language.

Use-cases

• Use Java for scripting

  JeKa makes it ridiculously easy to write and execute scripts using the Java language. Write your automated tasks directly in Java, using third-party dependencies or not, and execute them from anywhere, without any setup.

• Build projects - Create delivery pipelines

  Build projects and seamlessly combine scripts to create comprehensive CI/CD pipelines that can run anywhere, from IDE debugger to cloud CI/CD environments.

  JeKa can also complement other build tools such as Maven or Gradle to fulfill their missing features.

• Deliver applications as sources

  JeKa can execute entire Java applications of any kind and size directly from their Git repository.

  Simply commit or tag repository to publish application.

• Make Java fun for newcomers

  Say goodbye to learning legacy build tools and grappling with JDKs when starting with Java.

  Write directly Java code that can be built and executed from anywhere with minimal or zero setup.

• Centralize build logic

  Define project build and CI/CD logic in one place, and reuse accross all your organization.

Examples

Run Java Applications directly from their Source Repository

• Execute the 'cow says' cmd-line program directly from Github
• Execute a calculator GUI app directly from Github

Build and Test E2E

• Build a Springboot-Agular application, including Sonarqube analysis and Docker E2E testing
• Build, run, dockerize, and publish application with zero-conf
• Publish a library on Maven Central or other example

Reuse Build Logic

• Build a Spring-Boot + ReactJs application with just 3 lines of configuration.

Complete existing Build Tools

• JeKa used along Maven to build and run Quarkus native app

Other Examples of projects built with JeKa.

Getting Started

Visit following pages according your expectation :

• Reference Guide
• Working examples

KBeans

KBeans are JeKa components that expose functionnalities to the command line. They can also be conveniently activated and configured via properties, or via other KBeans.

Plugins generally contain one KBean, but they can contain zero or many.

Bundled KBeans

JeKa is bundled with KBeans covering : IDE integration (IntelliJ Eclipse), Java/Kotlin Project building, Maven publication, Git integration, Docker and more.

You can get a description of the functionalities provided by the KBeans by executing jeka --doc

Additionnaly JeKa offers high and low level api for dealing with dependency management, compilation, testing, Git, GPG signing, Scaffolding, Maven publication, Docker image maker, ...

External Plugins

External plugins require to be explicitly imported. They are hosted as jar file in Maven Central.

The following plugins are hosted in same monorepo then JeKa, and so are released in conjunction which means that we don't need to specify their version when importing.

• Springboot Plugin
• Sonarqube Plugin
• Jacoco Plugin
• NodeJs Plugin
• Protobuf Plugin
• Nexus Plugin

The following plugins are maintained in their own repos.

• OpenApi Plugin

Community

This project is supported by OW2 consortium.

You can ask question using regular using this repository issues.

You can also use direct emailing for questions and support : djeangdev@yahoo.fr

A twitter account also exist : https://twitter.com/djeang_dev

Versioning

JeKa follows Semantic Versioning 2.0.

Developer Notes

How is Organized this Repo ?

This repository is organized as a monorepo. It contains The JeKa core project along plugins and samples for automation testing.

• dev.jeka.core : Complete JeKa tool
• plugins : JeKa plugins released along JeKa core (Springboot, NodeJs, Jacoco and Sonarqube)
• samples : Sample projects serving for examples and automation testing
• dev.jeka.master : The master build for building all together.

JeKa builds itself. To build JeKa full distribution from sources, the simpler is to use your IDE.

Build JeKa from IntelliJ

• Clone this repository into IntelliJ. Project is already configured (.iml and modules.xml are stored in git).
• If you have not installed JeKa plugin, add the JEKA_CACHE_DIR variable pointing on [USER_HOME]/.jeka/cache
• Make sure the project is configured with a JDK8 or higher.
• Run 'FULL BUILD' in Intellij Run Configurations to perform a full build of core + plugins + complete test suite.
• Run 'FAST BUILD' in Intellij Run Configurations to perform a fast build of the core without tests.
• Set environment variable JEKA_HOME = [JeKa project location]/dev.jeka.core/jeka/output/distrib and add it to PATH environment.

For debugging the project, you may have to set up Intellij in order to workaround with an Intellij issue : Settings/Preferences | Build, Execution, Deployment | Debugger | Data Views | Kotlin | enable "Disable coroutine agent. See here

Build JeKa from Command Line

JeKa builds itself, but we need to compile the JeKa sources prior to execute it. For this, a small Ant script bootstraps the build process by compiling JeKa first then launch the JeKa build.

At the repository root dir, execute : ant -f .github\workflows\build.xml.

To build the project including Sonarqube and test coverage : ant -f .github\workflows\build.xml -Dsonar.host.url=... .
Cause of Sonarqube scanner, this command has to be run with a JDK >= 11.

How to Edit Documentation ?

Documentation is generated with Material for MkDocs. Documentation sources are located (here)[docs].

You must install Python and Material for MkDocs on your computer (pip install mkdocs-material) prior to execute following command lines from the repo root directory :

mkdocs serve

This generates and serves the documentation on localhost:8000

The documentation is also supposed to be regenerated after each push/pull-request.

How to Release ?

Just use the github release mechanism. Creating a release implies creating a tag. This will trigger a build and a publication on Maven Central.