diff --git a/docs/src/main/paradox/release-notes/index.md b/docs/src/main/paradox/release-notes/index.md index af0fd1ec..c81b99e2 100644 --- a/docs/src/main/paradox/release-notes/index.md +++ b/docs/src/main/paradox/release-notes/index.md @@ -1,35 +1,10 @@ # Release Notes -## 1.0.0 -Apache Pekko Connectors Kafka 1.0.0 is based on Alpakka Kafka 3.0.1. Pekko came about as a result of Lightbend's decision to make future -Akka releases under a [Business Software License](https://www.lightbend.com/blog/why-we-are-changing-the-license-for-akka), -a license that is not compatible with Open Source usage. +@@toc { depth=1 } -Apache Pekko has changed the package names, among other changes. The new packages begin with `org.apache.pekko.kafka` instead of `akka.kafka`. +@@@ index -Config names have changed to use `pekko` instead of `akka` in their names. +* [1.1 Releases](releases-1.1.md) +* [1.0 Releases](releases-1.0.md) -Users switching from Akka to Pekko should read our [Migration Guide](https://pekko.apache.org/docs/pekko/current/project/migration-guides.html). - -Generally, we have tried to make it as easy as possible to switch existing Akka based projects over to using Pekko. - -We have gone through the code base and have tried to properly acknowledge all third party source code in the -Apache Pekko code base. If anyone believes that there are any instances of third party source code that is not -properly acknowledged, please get in touch. - -### Bug Fixes -We haven't had to fix many significant bugs that were in Alpakka Kafka 3.0.1. - -* Properly mask all sensitive fields in Consumer and Producer settings [PR100](https://github.com/apache/pekko-connectors-kafka/pull/100) (Alpakka Kafka [CVE-2023-29471](https://akka.io/security/alpakka-kafka-cve-2023-29471.html)) - -### Additions - -* Scala 3 support ([PR58](https://github.com/apache/pekko-connectors-kafka/pull/58)) - * minimum version of Scala 3.3.0 required - -### Dependency Upgrades -We have tried to limit the changes to third party dependencies that were used in Alpakka Kafka 3.0.1. These are some exceptions: - -* jackson 2.14.3 -* protobuf-java 3.19.6 -* scalatest 3.2.14. Pekko users who have existing tests based on Akka Testkit may need to migrate their tests due to the scalatest upgrade. The [scalatest 3.2 release notes](https://www.scalatest.org/release_notes/3.2.0) have a detailed description of the changes needed. +@@@ diff --git a/docs/src/main/paradox/release-notes/releases-1.0.md b/docs/src/main/paradox/release-notes/releases-1.0.md new file mode 100644 index 00000000..f7116d70 --- /dev/null +++ b/docs/src/main/paradox/release-notes/releases-1.0.md @@ -0,0 +1,35 @@ +# Release Notes (1.0.x) + +## 1.0.0 +Apache Pekko Connectors Kafka 1.0.0 is based on Alpakka Kafka 3.0.1. Pekko came about as a result of Lightbend's decision to make future +Akka releases under a [Business Software License](https://www.lightbend.com/blog/why-we-are-changing-the-license-for-akka), +a license that is not compatible with Open Source usage. + +Apache Pekko has changed the package names, among other changes. The new packages begin with `org.apache.pekko.kafka` instead of `akka.kafka`. + +Config names have changed to use `pekko` instead of `akka` in their names. + +Users switching from Akka to Pekko should read our [Migration Guide](https://pekko.apache.org/docs/pekko/current/project/migration-guides.html). + +Generally, we have tried to make it as easy as possible to switch existing Akka based projects over to using Pekko. + +We have gone through the code base and have tried to properly acknowledge all third party source code in the +Apache Pekko code base. If anyone believes that there are any instances of third party source code that is not +properly acknowledged, please get in touch. + +### Bug Fixes +We haven't had to fix many significant bugs that were in Alpakka Kafka 3.0.1. + +* Properly mask all sensitive fields in Consumer and Producer settings [PR100](https://github.com/apache/pekko-connectors-kafka/pull/100) (Alpakka Kafka [CVE-2023-29471](https://akka.io/security/alpakka-kafka-cve-2023-29471.html)) + +### Additions + +* Scala 3 support ([PR58](https://github.com/apache/pekko-connectors-kafka/pull/58)) + * minimum version of Scala 3.3.0 required + +### Dependency Upgrades +We have tried to limit the changes to third party dependencies that were used in Alpakka Kafka 3.0.1. These are some exceptions: + +* jackson 2.14.3 +* protobuf-java 3.19.6 +* scalatest 3.2.14. Pekko users who have existing tests based on Akka Testkit may need to migrate their tests due to the scalatest upgrade. The [scalatest 3.2 release notes](https://www.scalatest.org/release_notes/3.2.0) have a detailed description of the changes needed. diff --git a/docs/src/main/paradox/release-notes/releases-1.1.md b/docs/src/main/paradox/release-notes/releases-1.1.md new file mode 100644 index 00000000..0e6ba3ca --- /dev/null +++ b/docs/src/main/paradox/release-notes/releases-1.1.md @@ -0,0 +1,13 @@ +# Release Notes (1.1.x) + +## 1.1.0-M1 + +Release notes for Apache Pekko Connectors Kafka 1.1.0-M1. +As with all milestone releases, this release is not recommended for production use - it is designed to allow users to try out the changes in a test environment. + +### Dependency Changes + +Most of the dependency changes are small patch level upgrades. Some exceptions include: + +* kafka-clients 3.7.0 +* slf4j was updated to v2