diff --git a/.github/workflows/publish-1.1-docs.yml b/.github/workflows/publish-1.1-docs.yml new file mode 100644 index 00000000..51968b05 --- /dev/null +++ b/.github/workflows/publish-1.1-docs.yml @@ -0,0 +1,72 @@ +name: Publish 1.1 docs + +on: + workflow_dispatch: + +jobs: + publish-docs: + if: github.repository == 'apache/pekko-persistence-r2dbc' + name: Publish 1.1 Docs + runs-on: ubuntu-22.04 + env: + JAVA_OPTS: -Xms2G -Xmx2G -Xss2M -XX:ReservedCodeCacheSize=256M -Dfile.encoding=UTF-8 + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + # we don't know what commit the last tag was it's safer to get entire repo so previousStableVersion resolves + fetch-depth: 0 + fetch-tags: true + + - name: Setup Java 8 + uses: actions/setup-java@v4 + with: + distribution: temurin + java-version: 8 + + - name: Install sbt + uses: sbt/setup-sbt@v1 + + - name: Install Graphviz + run: |- + sudo apt-get install graphviz + + - name: Build 1.1.x Documentation + run: |- + sbt "set ThisBuild / version := \"1.1.0-M1\"; docs/paradox; unidoc" + + # Create directory structure upfront since rsync does not create intermediate directories otherwise + - name: Create 1.1.x directory structure + run: |- + mkdir -p target/nightly-docs/docs/pekko-persistence-r2dbc/1.1.0-M1/ + mkdir -p target/nightly-docs/docs/pekko-persistence-r2dbc/1.1/ + cp -r docs/target/paradox/site/main/ target/nightly-docs/docs/pekko-persistence-r2dbc/1.1.0-M1/docs + cp -r docs/target/paradox/site/main/ target/nightly-docs/docs/pekko-persistence-r2dbc/1.1/docs + rm -r docs/target/paradox/site/main/ + cp -r docs/target/scala-2.13/unidoc target/nightly-docs/docs/pekko-persistence-r2dbc/1.1.0-M1/api + cp -r docs/target/scala-2.13/unidoc target/nightly-docs/docs/pekko-persistence-r2dbc/1.1/api + rm -r docs/target/scala-2.13/unidoc + + - name: Upload 1.1.x docs + uses: ./.github/actions/sync-nightlies + with: + upload: true + switches: --archive --compress --update --delete --progress --relative + local_path: target/nightly-docs/./docs/pekko-persistence-r2dbc/1.1.0-M1 # The intermediate dot is to show `--relative` which paths to operate on + remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/pekko/ + remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }} + remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }} + remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }} + remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }} + + - name: Upload 1.1 docs + uses: ./.github/actions/sync-nightlies + with: + upload: true + switches: --archive --compress --update --delete --progress --relative + local_path: target/nightly-docs/./docs/pekko-persistence-r2dbc/1.1 # The intermediate dot is to show `--relative` which paths to operate on + remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/pekko/ + remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }} + remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }} + remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }} + remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }} diff --git a/docs/src/main/paradox/index.md b/docs/src/main/paradox/index.md index bbe26bbe..76947a39 100644 --- a/docs/src/main/paradox/index.md +++ b/docs/src/main/paradox/index.md @@ -17,7 +17,7 @@ The Pekko Persistence R2DBC plugin allows for using SQL database with R2DBC as a * [Projection](projection.md) * [Migration Tool](migration.md) * [Migration Guides](migration-guides.md) -* [Release Notes](release-notes.md) +* [Release Notes](release-notes/index.md) * [Contributing](contributing.md) @@@ diff --git a/docs/src/main/paradox/release-notes/index.md b/docs/src/main/paradox/release-notes/index.md new file mode 100644 index 00000000..c81b99e2 --- /dev/null +++ b/docs/src/main/paradox/release-notes/index.md @@ -0,0 +1,10 @@ +# Release Notes + +@@toc { depth=1 } + +@@@ index + +* [1.1 Releases](releases-1.1.md) +* [1.0 Releases](releases-1.0.md) + +@@@ diff --git a/docs/src/main/paradox/release-notes.md b/docs/src/main/paradox/release-notes/releases-1.0.md similarity index 94% rename from docs/src/main/paradox/release-notes.md rename to docs/src/main/paradox/release-notes/releases-1.0.md index 5cf6ccd4..59576061 100644 --- a/docs/src/main/paradox/release-notes.md +++ b/docs/src/main/paradox/release-notes/releases-1.0.md @@ -1,4 +1,4 @@ -# Release Notes +# Release Notes (1.0.x) ## 1.0.0 @@ -29,7 +29,7 @@ We haven't had to fix any significant bugs that were in Akka Persistence R2DBC 0 * the minimum required version is Scala 3.3.0 ### Dependency Upgrades -We have tried to limit the changes to third party dependencies that are used in Pekko Persistence R2DBC 0.7.7. These are some exceptions: +We have tried to limit the changes to third party dependencies that are used in Akka Persistence R2DBC 0.7.7. These are some exceptions: * some minor upgrades to r2dbc jars (all still 0.9.x) * 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..a7e6ea8f --- /dev/null +++ b/docs/src/main/paradox/release-notes/releases-1.1.md @@ -0,0 +1,25 @@ +# Release Notes (1.1.x) + +Apache Pekko Persistence R2DBC 1.1.x releases support Java 8 and above. + +## 1.1.0-M1 + +Release notes for Apache Pekko Persistence R2DBC 1.1.0-M1. See [GitHub Milestone for 1.1.0-M1](https://github.com/apache/pekko-persistence-r2dbc/milestone/2?closed=1) for a fuller list of changes. +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. + +### Breaking Changes + +* The dependency on org.postgresql:r2dbc-postgresql is no longer added to our dependency pom.xml + * Users need to add their own explicit dependency if they want to use Postgres (version 1.0.7.RELEASE recommended) + * We now support Postgres and MySQL in pekko-persistence-r2dbc and pekko-projection-r2dbc + * MySQL users will need to add their own explicit dependency on io.asyncer:r2dbc-mysql (version 1.3.0 recommended) ([PR175](https://github.com/apache/pekko-persistence-r2dbc/pull/175), [PR177](https://github.com/apache/pekko-persistence-r2dbc/pull/177)) +* change R2dbcExecutor functions that work with getRowsUpdated to return Future[Long] ([PR90](https://github.com/apache/pekko-persistence-r2dbc/pull/90)) +* Durable State: support revision in deletes ([PR92](https://github.com/apache/pekko-persistence-r2dbc/pull/92)) + +### Changes + +* Add ConnectionFactoryOptionsCustomizer ([PR171](https://github.com/apache/pekko-persistence-r2dbc/pull/171)) + +### Dependency Changes + +* upgrade io.r2dbc dependencies to 1.0.x