release notes for 1.4.0

.github/workflows/publish-1.4-docs.yml

@@ -0,0 +1,103 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# Based on Apache Arrow's java-nightly workflow
+# https://github.com/apache/arrow/blob/master/.github/workflows/java_nightly.yml
+name: Publish 1.4 documentation
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Publish 1.4 docs
+    runs-on: ubuntu-22.04
+    if: github.repository == 'apache/pekko'
+    steps:
+      # TODO we will need to change to use a release tag in future
+      - name: Checkout
+        uses: actions/checkout@v6.0.1
+        with:
+          fetch-depth: 0
+          fetch-tags: true
+          persist-credentials: false
+          ref: 1.4.x
+
+      - name: Setup Java 11
+        uses: actions/setup-java@v5
+        with:
+          distribution: temurin
+          java-version: 11
+
+      - name: Install sbt
+        uses: sbt/setup-sbt@3e125ece5c3e5248e18da9ed8d2cce3d335ec8dd # v1.1.14
+
+      - name: Cache Coursier cache
+        uses: coursier/cache-action@bebeeb0e6f48ebad66d3783946588ecf43114433 # 6.4.8
+
+      - name: Install Graphviz
+        run: |-
+          sudo apt-get install graphviz
+
+      # TODO come up with a better way to control the version, possibly based on git tags
+      - name: Build Documentation
+        env:
+          DEVELOCITY_ACCESS_KEY: ${{ secrets.DEVELOCITY_ACCESS_KEY }}
+        run: |-
+          sbt -Dpekko.genjavadoc.enabled=true "set ThisBuild / version := \"1.4.0\"; docs/paradox; unidoc"
+
+      # Create directory structure upfront since rsync does not create intermediate directories otherwise
+      - name: Create directory structure
+        run: |-
+          mkdir -p target/nightly-docs/docs/pekko/1.4.0/
+          mkdir -p target/nightly-docs/docs/pekko/1.4/
+          cp -r docs/target/paradox/site/main/ target/nightly-docs/docs/pekko/1.4.0/docs
+          cp -r docs/target/paradox/site/main/ target/nightly-docs/docs/pekko/1.4/docs
+          rm -r docs/target/paradox/site/main/
+          cp -r target/scala-2.13/unidoc target/nightly-docs/docs/pekko/1.4.0/api
+          cp -r target/scala-2.13/unidoc target/nightly-docs/docs/pekko/1.4/api
+          rm -r target/scala-2.13/unidoc
+          cp -r target/javaunidoc target/nightly-docs/docs/pekko/1.4.0/japi
+          cp -r target/javaunidoc target/nightly-docs/docs/pekko/1.4/japi
+          rm -r target/javaunidoc
+
+      - name: Upload docs patch version
+        uses: ./.github/actions/sync-nightlies
+        with:
+          upload: true
+          switches: --archive --compress --update --delete --progress --relative
+          local_path: target/nightly-docs/./docs/pekko/1.4.0 # 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 docs api version
+        uses: ./.github/actions/sync-nightlies
+        with:
+          upload: true
+          switches: --archive --compress --update --delete --progress --relative
+          local_path: target/nightly-docs/./docs/pekko/1.4 # 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 }}

docs/src/main/paradox/release-notes/index.md

@@ -4,6 +4,7 @@
 
 @@@ index
 
+* [1.4 Releases](releases-1.4.md)
 * [1.3 Releases](releases-1.3.md)
 * [1.2 Releases](releases-1.2.md)
 * [1.1 Releases](releases-1.1.md)

docs/src/main/paradox/release-notes/releases-1.4.md

@@ -0,0 +1,16 @@
+# Release Notes (1.4.x)
+
+Apache Pekko 1.4.x releases support Java 8 and above.
+
+# 1.4.0
+
+Pekko 1.4.0 has a dependency change and some bug fixes. See the [GitHub Milestone for 1.3.1](https://github.com/apache/pekko/milestone/24?closed=1) and the [GitHub Milestone for 1.4.0](https://github.com/apache/pekko/milestone/25?closed=1) for a fuller list of changes.
+
+### Dependency Changes
+
+* pekko-serialization-jackson: switch to at.yawk.lz4:lz4-java. The org.lz4:lz4-java jar is unmaintained. The forked jar is a drop in replacement but with important bug fixes. Lz4 is only used if you override the default configs for pekko-serialization-jackson. [#2536](https://github.com/apache/pekko/issues/2536)
+* Scala 2.13.18
+
+### Bug Fixes
+
+* Handle build issue in OSGi build code ([PR2513](https://github.com/apache/pekko/pull/2513))