From 3f80f89b865113d000221b6e87123539584a163b Mon Sep 17 00:00:00 2001 From: tommystendahl Date: Tue, 3 Oct 2023 09:18:30 +0200 Subject: [PATCH] Prepare documantation for the new release/c4.1 branch (#229) --- CONTRIBUTING.md | 10 +++++++--- README.md | 10 +++++++--- doc/cassandra_compatibility.md | 22 ++++++++++++++++------ 3 files changed, 30 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a01ab860..5cdd70b8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,13 +25,17 @@ At the moment the oldest maintained release branch is ```release/c3.0``` which is tracking the latest release of Cassandra 3.0.x. Then comes ```release/3.11``` which is tracking the latest release of Cassandra 3.11.x. -The ```master``` branch is tracking the latest release of Cassandra 4.0.x. +Then comes ```release/4.0``` +which is tracking the latest release of Cassandra 4.0.x. +Then comes ```release/4.1``` +which is tracking the latest release of Cassandra 4.1.x. +The ```master``` branch is tracking the latest release of Cassandra 5.0.x. Pull Requests with new features should typically target ```release/c3.11```. -Merge order is then ```PR``` -> ```release/c3.11``` -> ```master``` +Merge order is then ```PR``` -> ```release/c3.11``` -> ```release/c4.0``` -> ```release/c4.1``` -> ```master``` Pull Requests with critical fixes should typically target ```release/c3.0```. -Merge order is then ```PR``` -> ```release/c3.0``` -> ```release/c3.11``` -> ```master``` +Merge order is then ```PR``` -> ```release/c3.0``` -> ```release/c3.11``` -> ```release/c4.0``` -> ```release/c4.1``` -> ```master``` It is encouraged to encapsulate differences between flavors in Flavor Adapters. This simplifies maintenance and merging between flavors. diff --git a/README.md b/README.md index 07a24ec4..8406d0d8 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ ecAudit integrates with Apache Cassandra using its existing plug-in points. Official releases of ecAudit can be downloaded from Maven Central. Get the ecAudit flavor for your Cassandra version. +[![ecAudit for Cassandra 5.0.](https://img.shields.io/maven-central/v/com.ericsson.bss.cassandra.ecaudit/ecaudit_c5.0.svg?label=ecAudit%20for%20Cassandra%205.0.)](https://search.maven.org/search?q=g:%22com.ericsson.bss.cassandra.ecaudit%22%20AND%20a:%22ecaudit_c5.0%22) [![ecAudit for Cassandra 4.1.](https://img.shields.io/maven-central/v/com.ericsson.bss.cassandra.ecaudit/ecaudit_c4.1.svg?label=ecAudit%20for%20Cassandra%204.1.)](https://search.maven.org/search?q=g:%22com.ericsson.bss.cassandra.ecaudit%22%20AND%20a:%22ecaudit_c4.1%22) [![ecAudit for Cassandra 4.0.](https://img.shields.io/maven-central/v/com.ericsson.bss.cassandra.ecaudit/ecaudit_c4.0.svg?label=ecAudit%20for%20Cassandra%204.0.)](https://search.maven.org/search?q=g:%22com.ericsson.bss.cassandra.ecaudit%22%20AND%20a:%22ecaudit_c4.0%22) [![ecAudit for Cassandra 3.11.](https://img.shields.io/maven-central/v/com.ericsson.bss.cassandra.ecaudit/ecaudit_c3.11.svg?label=ecAudit%20for%20Cassandra%203.11.)](https://search.maven.org/search?q=g:%22com.ericsson.bss.cassandra.ecaudit%22%20AND%20a:%22ecaudit_c3.11%22) @@ -61,7 +62,8 @@ The following flavors of ecAudit are no longer maintained. Install and configure ecAudit using the setup guide for your Cassandra version. -* [ecAudit Setup Guide for Cassandra 4.1.\](https://github.com/Ericsson/ecaudit/blob/master/doc/setup.md) +* [ecAudit Setup Guide for Cassandra 5.0.\](https://github.com/Ericsson/ecaudit/blob/master/doc/setup.md) +* [ecAudit Setup Guide for Cassandra 4.1.\](https://github.com/Ericsson/ecaudit/blob/release/c4.1/doc/setup.md) * [ecAudit Setup Guide for Cassandra 4.0.\](https://github.com/Ericsson/ecaudit/blob/release/c4.0/doc/setup.md) * [ecAudit Setup Guide for Cassandra 3.11.\](https://github.com/Ericsson/ecaudit/blob/release/c3.11/doc/setup.md) * [ecAudit Setup Guide for Cassandra 3.0.\](https://github.com/Ericsson/ecaudit/blob/release/c3.0/doc/setup.md) @@ -71,7 +73,8 @@ Install and configure ecAudit using the setup guide for your Cassandra version. Upgrade ecAudit using then upgrade guide for your Cassandra version -* [ecAudit Upgrade Guide for Cassandra 4.1.\](https://github.com/Ericsson/ecaudit/blob/master/UPGRADING.md) +* [ecAudit Upgrade Guide for Cassandra 5.0.\](https://github.com/Ericsson/ecaudit/blob/master/UPGRADING.md) +* [ecAudit Upgrade Guide for Cassandra 4.1.\](https://github.com/Ericsson/ecaudit/blob/release/c4.1/UPGRADING.md) * [ecAudit Upgrade Guide for Cassandra 4.0.\](https://github.com/Ericsson/ecaudit/blob/release/c4.0/UPGRADING.md) * [ecAudit Upgrade Guide for Cassandra 3.11.\](https://github.com/Ericsson/ecaudit/blob/release/c3.11/UPGRADING.md) * [ecAudit Upgrade Guide for Cassandra 3.0.\](https://github.com/Ericsson/ecaudit/blob/release/c3.0/UPGRADING.md) @@ -96,11 +99,12 @@ The following developers have contributed to the ecAudit project: * Marcus Olsson * Ted Petersson * Pushpendra Rajpoot +* Tommy Stendahl ## License -Copyright 2018-22 Telefonaktiebolaget LM Ericsson +Copyright 2018-23 Telefonaktiebolaget LM Ericsson Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. diff --git a/doc/cassandra_compatibility.md b/doc/cassandra_compatibility.md index ba52bebf..1c1c9a4c 100644 --- a/doc/cassandra_compatibility.md +++ b/doc/cassandra_compatibility.md @@ -7,15 +7,25 @@ For instance, ecaudit_c3.11 indicate that the ecAudit flavor was built with Cass The ecAudit plug-in is maintained for selected Cassandra versions only. +## ecaudit_c4.1 + +This flavor is built with the latest version of the Apache Cassandra 4.1.x series. +The table below list the Cassandra version used while building each ecAudit release and indicate compatibility with other Cassandra versions. + +| ecAudit Version | Compiled With | Compatible With | +| ---------------- | --------------- | ------------------------ | +| 3.0.0 -> latest | Cassandra 4.1.2 | Cassandra 4.1.0 -> 4.1.3 | + + ## ecaudit_c4.0 This flavor is built with the latest version of the Apache Cassandra 4.0.x series. The table below list the Cassandra version used while building each ecAudit release and indicate compatibility with other Cassandra versions. -| ecAudit Version | Compiled With | Compatible With | -| ---------------- | --------------- | ------------------------ | -| 2.10.0 -> latest | Cassandra 4.0.7 | Cassandra 4.0.2 -> 4.0.8 | -| 2.9.0 -> latest | Cassandra 4.0.3 | Cassandra 4.0.2 -> 4.0.8 | +| ecAudit Version | Compiled With | Compatible With | +| ---------------- | --------------- | ------------------------- | +| 2.10.0 -> latest | Cassandra 4.0.7 | Cassandra 4.0.2 -> 4.0.11 | +| 2.9.0 -> latest | Cassandra 4.0.3 | Cassandra 4.0.2 -> 4.0.8 | ## ecaudit_c3.11 @@ -25,7 +35,7 @@ The table below list the Cassandra version used while building each ecAudit rele | ecAudit Version | Compiled With | Compatible With | | ---------------- | ----------------- | ---------------------------- | -| 2.10.0 -> latest | Cassandra 3.11.14 | Cassandra 3.11.12 -> 3.11.14 | +| 2.10.0 -> latest | Cassandra 3.11.14 | Cassandra 3.11.12 -> 3.11.16 | | 2.9.1 | Cassandra 3.11.12 | Cassandra 3.11.12 -> 3.11.14 | | 2.9.0 | Cassandra 3.11.12 | Cassandra 3.11.11 -> 3.11.14 | | 2.8.0 | Cassandra 3.11.11 | Cassandra 3.11.2 -> 3.11.11 | @@ -42,7 +52,7 @@ The table below list the Cassandra version used while building each ecAudit rele | ecAudit Version | Compiled With | Compatible With | | ---------------- | ---------------- | -------------------------- | -| 2.10.0 -> latest | Cassandra 3.0.28 | Cassandra 3.0.25 -> 3.0.28 | +| 2.10.0 -> latest | Cassandra 3.0.28 | Cassandra 3.0.25 -> 3.0.29 | | 2.9.0 | Cassandra 3.0.26 | Cassandra 3.0.25 -> 3.0.27 | | 2.8.0 | Cassandra 3.0.25 | Cassandra 3.0.16 -> 3.0.25 | | 2.7.0 -> 2.7.1 | Cassandra 3.0.24 | Cassandra 3.0.16 -> 3.0.24 |