Skip to content

Commit 05b7ab3

Browse files
pjfanningPhilippus
andauthored
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 <philippus@gmail.com> * Fix formatting and update release notes for 1.3 * Update Jackson dependency version to 2.20.0 --------- Co-authored-by: Philippus Baalman <philippus@gmail.com>
1 parent 519acd4 commit 05b7ab3

File tree

5 files changed

+123
-2
lines changed

5 files changed

+123
-2
lines changed
Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Licensed to the Apache Software Foundation (ASF) under one
2+
# or more contributor license agreements. See the NOTICE file
3+
# distributed with this work for additional information
4+
# regarding copyright ownership. The ASF licenses this file
5+
# to you under the Apache License, Version 2.0 (the
6+
# "License"); you may not use this file except in compliance
7+
# with the License. You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing,
12+
# software distributed under the License is distributed on an
13+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
# KIND, either express or implied. See the License for the
15+
# specific language governing permissions and limitations
16+
# under the License.
17+
18+
name: Publish 1.3 docs
19+
20+
on:
21+
workflow_dispatch:
22+
23+
jobs:
24+
publish-docs:
25+
name: Publish documentation to nightlies.apache.org
26+
runs-on: ubuntu-latest
27+
if: github.repository == 'apache/pekko-http'
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
31+
with:
32+
fetch-depth: 0
33+
fetch-tags: true
34+
ref: 1.3.x
35+
36+
- name: Set up JDK 8
37+
uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1
38+
with:
39+
distribution: temurin
40+
java-version: 8
41+
42+
- name: Install sbt
43+
uses: sbt/setup-sbt@6c68d2fe8dfbc0a0534d70101baa2e0420e1a506 # v1.1.9
44+
45+
- name: Cache Coursier cache
46+
uses: coursier/cache-action@v6
47+
48+
- name: Build Documentation
49+
run: |-
50+
sbt -Dpekko.genjavadoc.enabled=true "set ThisBuild / version := \"1.3.0\"; docs/paradox; unidoc"
51+
env:
52+
JAVA_OPTS: "-verbose:gc -Xmx4g"
53+
54+
# Create directory structure upfront since rsync does not create intermediate directories otherwise
55+
- name: Create directory structure
56+
run: |-
57+
mkdir -p target/nightly-docs/docs/pekko-http/1.3.0/
58+
mkdir -p target/nightly-docs/docs/pekko-http/1.3/
59+
cp -r docs/target/paradox/site/main/ target/nightly-docs/docs/pekko-http/1.3.0/docs
60+
cp -r docs/target/paradox/site/main/ target/nightly-docs/docs/pekko-http/1.3/docs
61+
rm -r docs/target/paradox/site/main/
62+
cp -r target/scala-2.13/unidoc target/nightly-docs/docs/pekko-http/1.3.0/api
63+
cp -r target/scala-2.13/unidoc target/nightly-docs/docs/pekko-http/1.3/api
64+
rm -r target/scala-2.13/unidoc
65+
cp -r target/javaunidoc target/nightly-docs/docs/pekko-http/1.3.0/japi
66+
cp -r target/javaunidoc target/nightly-docs/docs/pekko-http/1.3/japi
67+
rm -r target/javaunidoc
68+
69+
- name: Upload 1.3.x nightly docs
70+
uses: ./.github/actions/sync-nightlies
71+
with:
72+
upload: true
73+
switches: --archive --compress --update --delete --progress --relative
74+
local_path: target/nightly-docs/./docs/pekko-http/1.3.0 # The intermediate dot is to show `--relative` which paths to operate on
75+
remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/pekko/
76+
remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }}
77+
remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }}
78+
remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }}
79+
remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }}
80+
81+
- name: Upload 1.3 nightly docs
82+
uses: ./.github/actions/sync-nightlies
83+
with:
84+
upload: true
85+
switches: --archive --compress --update --delete --progress --relative
86+
local_path: target/nightly-docs/./docs/pekko-http/1.3 # The intermediate dot is to show `--relative` which paths to operate on
87+
remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/pekko/
88+
remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }}
89+
remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }}
90+
remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }}
91+
remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
@@@ index
66

7+
* [1.3 Releases](releases-1.3.md)
78
* [1.2 Releases](releases-1.2.md)
89
* [1.1 Releases](releases-1.1.md)
910
* [1.0 Releases](releases-1.0.md)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
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.
66

7-
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.
7+
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.
88

99
All the changes in the @ref:[1.0.x releases](releases-1.0.md) up to and including v1.0.1.
1010

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
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.
66

7-
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.
7+
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.
88

99
### Bug Fix
1010
* fix partial match in HTTP2 HttpMessageRendering class ([PR622](https://github.com/apache/pekko-http/pull/622))
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# 0. Release Notes (1.3.x)
2+
3+
## 1.3.0
4+
5+
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.
6+
7+
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.
8+
9+
### Changes
10+
* Avoid using deprecated methods from Pekko Core libs
11+
* Deprecate some methods that will be removed in 2.0.0 ([PR758](https://github.com/apache/pekko-http/pull/758))
12+
* Add mjs extension for javascript media type ([PR683](https://github.com/apache/pekko-http/pull/683))
13+
* Avoid sun.misc.Unsafe in StringTools ([PR690](https://github.com/apache/pekko-http/pull/690))
14+
* HttpChallenge: avoid pekko Java API Option class ([PR709](https://github.com/apache/pekko-http/pull/709))
15+
* Avoid Scala classes in Java example ([PR741](https://github.com/apache/pekko-http/pull/741))
16+
* 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))
17+
* Add `pekko.http.server.enable-http2` config and deprecate preview settings ([PR847](https://github.com/apache/pekko-http/pull/847))
18+
19+
### Additions
20+
* Add Trailer header ([PR684](https://github.com/apache/pekko-http/pull/684))
21+
* Add Java Duration version of withResponseEntitySubscriptionTimeout ([PR789](https://github.com/apache/pekko-http/pull/789))
22+
* SSE Client Oversized Messages Handling ([PR846](https://github.com/apache/pekko-http/pull/846))
23+
24+
### Dependency Changes
25+
26+
Most of the dependency changes are small patch level upgrades. Some exceptions include:
27+
28+
* Jackson 2.20.0
29+
* scala-xml 2.4.0

0 commit comments

Comments
 (0)