Files
spring-batch-extensions/README.md
2014-03-21 13:50:22 -05:00

4.1 KiB

Spring Batch Extensions

The Spring Batch Extensions project provides extension modules for Spring Batch. This project is part of the Spring organization on GitHub.

Available Modules

Samples

Under the samples directory, you will find samples for the various modules. Please refer to the documentation of each sample for further details.

Getting support

Check out the spring-batch tag on Stack Overflow. Commercial support is available too.

Issue Tracking

Report issues via the Spring Integration Extensions JIRA.

Building from source

Each module of the Spring Batch Extensions project is hosted as independent project with its own release cycle. For the build process of individual modules we recomend using a [Maven][]-based build system modelled after the Spring Batch project.

Therefore, the following build instructions should generally apply for most, if not all, Spring Batch Extensions. In the instructions below, [mvn][] is invoked from the root of the source tree and serves as a cross-platform, self-contained bootstrap mechanism for the build. The only prerequisites are Git and JDK 1.6+.

Check out the sources

git clone git://github.com/spring-projects/spring-batch-extensions.git

Go into the directory of a specific module

cd module-name

Compile and test, build all jars

mvn package

Install the modules jars into your local Maven cache

mvn install

Import sources into your IDE

Using Eclipse / STS

When using [SpringSource Tool Suite][] you can directly import Gradle based projects:

File -> Import -> Maven Project

Alternatively, you can also generate the Eclipse metadata (.classpath and .project files) using Maven:

mvn eclipse

Once complete, you may then import the projects into Eclipse as usual:

File -> Import -> Existing projects into workspace

Using IntelliJ IDEA

To generate IDEA metadata (.iml and .ipr files), do the following:

mvn idea

Contributing

Pull requests are welcome. Please see the contributor guidelines for details. Additionally, if you are contributing, we recommend following the process for Spring Batch as outlined in the administrator guidelines.

Staying in touch

Follow the Spring Batch team members and contributors on Twitter:

License

The Spring Batch Extensions Framework is released under version 2.0 of the Apache License unless noted differently for individual extension Modules, but this should be the rare exception.

We look forward to your contributions!!