This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-connectors.git
The following commit(s) were added to refs/heads/main by this push:
new 712c4235c update release notes (1.0.0) (#229)
712c4235c is described below
commit 712c4235c3a527e9a1bae03f2e2d8d249a6f669b
Author: PJ Fanning <[email protected]>
AuthorDate: Mon Aug 21 09:04:39 2023 +0100
update release notes (1.0.0) (#229)
* update release notes (1.0.0)
* publish 1.0 docs
* fix snapshot docs
---
.github/workflows/publish-1.0-docs.yml | 65 +++++++++++++++++++++++++++
.github/workflows/publish-nightly.yml | 2 +-
docs/src/main/paradox/other-docs/snapshots.md | 18 ++++----
docs/src/main/paradox/release-notes/index.md | 49 +++++++++++++++++++-
4 files changed, 122 insertions(+), 12 deletions(-)
diff --git a/.github/workflows/publish-1.0-docs.yml
b/.github/workflows/publish-1.0-docs.yml
new file mode 100644
index 000000000..cc52e1dd7
--- /dev/null
+++ b/.github/workflows/publish-1.0-docs.yml
@@ -0,0 +1,65 @@
+name: Publish 1.0 docs
+
+on:
+ workflow_dispatch:
+
+jobs:
+ publish:
+ # runs on main repo only
+ if: github.repository == 'apache/incubator-pekko-connectors'
+ name: Publish
+ runs-on: ubuntu-20.04
+ env:
+ JAVA_OPTS: -Xms2G -Xmx2G -Xss2M -XX:ReservedCodeCacheSize=256M
-Dfile.encoding=UTF-8
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ with:
+ # we don't know what commit the last tag was it's safer to get
entire repo so previousStableVersion resolves
+ fetch-depth: 0
+
+ - name: Setup Java 8
+ uses: actions/setup-java@v3
+ with:
+ distribution: temurin
+ java-version: 8
+
+ - name: Build Documentation
+ run: |-
+ sbt "set ThisBuild / version := \"1.0.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-connectors/1.0.0/
+ mkdir -p target/nightly-docs/docs/pekko-connectors/1.0/
+ cp -r docs/target/paradox/site/main/
target/nightly-docs/docs/pekko-connectors/1.0.0/docs
+ cp -r docs/target/paradox/site/main/
target/nightly-docs/docs/pekko-connectors/1.0/docs
+ rm -r docs/target/paradox/site/main/
+ cp -r target/scala-2.13/unidoc
target/nightly-docs/docs/pekko-connectors/1.0.0/api
+ cp -r target/scala-2.13/unidoc
target/nightly-docs/docs/pekko-connectors/1.0/api
+ rm -r target/scala-2.13/unidoc
+
+ - name: Upload 1.0.x docs
+ uses: ./.github/actions/sync-nightlies
+ with:
+ upload: true
+ switches: --archive --compress --update --delete --progress
--relative
+ local_path: target/nightly-docs/./docs/pekko-connectors/1.0.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.0 docs
+ uses: ./.github/actions/sync-nightlies
+ with:
+ upload: true
+ switches: --archive --compress --update --delete --progress
--relative
+ local_path: target/nightly-docs/./docs/pekko-connectors/1.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 }}
diff --git a/.github/workflows/publish-nightly.yml
b/.github/workflows/publish-nightly.yml
index e945c799c..23b6072e5 100644
--- a/.github/workflows/publish-nightly.yml
+++ b/.github/workflows/publish-nightly.yml
@@ -48,7 +48,7 @@ jobs:
with:
upload: true
switches: --archive --compress --update --delete --progress
--relative
- local_path: target/nightly-docs/./docs/pekko-connectors/ # The
intermediate dot is to show `--relative` which paths to operate on
+ local_path: target/nightly-docs/./docs/pekko-connectors/${{
github.ref_name }}-snapshot # 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 }}
diff --git a/docs/src/main/paradox/other-docs/snapshots.md
b/docs/src/main/paradox/other-docs/snapshots.md
index f1169f90f..65d7ef50c 100644
--- a/docs/src/main/paradox/other-docs/snapshots.md
+++ b/docs/src/main/paradox/other-docs/snapshots.md
@@ -1,7 +1,4 @@
-# Snapshots
-
-[snapshots-badge]:
https://img.shields.io/nexus/s/org.pekko/pekko-connectors-csv_2.13?server=https%3A%2F%2Foss.sonatype.org
-[snapshots]:
https://oss.sonatype.org/content/repositories/snapshots/com/lightbend/akka/pekko-connectors-csv_2.13/
+# Snapshots
Snapshots are published to the Sonatype Snapshot repository after every
successful build on 'main' branch.
Add the following to your project build definition to resolve Apache Pekko
Connectors snapshots:
@@ -15,8 +12,8 @@ Maven
<repositories>
<repository>
<id>snapshots-repo</id>
- <name>Sonatype snapshots</name>
- <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+ <name>Apache snapshots</name>
+ <url>https://repository.apache.org/content/groups/snapshots</url>
</repository>
</repositories>
...
@@ -25,14 +22,15 @@ Maven
sbt
: ```scala
- resolvers += Resolver.sonatypeRepo("snapshots")
+ resolvers += "Apache Staging" at
"https://repository.apache.org/content/groups/snapshots";
+ resolvers += Resolver.ApacheMavenSnapshotsRepo // use this if you are
using sbt 1.9.0 or above
```
Gradle
: ```gradle
repositories {
maven {
- url "https://oss.sonatype.org/content/repositories/snapshots";
+ url "https://repository.apache.org/content/groups/snapshots";
}
}
```
@@ -44,6 +42,6 @@ The [snapshot
documentation](https://pekko.apache.org/docs/pekko-connectors/snap
## Versions
-Latest published snapshot version is [![snapshots-badge][]][snapshots]
+To find the latest published snapshot version, have a look at
https://repository.apache.org/content/groups/snapshots/org/apache/pekko/pekko-connectors-csv_2.13/
-The snapshot repository is cleaned from time to time with no further notice.
Check [Sonatype snapshots Apache Pekko Connectors Kafka
files](https://oss.sonatype.org/content/repositories/snapshots/com/lightbend/akka/)
to see what versions are currently available.
+The snapshot repository is cleaned from time to time with no further notice.
Check https://repository.apache.org/content/groups/snapshots/org/apache/pekko/
to see what versions are currently available.
diff --git a/docs/src/main/paradox/release-notes/index.md
b/docs/src/main/paradox/release-notes/index.md
index b9f65ac1b..97970f842 100644
--- a/docs/src/main/paradox/release-notes/index.md
+++ b/docs/src/main/paradox/release-notes/index.md
@@ -2,6 +2,53 @@
To understand the forces on version numbers, read about @ref:[Apache Pekko
Connectors' versioning scheme](../other-docs/versioning.md).
-@@toc { depth=2 }
+## 1.0.0
+
+Apache Pekko Connectors 1.0.0 is based on Alpakka 4.0.0. Pekko came about as a
result of Lightbend's decision to make future
+Akka releases under a [Business Software
License](https://www.lightbend.com/blog/why-we-are-changing-the-license-for-akka),
+a license that is not compatible with Open Source usage.
+
+Apache Pekko has changed the package names, among other changes. An example
package name change is that the
+Pekko Connectors equivalent of `akka.stream.alpakka.jms` is
`org.apache.pekko.stream.connectors.jms`.
+The `akka` part is replaced by `org.apache.pekko` and the `alpakka` part is
replaced by `connectors`.
+
+Config names that started with `akka` have changed to
+use `pekko` instead. Config names that started with `alpakka` have changed to
use `pekko.connectors`.
+
+Users switching from Akka to Pekko should read our [Pekko Migration
Guide](https://pekko.apache.org/docs/pekko/current/project/migration-guides.html).
+
+Generally, we have tried to make it as easy as possible to switch existing
Akka based projects over to using Pekko.
+
+We have gone through the code base and have tried to properly acknowledge all
third party source code in the
+Apache Pekko code base. If anyone believes that there are any instances of
third party source code that is not
+properly acknowledged, please get in touch.
+
+### Bug Fixes
+We haven't had to fix many bugs that were in Alpakka 4.0.0.
+
+* Fix some cases where functions were accidentally calling themselves, leading
to infinite recursion
+ * [PR142](https://github.com/apache/incubator-pekko-connectors/pull/142)
+ * [PR164](https://github.com/apache/incubator-pekko-connectors/pull/164)
+ * [PR186](https://github.com/apache/incubator-pekko-connectors/pull/186)
+* S3 Connector: Force US_EAST_1 for listBuckets call
([PR66](https://github.com/apache/incubator-pekko-connectors/pull/66))
+* S3 Connector: Only pass SSE headers for multipart upload requests
([PR81](https://github.com/apache/incubator-pekko-connectors/pull/81))
+
+### Additions
+* Add back Scala 2.12 support
([PR65](https://github.com/apache/incubator-pekko-connectors/pull/65))
+* Scala 3 support
([126](https://github.com/apache/incubator-pekko-connectors/issues/126))
+ * The connectors that still only support Scala 2 are Geode, MongoDB and
Slick.
+* FTP Connector now supports UTF8 Autodetect mode
([PR221](https://github.com/apache/incubator-pekko-connectors/pull/221))
+* IronMQ Connector: changed the Circe JSON integration to use
[mdedetrich/pekko-streams-circe](https://github.com/mdedetrich/pekko-streams-circe)
([PR134](https://github.com/apache/incubator-pekko-connectors/pull/134))
+* S3 Connector: Add Bucket With Versioning API support
([PR84](https://github.com/apache/incubator-pekko-connectors/pull/84))
+
+### Dependency Upgrades
+We have tried to limit the changes to third party dependencies that are used
in Pekko HTTP 1.0.0. These are some exceptions:
+
+* Cassandra Driver 4.15.0
([PR100](https://github.com/apache/incubator-pekko-connectors/pull/100))
+* jackson 2.14.3
+* 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.
+
+
+## Extra Documentation
* [Alpakka Release
Notes](https://doc.akka.io/docs/alpakka/current/release-notes/index.html)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
