|
1 | | -# About |
2 | | - |
3 | | -This repository contains experimental features in Spring Batch. Experimental features are not intended to be used in production. |
| 1 | +# About this repository |
4 | 2 |
|
| 3 | +This repository contains experimental features in Spring Batch. |
| 4 | +Experimental features are *not* intended to be used in production. |
5 | 5 | They are shared here to be explored by the community and to gather feedback. |
6 | 6 |
|
| 7 | +**Important note:** The versioning in this repository follows the [semantic versioning specification](https://semver.org/#spec-item-4). |
| 8 | +Public APIs as well as the implementations should not be considered stable and may change at any time :exclamation: |
| 9 | + |
7 | 10 | # Enabling experimental features |
8 | 11 |
|
9 | | -Experimental features are not released to Maven Central, but they will be available from the Spring Milestones repository soon. |
| 12 | +Experimental features are not released to Maven Central, but they are available from the Spring Milestones repository: |
| 13 | + |
| 14 | +```xml |
| 15 | +<repositories> |
| 16 | + <repository> |
| 17 | + <id>spring-milestones</id> |
| 18 | + <name>Spring Milestones</name> |
| 19 | + <url>https://repo.spring.io/milestone</url> |
| 20 | + <snapshots> |
| 21 | + <enabled>false</enabled> |
| 22 | + </snapshots> |
| 23 | + </repository> |
| 24 | +</repositories> |
| 25 | +``` |
10 | 26 |
|
11 | | -For now, you can build the project and install it in your local Maven repository with the following command: |
| 27 | +You can also build the project and install it in your local Maven repository with the following command: |
12 | 28 |
|
13 | 29 | ```shell |
14 | 30 | $>./mvnw clean install |
15 | 31 | ``` |
16 | 32 |
|
17 | | -The experimental features are based on the latest Spring Batch 5 release, which requires Java 17+. |
| 33 | +The experimental features are based on the latest Spring Batch 5+ release, which requires Java 17+. |
18 | 34 |
|
19 | 35 | To test experimental features, you need to add the following dependency in your project: |
20 | 36 |
|
21 | 37 | ```xml |
22 | 38 | <dependency> |
23 | 39 | <groupId>org.springframework.batch</groupId> |
24 | 40 | <artifactId>spring-batch-experimental</artifactId> |
25 | | - <version>0.1.0-SNAPSHOT</version> |
| 41 | + <version>0.1.0</version> |
26 | 42 | </dependency> |
27 | 43 | ``` |
28 | 44 |
|
29 | 45 | Depending on the feature you are testing, other dependencies might be required. |
30 | 46 |
|
31 | 47 | # MongoDB as data store for batch meta-data |
32 | 48 |
|
| 49 | +*Original issue:* https://github.com/spring-projects/spring-batch/issues/877 |
| 50 | + |
33 | 51 | This feature introduces new implementations of `JobRepository` and `JobExplorer` for MongoDB. |
34 | 52 |
|
35 | 53 | To test this feature, first import the `spring-batch-experimental` jar as described in the [Enabling experimental features](#enabling-experimental-features) section. |
@@ -72,4 +90,12 @@ Those can be defined as Spring beans in the application context as described in |
72 | 90 |
|
73 | 91 | You can find a complete example in the [MongoDBJobRepositoryIntegrationTests](./src/test/java/org/springframework/batch/experimental/core/repository/support/MongoDBJobRepositoryIntegrationTests.java) file. |
74 | 92 |
|
75 | | -If you find an issue, please report it on the [issue tracker](https://github.com/spring-projects-experimental/spring-batch-experimental/issues). |
| 93 | +# Contribute |
| 94 | + |
| 95 | +The best way to contribute to this project is by trying out the experimental features and sharing your feedback! |
| 96 | + |
| 97 | +If you find an issue, please report it on the [issue tracker](https://github.com/spring-projects-experimental/spring-batch-experimental/issues). You are welcome to share your feedback on the original issue related to each feature. |
| 98 | + |
| 99 | +# License |
| 100 | + |
| 101 | +[Apache License Version 2.0](./LICENSE.txt). |
0 commit comments