Skip to content

Commit

Permalink
Release notes 1.0-RC1 (#1586)
Browse files Browse the repository at this point in the history
Refs #1580
  • Loading branch information
ennru authored Mar 19, 2019
1 parent bd737f7 commit 124c94e
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 0 deletions.
80 changes: 80 additions & 0 deletions docs/src/main/paradox/release-notes/1.0-RC1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Alpakka 1.0-RC1

## First release candidate of Alpakka 1.0

By now all modules have been worked with to follow a similar structure so that both the user experience and the contributor experience are transferable across the many modules in Alpakka. The recommended structure for connectors is illustrated by the [Reference connector](https://doc.akka.io/docs/alpakka/current/reference.html).

With this release candidate Alpakka reaches the end of the [Road to Alpakka 1.0](https://akka.io/blog/news/2018/08/30/alpakka-towards-1.0). We from now now we'll keep API changes to major releases, and keep minor releases [binary-compatible](https://doc.akka.io/docs/akka/current/common/binary-compatibility-rules.html#binary-compatibility-rules).

Having that said, a few parts make use of the `@ApiMayChange` annotation to keep the door open for API changes, so that they can evolve more rapidly than other modules within Alpakka.

If you have kept to older versions of Alpakka to avoid multiple upgrades, **now is the time** to start migrating to what it offers with 1.0.

Most artifacts of Alpakka are available for Scala 2.11, 2.12 and 2.13.0-M5.


## Highlights since 1.0-M3

* No highlights, just smaller fixes


## Changes per module


### @ref:[Apache Cassandra](../cassandra.md)

* Annotaed with `API may change` as we intend to bring in parts of Akka Persistence Cassandra to Alpakka (see @github:[#1213](#1213))
* [closed issues](https://github.com/akka/alpakka/issues?q=is%3Aclosed+milestone%3A1.0-RC1+label%3Ap%3Acassandra)

### @ref:[AWS DynamoDB](../dynamodb.md)

* Add setting for `maxOpenRequests` @github:[#1545](#1545) by [@williamho](https://github.com/williamho)
* [closed issues](https://github.com/akka/alpakka/issues?q=is%3Aclosed+milestone%3A1.0-RC1+label%3Ap%3Adynamodb)

### @ref:[AWS Lambda](../awslambda.md)

**Breaking API changes**

* Use AWS SDK 2 @github:[#1456](#1456) by [@sullis](https://github.com/sullis)
* [closed issues](https://github.com/akka/alpakka/issues?q=is%3Aclosed+milestone%3A1.0-RC1+label%3Ap%3Aaws-lambda)

### @ref:[AWS S3](../s3.md)

**Breaking API changes**

* Make multipart upload and copy materialize futures (instead of sources) @github:[#1543](#1543)
* New `deleteByPrefix` support @github:[#1560](#1560) by [@danelkotev](https://github.com/danelkotev)
* [closed issues](https://github.com/akka/alpakka/issues?q=is%3Aclosed+milestone%3A1.0-RC1+label%3Ap%3Aaws-s3)

### @ref:[Google Cloud Pub/Sub gRPC](../google-cloud-pub-sub-grpc.md)

* Upgraded to Akka gRPC 0.6 @github:[#1564](#1564)
* [closed issues](https://github.com/akka/alpakka/issues?q=is%3Aclosed+milestone%3A1.0-RC1+label%3Ap%3Agoogle-cloud-pub-sub-grpc)

### @ref:[MQTT streaming](../mqtt-streaming.md)

* [closed issues](https://github.com/akka/alpakka/issues?q=is%3Aclosed+milestone%3A1.0-RC1+label%3Ap%3Amqtt-streaming)

### @ref:[Unix Domain Socket](../unix-domain-socket.md)

* Upgrade to `jnr-unixsocket` 0.22 @github:[#1297](#1297) by [@longshorej](https://github.com/longshorej) and [@huntc](https://github.com/huntc)
* [closed issues](https://github.com/akka/alpakka/issues?q=is%3Aclosed+milestone%3A1.0-RC1+label%3Ap%3Aunix-domain-socket)


## General information

This release is compiled and tested against [Akka 2.5](https://doc.akka.io/docs/akka/current/).

This release was made possible by new and earlier contributors:

| Author | Commits | Lines added | Lines removed |
| ------ | ------- | ----------- | ------------- |
| [<img width="20" alt="ennru" src="https://avatars3.githubusercontent.com/u/458526?v=4&amp;s=40"/> **ennru**](https://github.com/ennru) | 10 | 431 | 228 |
| [<img width="20" alt="huntc" src="https://avatars2.githubusercontent.com/u/694893?v=4&amp;s=40"/> **huntc**](https://github.com/huntc) | 9 | 322 | 213 |
| [<img width="20" alt="2m" src="https://avatars3.githubusercontent.com/u/422086?v=4&amp;s=40"/> **2m**](https://github.com/2m) | 7 | 488 | 367 |
| [<img width="20" alt="williamho" src="https://avatars1.githubusercontent.com/u/1883086?v=4&amp;s=40"/> **williamho**](https://github.com/williamho) | 3 | 61 | 13 |
| [<img width="20" alt="danelkotev" src="https://avatars2.githubusercontent.com/u/35635831?v=4&amp;s=40"/> **danelkotev**](https://github.com/danelkotev) | 1 | 95 | 1 |
| [<img width="20" alt="sullis" src="https://avatars3.githubusercontent.com/u/30938?v=4&amp;s=40"/> **sullis**](https://github.com/sullis) | 1 | 78 | 154 |
| [<img width="20" alt="longshorej" src="https://avatars1.githubusercontent.com/u/515201?v=4&amp;s=40"/> **longshorej**](https://github.com/longshorej) | 1 | 3 | 355 |
| [<img width="20" alt="raboof" src="https://avatars2.githubusercontent.com/u/131856?v=4&amp;s=40"/> **raboof**](https://github.com/raboof) | 1 | 2 | 0 |
| [<img width="20" alt="jcroig" src="https://avatars2.githubusercontent.com/u/122266?v=4&amp;s=40"/> **jcroig**](https://github.com/jcroig) | 1 | 1 | 1 |
1 change: 1 addition & 0 deletions docs/src/main/paradox/release-notes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

@@@ index

* [1.0-RC1](1.0-RC1.md)
* [1.0-M3](1.0-M3.md)
* [1.0-M2](1.0-M2.md)
* [1.0-M1](1.0-M1.md)
Expand Down

0 comments on commit 124c94e

Please sign in to comment.