Skip to content

Commit

Permalink
#116: 7.4 release documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vladimir-bukhtoyarov committed Apr 9, 2022
1 parent b2e7140 commit 3feaba0
Show file tree
Hide file tree
Showing 26 changed files with 46 additions and 36 deletions.
20 changes: 10 additions & 10 deletions README.md
Expand Up @@ -24,11 +24,11 @@ In additional to basic features described above, ```Bucket4j``` provides ability
In addition to local in-memory buckets, the Bucket4j supports clustered usage scenario on top of following back-ends:
| Back-end | Async supported | Optimized serialization | Thin-client support | Documentation link |
| :--- | :---: | :---: | :---: | :---: |
| ```JCache API (JSR 107)``` | No | No | No | [bucket4j-jcache](https://bucket4j.com/7.3.0/toc.html#bucket4j-jcache) |
| ```Hazelcast``` | Yes | Yes | Planned | [bucket4j-hazelcast](https://bucket4j.com/7.3.0/toc.html#bucket4j-hazelcast) |
| ```Apache Ignite``` | Yes | n/a | Yes | [bucket4j-ignite](https://bucket4j.com/7.3.0/toc.html#bucket4j-ignite) |
| ```Inifinispan``` | Yes | Yes | No | [bucket4j-infinispan](https://bucket4j.com/7.3.0/toc.html#bucket4j-infinispan) |
| ```Oracle Coherence``` | Yes | Yes | No | [bucket4j-coherence](https://bucket4j.com/7.3.0/toc.html#bucket4j-coherence) |
| ```JCache API (JSR 107)``` | No | No | No | [bucket4j-jcache](https://bucket4j.com/7.4.0/toc.html#bucket4j-jcache) |
| ```Hazelcast``` | Yes | Yes | Planned | [bucket4j-hazelcast](https://bucket4j.com/7.4.0/toc.html#bucket4j-hazelcast) |
| ```Apache Ignite``` | Yes | n/a | Yes | [bucket4j-ignite](https://bucket4j.com/7.4.0/toc.html#bucket4j-ignite) |
| ```Inifinispan``` | Yes | Yes | No | [bucket4j-infinispan](https://bucket4j.com/7.4.0/toc.html#bucket4j-infinispan) |
| ```Oracle Coherence``` | Yes | Yes | No | [bucket4j-coherence](https://bucket4j.com/7.4.0/toc.html#bucket4j-coherence) |

### Non-JVM back-ends
Bucket4j authors strongly recommends to use JVM based back-ends when possible,
Expand All @@ -38,8 +38,8 @@ In addition to local in-memory buckets, the Bucket4j supports clustered usage sc
| Back-end | Async supported | Documentation link |
| :--- | :---: | :---: |
| ```Redis``` | Yes | [bucket4j-redis](https://github.com/vladimir-bukhtoyarov/bucket4j/blob/master/bucket4j-redis/src/main/java/io/github/bucket4j/redis/redisson/cas/RedissonBasedProxyManager.java) |
| ```MySQL``` | No | [bucket4j-mysql](https://bucket4j.com/7.3.0/toc.html#mysql-integration) |
| ```PostgreSQL``` | No | [bucket4j-postgresql](https://bucket4j.com/7.3.0/toc.html#postgresql-integration) |
| ```MySQL``` | No | [bucket4j-mysql](https://bucket4j.com/7.4.0/toc.html#mysql-integration) |
| ```PostgreSQL``` | No | [bucket4j-postgresql](https://bucket4j.com/7.4.0/toc.html#postgresql-integration) |
| ```DynamoDb``` | No | [bucket4j-dynamodb](https://github.com/vladimir-bukhtoyarov/bucket4j/blob/master/bucket4j-dynamodb-sdk-v1/src/main/java/io/github/bucket4j/dynamodb/v1/LongDynamoDBProxyManager.java) |

### Local caches support
Expand All @@ -49,8 +49,8 @@ Sometimes you are having deal with bucket per key scenarios but distributed sync
| ```Caffeine``` | [bucket4j-caffeine](https://github.com/vladimir-bukhtoyarov/bucket4j/blob/7.3/bucket4j-caffeine/src/main/java/io/github/bucket4j/caffeine/CaffeineProxyManager.java) |

## [Documentation](https://bucket4j.com)
* [Official reference](https://bucket4j.com/7.3.0/toc.html)
* [Quick start examples](https://bucket4j.com/7.3.0/toc.html#quick-start-examples)
* [Official reference](https://bucket4j.com/7.4.0/toc.html)
* [Quick start examples](https://bucket4j.com/7.4.0/toc.html#quick-start-examples)
* [Third-party articles](https://bucket4j.com/#third-party-articles)

## Get Bucket4j library
Expand All @@ -60,7 +60,7 @@ The Bucket4j is distributed through [Maven Central](http://search.maven.org/):
<dependency>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-core</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
</dependency>
```
#### You can build Bucket4j from sources
Expand Down
2 changes: 1 addition & 1 deletion asciidoc/pom.xml
Expand Up @@ -8,7 +8,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>
<artifactId>asciidoc</artifactId>
Expand Down
8 changes: 7 additions & 1 deletion asciidoc/src/main/docs/asciidoc/index.adoc
Expand Up @@ -3,7 +3,7 @@ image::./images/white-logo.png[]
endif::[]

== Current version {revnumber} documentation
`04 March 2022` Support for Caffeine.
`09 April 2022` Method for reset bucket.

* http://bucket4j.com/{revnumber}/release-notes.html[{revnumber} Release notes]
* http://bucket4j.com/{revnumber}/toc.html[{revnumber} Reference]
Expand Down Expand Up @@ -43,6 +43,12 @@ image:images/Maxim_Bartkov.jpg[80,80] +

== Documentation for previous versions
=== 2022
==== 7.4.0
`04 March 2022` Support for Caffeine.

* http://bucket4j.com/7.4.0/release-notes.html[7.4.0 Release notes]
* http://bucket4j.com/7.4.0/toc.html[7.4.0 Reference]

==== 7.2.0
`11 Feb 2022` Support for MySQL and PostgreSQL.

Expand Down
6 changes: 5 additions & 1 deletion asciidoc/src/main/docs/asciidoc/release-notes.adoc
Expand Up @@ -2,4 +2,8 @@
Release `{revnumber}`

.The issues in release scope are following:
* https://github.com/vladimir-bukhtoyarov/bucket4j/issues/238[#238 Support for Caffeine]
* https://github.com/vladimir-bukhtoyarov/bucket4j/issues/116[#116 Method for reset bucket]
.The bugfixes in release scope are following:
* https://github.com/vladimir-bukhtoyarov/bucket4j/issues/246[#246 Connection leak in MySQL/PostgreSQL proxy managers]
* https://github.com/vladimir-bukhtoyarov/bucket4j/issues/244[#244 RedisCommands.SETPXNX not exists]
2 changes: 1 addition & 1 deletion bucket4j-benchmarks/pom.xml
Expand Up @@ -8,7 +8,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>
<artifactId>bucket4j-benchmarks</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-caffeine/pom.xml
Expand Up @@ -8,7 +8,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>
<artifactId>bucket4j-caffeine</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-coherence/pom.xml
Expand Up @@ -9,7 +9,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion bucket4j-core/pom.xml
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-dynamodb-sdk-v1/pom.xml
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion bucket4j-examples/pom.xml
Expand Up @@ -23,7 +23,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-hazelcast-all/bucket4j-hazelcast-3/pom.xml
Expand Up @@ -8,7 +8,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-hazelcast-all</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../../bucket4j-hazelcast-all</relativePath>
</parent>
<artifactId>bucket4j-hazelcast-3</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-hazelcast-all/bucket4j-hazelcast/pom.xml
Expand Up @@ -8,7 +8,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-hazelcast-all</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../../bucket4j-hazelcast-all</relativePath>
</parent>
<artifactId>bucket4j-hazelcast</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-hazelcast-all/pom.xml
Expand Up @@ -5,7 +5,7 @@
<parent>
<artifactId>bucket4j-parent</artifactId>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>
<packaging>pom</packaging>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-ignite/pom.xml
Expand Up @@ -8,7 +8,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>
<artifactId>bucket4j-ignite</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-infinispan-all/bucket4j-infinispan-8/pom.xml
Expand Up @@ -8,7 +8,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-infinispan-all</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../../bucket4j-infinispan-all</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion bucket4j-infinispan-all/bucket4j-infinispan/pom.xml
Expand Up @@ -8,7 +8,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-infinispan-all</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../../bucket4j-infinispan-all</relativePath>
</parent>
<artifactId>bucket4j-infinispan</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-infinispan-all/pom.xml
Expand Up @@ -6,7 +6,7 @@
<parent>
<artifactId>bucket4j-parent</artifactId>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-jcache/pom.xml
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-mysql/pom.xml
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion bucket4j-parent/pom.xml
Expand Up @@ -7,7 +7,7 @@
<modelVersion>4.0.0</modelVersion>

<groupId>com.github.vladimir-bukhtoyarov</groupId>
<version>7.3.0</version>
<version>7.4.0</version>
<artifactId>bucket4j-parent</artifactId>
<packaging>pom</packaging>
<name>bucket4j-parent</name>
Expand Down
2 changes: 1 addition & 1 deletion bucket4j-postgresql/pom.xml
Expand Up @@ -7,7 +7,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>

Expand Down
2 changes: 1 addition & 1 deletion bucket4j-redis/pom.xml
Expand Up @@ -8,7 +8,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>
<artifactId>bucket4j-redis</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion experimental/bucket4j-lua/pom.xml
Expand Up @@ -24,7 +24,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../../bucket4j-parent</relativePath>
</parent>
<artifactId>bucket4j-lua</artifactId>
Expand Down
2 changes: 1 addition & 1 deletion experimental/pom.xml
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>
<modelVersion>4.0.0</modelVersion>
Expand Down
2 changes: 1 addition & 1 deletion lincheck-tests/pom.xml
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>../bucket4j-parent</relativePath>
</parent>

Expand Down
4 changes: 2 additions & 2 deletions pom.xml
Expand Up @@ -5,13 +5,13 @@

<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<packaging>pom</packaging>

<parent>
<groupId>com.github.vladimir-bukhtoyarov</groupId>
<artifactId>bucket4j-parent</artifactId>
<version>7.3.0</version>
<version>7.4.0</version>
<relativePath>./bucket4j-parent</relativePath>
</parent>

Expand Down

0 comments on commit 3feaba0

Please sign in to comment.