Skip to content

Commit

Permalink
README updated
Browse files Browse the repository at this point in the history
  • Loading branch information
@lukas-krecan
lukas-krecan committed Jan 8, 2025
1 parent ba30fe2 commit fbb44bc
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 35 deletions.
69 changes: 35 additions & 34 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ executed repeatedly. Moreover, the locks are time-based and ShedLock assumes tha
+ [Release notes](#release-notes)

## Versions
If you are using JDK >17 and up-to-date libraries like Spring 6, use version **5.1.0** ([Release Notes](#500-2022-12-10)). If you
If you are using JDK >17 and up-to-date libraries use the newest version. If you
are on older JDK or library, use version **4.44.0** ([documentation](https://github.com/lukas-krecan/ShedLock/tree/version4)).

## Components
Expand All @@ -82,7 +82,7 @@ First of all, we have to import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-spring</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand Down Expand Up @@ -187,7 +187,7 @@ Add dependency
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-jdbc-template</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand Down Expand Up @@ -247,7 +247,7 @@ is in flux and may easily break.
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-r2dbc</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -270,7 +270,7 @@ Add dependency
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-jooq</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand Down Expand Up @@ -307,7 +307,7 @@ Add dependency
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-jdbc-micronaut</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -330,7 +330,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-mongo</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -357,7 +357,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-mongo-reactivestreams</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand Down Expand Up @@ -386,7 +386,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-dynamodb2</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -413,7 +413,7 @@ Import
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-zookeeper-curator</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -437,7 +437,7 @@ Import
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-redis-spring</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -461,7 +461,7 @@ Import
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-redis-spring</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand Down Expand Up @@ -490,7 +490,7 @@ Import
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-redis-jedis4</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -514,7 +514,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-hazelcast4</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -538,7 +538,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-couchbase-javaclient3</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -564,7 +564,7 @@ I am really not sure if it's a good idea to use Elasticsearch as a lock provider
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-elasticsearch8</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -587,21 +587,22 @@ Import the project
```xml
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-opensearch</artifactId>
<version>6.1.0</version>
<!-- Use shedlock-provider-opensearch if you are still using RestHighLevelClient -->
<artifactId>shedlock-provider-opensearch-java</artifactId>
<version>6.2.0</version>
</dependency>
```

Configure:

```java
import static net.javacrumbs.shedlock.provider.opensearch.OpenSearchLockProvider;
import static net.javacrumbs.shedlock.provider.opensearch.java.OpenSearchLockProvider;

...

@Bean
public OpenSearchLockProvider lockProvider(RestHighLevelClient highLevelClient) {
return new OpenSearchLockProvider(highLevelClient);
public OpenSearchLockProvider lockProvider(OpenSearchClient openSearchClient) {
return new OpenSearchLockProvider(openSearchClient);
}
```

Expand All @@ -616,7 +617,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-cassandra</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand Down Expand Up @@ -651,7 +652,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-consul</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -676,7 +677,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-arangodb</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -702,7 +703,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-neo4j</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -727,7 +728,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-etcd-jetcd</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -751,7 +752,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-ignite</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -776,7 +777,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-inmemory</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
<scope>test</scope>
</dependency>
```
Expand All @@ -802,7 +803,7 @@ Import
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-memcached-spy</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand Down Expand Up @@ -833,7 +834,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-datastore</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand All @@ -855,7 +856,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-spanner</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```
Configure
Expand Down Expand Up @@ -893,7 +894,7 @@ Import the project
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-provider-s3</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand Down Expand Up @@ -997,7 +998,7 @@ Import the project:
<artifactId>shedlock-micronaut</artifactId>
<!-- For Micronaut 4 use -->
<!-- <artifactId>shedlock-micronaut4</artifactId> -->
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand Down Expand Up @@ -1034,7 +1035,7 @@ Import the project:
<dependency>
<groupId>net.javacrumbs.shedlock</groupId>
<artifactId>shedlock-cdi</artifactId>
<version>6.1.0</version>
<version>6.2.0</version>
</dependency>
```

Expand Down
6 changes: 5 additions & 1 deletion RELEASES.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Release notes

## 6.1.0
## 6.2.0 (2025-01-08)
* Support OpenSearch Java client (thanks @harisonde)
* Dependency updates

## 6.1.0 (2025-01-06)
* Support for S3 lock provider (thanks @caiooliveiraeti)
* Dependency updates

Expand Down

0 comments on commit fbb44bc

Please sign in to comment.