Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release of 3.0.0-M1 #271

Merged
merged 1 commit into from
Dec 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@

## Changelog

### [:link: 3.0.0](https://github.com/KarelCemus/play-redis/tree/3.0.0-M1)

Updated to Play `2.9.0` and dropped `Scala 2.12` since it was discontinued from the Play framework.
Minimal supported Java version is now `11`. [#265](https://github.com/KarelCemus/play-redis/pull/265)

### [:link: 2.7.0](https://github.com/KarelCemus/play-redis/tree/2.7.0)

SET command supports milliseconds, previous versions used seconds [#247](https://github.com/KarelCemus/play-redis/issues/247)
Expand Down
40 changes: 20 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,22 +36,22 @@ as well as on your premise.

- [synchronous and asynchronous APIs](#provided-apis)
- [implements standard APIs defined by Play's `cacheApi` project](#provided-apis)
- support of [named caches](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/20-configuration.md#named-caches)
- [works with Guice](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/40-migration.md#runtime-time-dependency-injection) as well as [compile-time DI](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/40-migration.md#compile-time-dependency-injection)
- [getOrElse and getOrFuture operations](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/30-how-to-use.md#use-of-cacheapi) easing the use
- [wildcards in remove operation](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/30-how-to-use.md#use-of-cacheapi)
- support of collections: [sets](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/30-how-to-use.md#use-of-sets), [lists](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/30-how-to-use.md#use-of-lists), and [maps](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/30-how-to-use.md#use-of-maps)
- [increment and decrement operations](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/30-how-to-use.md#use-of-cacheapi)
- [eager and lazy invocation policies](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/20-configuration.md#eager-and-lazy-invocation) waiting or not waiting for the result
- several [recovery policies](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/20-configuration.md#recovery-policy) and possibility of further customization
- support of [several configuration sources](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/20-configuration.md#running-in-different-environments)
- support of [named caches](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#named-caches)
- [works with Guice](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/40-migration.md#runtime-time-dependency-injection) as well as [compile-time DI](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/40-migration.md#compile-time-dependency-injection)
- [getOrElse and getOrFuture operations](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-cacheapi) easing the use
- [wildcards in remove operation](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-cacheapi)
- support of collections: [sets](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-sets), [lists](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-lists), and [maps](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-maps)
- [increment and decrement operations](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md#use-of-cacheapi)
- [eager and lazy invocation policies](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#eager-and-lazy-invocation) waiting or not waiting for the result
- several [recovery policies](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#recovery-policy) and possibility of further customization
- support of [several configuration sources](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#running-in-different-environments)
- static in the configuration file
- from the connection string optionally in the environmental variable
- custom implementation of the configuration provider
- support of [standalone, cluster,](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/20-configuration.md#standalone-vs-cluster)
[aws-cluster,](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/20-configuration.md#aws-cluster)
and [sentinel modes](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/20-configuration.md#sentinel)
- build on the top of Akka actors and serializers, [agnostic to the serialization mechanism](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/20-configuration.md#limitation-of-data-serialization)
- support of [standalone, cluster,](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#standalone-vs-cluster)
[aws-cluster,](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#aws-cluster)
and [sentinel modes](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#sentinel)
- build on the top of Akka actors and serializers, [agnostic to the serialization mechanism](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#limitation-of-data-serialization)
- for simplicity, it uses deprecated Java serialization by default
- it is recommended to use [Kryo library](https://github.com/romix/akka-kryo-serialization) or any other mechanism

Expand Down Expand Up @@ -92,11 +92,11 @@ or you can use shortcuts in the table below.

To use this module:

1. [Add this library into your project](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/10-integration.md) and expose APIs
1. See the [configuration options](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/20-configuration.md)
1. [Browse examples of use](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/30-how-to-use.md)
1. [Add this library into your project](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/10-integration.md) and expose APIs
1. See the [configuration options](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md)
1. [Browse examples of use](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/30-how-to-use.md)

If you come from older version, you might check the [Migration Guide](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/40-migration.md)
If you come from older version, you might check the [Migration Guide](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/40-migration.md)


## Samples
Expand Down Expand Up @@ -124,15 +124,15 @@ To your SBT `build.sbt` add the following lines:
// enable Play cache API (based on your Play version)
libraryDependencies += play.sbt.PlayImport.cacheApi
// include play-redis library
libraryDependencies += "com.github.karelcemus" %% "play-redis" % "2.7.0"
libraryDependencies += "com.github.karelcemus" %% "play-redis" % "3.0.0-M1"
```


## Compatibility matrix

| play framework | play-redis | documentation |
|----------------|---------------------------------:|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| 2.9.x | <!-- Play 2.9 -->3.0.0<!-- / --> | [see here](https://github.com/KarelCemus/play-redis/blob/3.0.0/README.md) |
| 2.9.x | <!-- Play 2.9 -->3.0.0-M1<!-- / --> | [see here](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/README.md) |
| 2.8.x | <!-- Play 2.8 -->2.7.0<!-- / --> | [see here](https://github.com/KarelCemus/play-redis/blob/2.7.0/README.md) |
| 2.7.x | <!-- Play 2.7 -->2.5.1<!-- / --> | [see here](https://github.com/KarelCemus/play-redis/blob/2.5.1/README.md) |
| 2.6.x | <!-- Play 2.6 -->2.3.0<!-- / --> | [see here](https://github.com/KarelCemus/play-redis/blob/2.3.0/README.md) ([Migration Guide](https://github.com/KarelCemus/play-redis/blob/2.3.0/doc/40-migration.md)) |
Expand All @@ -150,7 +150,7 @@ like this library, please feel free to report it or contact me.
## Changelog

For the list of changes and migration guide please see
[the Changelog](https://github.com/KarelCemus/play-redis/blob/2.7.0/CHANGELOG.md).
[the Changelog](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/CHANGELOG.md).


## Caveat
Expand Down
2 changes: 1 addition & 1 deletion doc/10-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Although the use of runtime-time injection is preferred, both options are equal
// enable Play cache API (based on your Play version)
libraryDependencies += play.sbt.PlayImport.cacheApi
// include play-redis library
libraryDependencies += "com.github.karelcemus" %% "play-redis" % "2.7.0"
libraryDependencies += "com.github.karelcemus" %% "play-redis" % "3.0.0-M1"
```


Expand Down
2 changes: 1 addition & 1 deletion doc/20-configuration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Configuration

Default configuration and very detailed manual is available in [reference.conf](https://github.com/KarelCemus/play-redis/blob/2.7.0/src/main/resources/reference.conf). It can be overwritten in your `conf/application.conf` file.
Default configuration and very detailed manual is available in [reference.conf](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/src/main/resources/reference.conf). It can be overwritten in your `conf/application.conf` file.

There are several features supported in the configuration, they are discussed below. However, by default, there is no need for any further configuration. Default settings are set to the standalone instance running on `localhost:6379?db=0`, which is default for redis server. This instance is named `play` but is also exposed as a default implementation.

Expand Down
4 changes: 2 additions & 2 deletions doc/40-migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ changes in public API, which needs your code to be updated.

The invocation policy in `2.0.x` was used as an implicit parameter. Since
`2.1.x` it is a static configurable property inside the instance configuration.
See the [updated documentation for more details](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/20-configuration.md#eager-and-lazy-invocation).
See the [updated documentation for more details](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#eager-and-lazy-invocation).

### Named caches uses @NamedCache instead of @Named

Expand All @@ -39,7 +39,7 @@ Since `2.1.0`, there is a new `redis-timeout` property. To avoid
ambiguity, the original `timeout` property was renamed to `sync-redis`.
The `timeout` property was deprecated any will be removed in `2.2.0`.

See the updated [documentation for more details](https://github.com/KarelCemus/play-redis/blob/2.7.0/doc/20-configuration.md#eager-and-lazy-invocation).
See the updated [documentation for more details](https://github.com/KarelCemus/play-redis/blob/3.0.0-M1/doc/20-configuration.md#eager-and-lazy-invocation).


## Migration from 1.6.x to 2.0.x
Expand Down