Skip to content

Commit a8e1381

Browse files
pjfanningpjfanning
authored
release notes for 1.2.0 (#678)
* release notes for 1.2.0 * Update index.md
1 parent a88eba9 commit a8e1381

File tree

3 files changed

+118
-0
lines changed

3 files changed

+118
-0
lines changed

‎.github/workflows/publish-1.2-docs.yml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
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.2 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@v4
31+
with:
32+
fetch-depth: 0
33+
fetch-tags: true
34+
35+
- name: Set up JDK 8
36+
uses: actions/setup-java@v4
37+
with:
38+
distribution: temurin
39+
java-version: 8
40+
41+
- name: Install sbt
42+
uses: sbt/setup-sbt@v1
43+
44+
- name: Cache Coursier cache
45+
uses: coursier/cache-action@v6
46+
47+
- name: Build Documentation
48+
run: |-
49+
sbt -Dpekko.genjavadoc.enabled=true "set ThisBuild / version := \"1.2.0\"; docs/paradox; unidoc"
50+
env:
51+
JAVA_OPTS: "-verbose:gc -Xmx4g"
52+
53+
# Create directory structure upfront since rsync does not create intermediate directories otherwise
54+
- name: Create directory structure
55+
run: |-
56+
mkdir -p target/nightly-docs/docs/pekko-http/1.2.0/
57+
mkdir -p target/nightly-docs/docs/pekko-http/1.2/
58+
cp -r docs/target/paradox/site/main/ target/nightly-docs/docs/pekko-http/1.2.0/docs
59+
cp -r docs/target/paradox/site/main/ target/nightly-docs/docs/pekko-http/1.2/docs
60+
rm -r docs/target/paradox/site/main/
61+
cp -r target/scala-2.13/unidoc target/nightly-docs/docs/pekko-http/1.2.0/api
62+
cp -r target/scala-2.13/unidoc target/nightly-docs/docs/pekko-http/1.2/api
63+
rm -r target/scala-2.13/unidoc
64+
cp -r target/javaunidoc target/nightly-docs/docs/pekko-http/1.2.0/japi
65+
cp -r target/javaunidoc target/nightly-docs/docs/pekko-http/1.2/japi
66+
rm -r target/javaunidoc
67+
68+
- name: Upload 1.2.x nightly docs
69+
uses: ./.github/actions/sync-nightlies
70+
with:
71+
upload: true
72+
switches: --archive --compress --update --delete --progress --relative
73+
local_path: target/nightly-docs/./docs/pekko-http/1.2.0 # The intermediate dot is to show `--relative` which paths to operate on
74+
remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/pekko/
75+
remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }}
76+
remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }}
77+
remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }}
78+
remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }}
79+
80+
- name: Upload 1.2 nightly docs
81+
uses: ./.github/actions/sync-nightlies
82+
with:
83+
upload: true
84+
switches: --archive --compress --update --delete --progress --relative
85+
local_path: target/nightly-docs/./docs/pekko-http/1.2 # The intermediate dot is to show `--relative` which paths to operate on
86+
remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/pekko/
87+
remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }}
88+
remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }}
89+
remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }}
90+
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.2 Releases](releases-1.2.md)
78
* [1.1 Releases](releases-1.1.md)
89
* [1.0 Releases](releases-1.0.md)
910

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

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# 0. Release Notes (1.2.x)
2+
3+
## 1.2.0
4+
5+
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.
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 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.
8+
9+
### Bug Fix
10+
* fix partial match in HTTP2 HttpMessageRendering class ([PR622](https://github.com/apache/pekko-http/pull/622))
11+
12+
### Changes
13+
* use convertIterable to wrap java Iterables ([PR613](https://github.com/apache/pekko-http/pull/613))
14+
* add `@noinline` annotation to help fix some issues with Kamon metrics ([PR630](https://github.com/apache/pekko-http/pull/630))
15+
* Optimized Uri.withQuery ([PR637](https://github.com/apache/pekko-http/pull/637))
16+
* Make AddFutureAwaitResult an AnyVal ([PR647](https://github.com/apache/pekko-http/pull/647))
17+
18+
### Additions
19+
* Get string representation of javadsl Content and Media Type ([PR616](https://github.com/apache/pekko-http/pull/616))
20+
21+
### Dependency Changes
22+
23+
Most of the dependency changes are small patch level upgrades. Some exceptions include:
24+
25+
* Jackson 2.18.4
26+
* scala-xml 2.3.0
27+
* scala 3.3.6

0 commit comments

Comments
 (0)