From 9d7f5e36571c9d610d26f0ec39732f0bd47199de Mon Sep 17 00:00:00 2001 From: PJ Fanning Date: Sat, 25 Oct 2025 11:02:06 +0100 Subject: [PATCH] release notes for 1.3.0 (#852) * release notes for 1.3.0 * Update docs/src/main/paradox/release-notes/releases-1.3.md Co-authored-by: Philippus Baalman * Fix formatting and update release notes for 1.3 * Update Jackson dependency version to 2.20.0 --------- Co-authored-by: Philippus Baalman --- .github/workflows/publish-1.3-docs.yml | 91 +++++++++++++++++++ docs/src/main/paradox/release-notes/index.md | 1 + .../paradox/release-notes/releases-1.1.md | 2 +- .../paradox/release-notes/releases-1.2.md | 2 +- .../paradox/release-notes/releases-1.3.md | 29 ++++++ 5 files changed, 123 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/publish-1.3-docs.yml create mode 100644 docs/src/main/paradox/release-notes/releases-1.3.md diff --git a/.github/workflows/publish-1.3-docs.yml b/.github/workflows/publish-1.3-docs.yml new file mode 100644 index 000000000..c242bea74 --- /dev/null +++ b/.github/workflows/publish-1.3-docs.yml @@ -0,0 +1,91 @@ +# 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. + +name: Publish 1.3 docs + +on: + workflow_dispatch: + +jobs: + publish-docs: + name: Publish documentation to nightlies.apache.org + runs-on: ubuntu-latest + if: github.repository == 'apache/pekko-http' + steps: + - name: Checkout + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 + with: + fetch-depth: 0 + fetch-tags: true + ref: 1.3.x + + - name: Set up JDK 8 + uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1 + with: + distribution: temurin + java-version: 8 + + - name: Install sbt + uses: sbt/setup-sbt@6c68d2fe8dfbc0a0534d70101baa2e0420e1a506 # v1.1.9 + + - name: Cache Coursier cache + uses: coursier/cache-action@v6 + + - name: Build Documentation + run: |- + sbt -Dpekko.genjavadoc.enabled=true "set ThisBuild / version := \"1.3.0\"; docs/paradox; unidoc" + env: + JAVA_OPTS: "-verbose:gc -Xmx4g" + + # Create directory structure upfront since rsync does not create intermediate directories otherwise + - name: Create directory structure + run: |- + mkdir -p target/nightly-docs/docs/pekko-http/1.3.0/ + mkdir -p target/nightly-docs/docs/pekko-http/1.3/ + cp -r docs/target/paradox/site/main/ target/nightly-docs/docs/pekko-http/1.3.0/docs + cp -r docs/target/paradox/site/main/ target/nightly-docs/docs/pekko-http/1.3/docs + rm -r docs/target/paradox/site/main/ + cp -r target/scala-2.13/unidoc target/nightly-docs/docs/pekko-http/1.3.0/api + cp -r target/scala-2.13/unidoc target/nightly-docs/docs/pekko-http/1.3/api + rm -r target/scala-2.13/unidoc + cp -r target/javaunidoc target/nightly-docs/docs/pekko-http/1.3.0/japi + cp -r target/javaunidoc target/nightly-docs/docs/pekko-http/1.3/japi + rm -r target/javaunidoc + + - name: Upload 1.3.x nightly docs + uses: ./.github/actions/sync-nightlies + with: + upload: true + switches: --archive --compress --update --delete --progress --relative + local_path: target/nightly-docs/./docs/pekko-http/1.3.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 1.3 nightly docs + uses: ./.github/actions/sync-nightlies + with: + upload: true + switches: --archive --compress --update --delete --progress --relative + local_path: target/nightly-docs/./docs/pekko-http/1.3 # 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/release-notes/index.md b/docs/src/main/paradox/release-notes/index.md index 784b49470..8f9fe2e79 100644 --- a/docs/src/main/paradox/release-notes/index.md +++ b/docs/src/main/paradox/release-notes/index.md @@ -4,6 +4,7 @@ @@@ index +* [1.3 Releases](releases-1.3.md) * [1.2 Releases](releases-1.2.md) * [1.1 Releases](releases-1.1.md) * [1.0 Releases](releases-1.0.md) diff --git a/docs/src/main/paradox/release-notes/releases-1.1.md b/docs/src/main/paradox/release-notes/releases-1.1.md index 13c1f956e..d115657f7 100644 --- a/docs/src/main/paradox/release-notes/releases-1.1.md +++ b/docs/src/main/paradox/release-notes/releases-1.1.md @@ -4,7 +4,7 @@ Release notes for Apache Pekko HTTP 1.1.0. See [GitHub Milestone for 1.1.0-M1](https://github.com/apache/pekko-http/milestone/1?closed=1) and [GitHub Milestone for 1.1.0](https://github.com/apache/pekko-http/milestone/4?closed=1) for a fuller list of changes. -It is strongly recommended that you avoid using Pekko 1.0.x jars with this release, you should use Pekko 1.1.x jars where possible. We don't expect there to be problems running with Pekko 1.0.x jars but Pekko HTTP 1.1 jars are built with Pekko 1.1 jars. +It is strongly recommended that you avoid using Pekko 1.0.x jars with this release, you should use Pekko 1.1.x jars (or later 1.x releases) where possible. We don't expect there to be problems running with Pekko 1.0.x jars but Pekko HTTP 1.1 jars are built with Pekko 1.1 jars. All the changes in the @ref:[1.0.x releases](releases-1.0.md) up to and including v1.0.1. diff --git a/docs/src/main/paradox/release-notes/releases-1.2.md b/docs/src/main/paradox/release-notes/releases-1.2.md index a202fca78..25a0eb7b5 100644 --- a/docs/src/main/paradox/release-notes/releases-1.2.md +++ b/docs/src/main/paradox/release-notes/releases-1.2.md @@ -4,7 +4,7 @@ Release notes for Apache Pekko HTTP 1.2.0. See [GitHub Milestone for 1.2.0](https://github.com/apache/pekko-http/milestone/7?closed=1) and [GitHub Milestone for 1.1.1](https://github.com/apache/pekko-http/milestone/3?closed=1) for a fuller list of changes. -It is strongly recommended that you avoid using Pekko 1.0.x jars with this release, you should use Pekko 1.1.x jars where possible. We don't expect there to be problems running with Pekko 1.0.x jars but Pekko HTTP 1.2 jars are built with Pekko 1.1 jars. +It is strongly recommended that you avoid using Pekko 1.0.x jars with this release, you should use Pekko 1.1.x jars (or later 1.x releases) where possible. We don't expect there to be problems running with Pekko 1.0.x jars but Pekko HTTP 1.2 jars are built with Pekko 1.1 jars. ### Bug Fix * fix partial match in HTTP2 HttpMessageRendering class ([PR622](https://github.com/apache/pekko-http/pull/622)) diff --git a/docs/src/main/paradox/release-notes/releases-1.3.md b/docs/src/main/paradox/release-notes/releases-1.3.md new file mode 100644 index 000000000..89c8bf8ac --- /dev/null +++ b/docs/src/main/paradox/release-notes/releases-1.3.md @@ -0,0 +1,29 @@ +# 0. Release Notes (1.3.x) + +## 1.3.0 + +Release notes for Apache Pekko HTTP 1.3.0. See [GitHub Milestone for 1.3.0](https://github.com/apache/pekko-http/milestone/9?closed=1) for a fuller list of changes. + +It is strongly recommended that you avoid using Pekko 1.0.x jars with this release, you should use Pekko 1.1.x jars (or later 1.x releases) where possible. We don't expect there to be problems running with Pekko 1.0.x jars but Pekko HTTP 1.3 jars are built with Pekko 1.1 jars. + +### Changes +* Avoid using deprecated methods from Pekko Core libs +* Deprecate some methods that will be removed in 2.0.0 ([PR758](https://github.com/apache/pekko-http/pull/758)) +* Add mjs extension for javascript media type ([PR683](https://github.com/apache/pekko-http/pull/683)) +* Avoid sun.misc.Unsafe in StringTools ([PR690](https://github.com/apache/pekko-http/pull/690)) +* HttpChallenge: avoid pekko Java API Option class ([PR709](https://github.com/apache/pekko-http/pull/709)) +* Avoid Scala classes in Java example ([PR741](https://github.com/apache/pekko-http/pull/741)) +* Small improvements to ByteString usage ([PR799](https://github.com/apache/pekko-http/pull/799), [PR821](https://github.com/apache/pekko-http/pull/821), [PR827](https://github.com/apache/pekko-http/pull/827)) +* Add `pekko.http.server.enable-http2` config and deprecate preview settings ([PR847](https://github.com/apache/pekko-http/pull/847)) + +### Additions +* Add Trailer header ([PR684](https://github.com/apache/pekko-http/pull/684)) +* Add Java Duration version of withResponseEntitySubscriptionTimeout ([PR789](https://github.com/apache/pekko-http/pull/789)) +* SSE Client Oversized Messages Handling ([PR846](https://github.com/apache/pekko-http/pull/846)) + +### Dependency Changes + +Most of the dependency changes are small patch level upgrades. Some exceptions include: + +* Jackson 2.20.0 +* scala-xml 2.4.0