add release notes (#85)

apache · Aug 29, 2023 · eb055b5 · eb055b5
1 parent b399bcf
commit eb055b5
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 6 deletions.
diff --git a/docs/src/main/paradox/index.md b/docs/src/main/paradox/index.md
@@ -8,6 +8,7 @@ The Apache Pekko Persistence JDBC plugin allows for using JDBC-compliant databas
 
 * [Overview](overview.md)
 * [Configuration](configuration.md)
+* [Release Notes](release-notes.md)
 * [Migration](migration.md)
 * [Query](query.md)
 * [Custom DAO](custom-dao.md)

diff --git a/docs/src/main/paradox/migration.md b/docs/src/main/paradox/migration.md
@@ -1,5 +1,4 @@
 # Migration
 
-* There are no Apache Pekko Persistence JDBC releases yet
 * If you are looking to migrate from [Akka Persistence JDBC](https://doc.akka.io/docs/akka-persistence-jdbc/current/migration.html), you should upgrade to v5.1.x before attempting to migrate to Pekko's equivalent.
-* We will provide a more detailed migration guide for switching from Akka Persistence JDBC to Pekko Persistence JDBC but the Core [Pekko Migration page](https://pekko.apache.org/docs/pekko/current//project/migration-guides.html) can help, in the interim.
+* The [Pekko Migration Guide](https://pekko.apache.org/docs/pekko/current/project/migration-guides.html) is a good summary of the changes that you need to make when switching from Akka to Pekko.
diff --git a/docs/src/main/paradox/overview.md b/docs/src/main/paradox/overview.md
@@ -6,10 +6,6 @@ pekko-persistence-jdbc writes journal and snapshot entries to a configured JDBC
 
 Apache Pekko Persistence JDBC requires Apache Pekko $pekko.version$ or later. It uses @extref:[Slick](slick:) $slick.version$ internally to access the database via JDBC, this does not require user code to make use of Slick.
 
-## Version history
-
-There have been no Apache Pekko Persistence JDBC releases yet.
-
 ## Module info
 
 @@dependency [sbt,Maven,Gradle] {

diff --git a/docs/src/main/paradox/release-notes.md b/docs/src/main/paradox/release-notes.md
@@ -0,0 +1,27 @@
+# Release Notes
+
+## 1.0.0
+Apache Pekko Persistence JDBC 1.0.0 is based on Akka Persistence JDBC 5.1.0. 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.persistence.jdbc` instead of `akka.persistence.jdbc`.
+
+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 any significant bugs that were in Akka Persistence JDBC 5.1.0.
+
+### Dependency Upgrades
+We have tried to limit the changes to third party dependencies that were used in Akka Persistence JDBC 5.1.0. These are some exceptions:
+
+* we updated some of the JDBC jars that we use in testing
+    * postgresql and h2 are 2 examples where there have been recent security fixes