Skip to content
Automate with plain Java code and nothing else.
Java Shell Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Build Status Maven Central Gitter
                                             

What is Jeka ?

Jeka(formerly Jerkar) is a complete Java build system ala Ant, Maven, Gradle or Buildr using only Java code to automate builds or tasks.

Forget about verbose Poms and rigid Maven structure. Get rid of Gradle scripting/DSL.

Enjoy all the engineering power you are comfortable with : Java code, IDE, 3rd party libs, binary repositories, ....

Model, refactor, run, debug, reuse automation assets across tasks and projects. Exactly as you do with your regular Java code.

Also, Jeka conventions and plugin mechanism are so powerful that it can perform pretty exotic tasks without needing a single line of code/configuration.

For example jeka java#pack jacoco# sonar#run -sonar#host.url=http://myserver/sonar performs a complete build running unit tests under Jacoco coverage tools and performs SonarQube analysis on a Java project free of any build-code / configuration / script.

News

Jeka has joined OW2 organisation on january 2020 : https://projects.ow2.org/view/jeka/

Last major additions :

  • Release of a plugin for Intellij
  • Upgraded to Ivy 2.5.0
  • Wrapper to run Jeka independently of the Jeka version installed on the host machine
  • Jdk9+ compatibility
  • Deploying on Maven central though a modern release process (version numbering based on Git instead of being hardcoded). Jeka now uses these features to release itself.

Roadmap/Ideas

  • Stabilise api from user feedback. API is quite workable now but may be improved.
  • Provides a graphical plugin for better integration with Eclipse
  • Enhance existing graphical plugin for Intellij
  • Provide a plugin for Android
  • Integrate Kotlin as a first citizen language for both building Kotlin projects and write Jeka command classes.

Please visit relelease note and issues for roadmap.

Get Jeka

The distribution is the file named jeka-core-x.x.x-distrib.zip.

How to use Jeka ?

Jeka is designed to be easy to master for Java developers. It is easy to figure out how it works by knowing few concepts and navigate in source code.

That said, documentation is needed for a starting point.

Visit following pages according your expectation :

External plugins

Jeka comes with plugins out of the box. These plugins covers the most common points a Java developer need to address when building a project. This includes plugins for IDE metadata generation (IntelliJ, Eclipse), dependency management, git, , java project building, testing, PGP signing, binary repositories, Maven interaction, scaffolding, sonarQube and web archives.

Nevertheless, Jeka is extensible and other plugins exist outside the main distib among :

Community

Image

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

How to build Jeka ?

Jeka is made of following projects :

  • dev.jeka.core : complete Jeka project
  • dev.jeka.samples : A sample project with several build classes to illustrate how Jeka can be used in different ways
  • dev.jeka.depender-samples : A sample project depending on the above sample project to illustrate multi-project builds. These sample projects are also used to run some black-box tests

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

Once distrib created, add the distrib folder to your PATH environment variable.

Build Jeka from Eclipse

  • Clone this repository in Eclipse. Project is already configured ( .project and .classpath are stored in git).
  • Add the JEKA_USER_HOME classpath variable pointing on [USER_HOME]/.jeka
  • Make sure the project is configured to compile using a JDK8 or higher and not a JRE.
  • Run dev.jeka.core.CoreBuildAndIT class main method. This class is located in jeka/def folder.
  • This creates the full distrib in dev.jeka.core/jeka/output/distrib folder and run full Integration test suite.

Build Jeka from IntelliJ

Note that it exists a now an IntelliJ plugin to integrate Jeka to get rid of the following setup.

  • Clone this repository into IntelliJ. Project is already configured (.iml and modules.xml are stored in git).
  • Add the JEKA_USER_HOME variable pointing on [USER_HOME]/.jeka
  • Make sure the project is configured with a JDK8 or higher.
  • Run dev.jeka.core.CoreBuildAndIT class main method. This class is located in jeka/def folder, inside dev.jeka.core module. Make sure to run it using $MODULE_WORKING_DIR$ as working directory.
  • This creates the full distrib in dev.jeka.core/jeka/output/distrib folder and run full Integration test suite.

To build the project without running whole integration test suite, run dev.jeka.core.CoreBuild class main method.

How to Release ?

Release is done automatically by Travis at each git push. If there is no tag on the current commit then it goes to a SNAPSHOT deploy on OSSRH. If there is a tag, it goes to a publish on Maven central.

To really deploy to Maven central, a manual action it still needed to close/release repository.

To create a tag conveniently, just execute jeka git#tagRemote from your console and answer to the prompt.

                                             

You can’t perform that action at this time.