Skip to content

Commit

Permalink
chore: Rename akka-http2-support to akka-http2-tests and stop publish…
Browse files Browse the repository at this point in the history
…ing on release (#4298)
  • Loading branch information
johanandren authored Sep 20, 2023
1 parent 2b5f8b8 commit 971fc3a
Show file tree
Hide file tree
Showing 35 changed files with 42 additions and 22 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ trait ServerBuilder {
* the `akka.http.server.max-connections` setting. Please see the documentation in the reference.conf for more
* information about what kind of guarantees to expect.
*
* Supports HTTP/2 on the same port if the akka-http2-support module is on the classpath and http2 support is enabled.
* Supports HTTP/2 on the same port if http2 support is enabled.
*/
def bind(f: Function[HttpRequest, CompletionStage[HttpResponse]]): CompletionStage[ServerBinding]

Expand All @@ -80,7 +80,7 @@ trait ServerBuilder {
* the `akka.http.server.max-connections` setting. Please see the documentation in the reference.conf for more
* information about what kind of guarantees to expect.
*
* Supports HTTP/2 on the same port if the akka-http2-support module is on the classpath and http2 support is enabled.
* Supports HTTP/2 on the same port if http2 support is enabled.
*/
def bind(handlerProvider: HandlerProvider): CompletionStage[ServerBinding]

Expand All @@ -92,7 +92,7 @@ trait ServerBuilder {
* the `akka.http.server.max-connections` setting. Please see the documentation in the reference.conf for more
* information about what kind of guarantees to expect.
*
* Supports HTTP/2 on the same port if the akka-http2-support module is on the classpath and http2 support is enabled.
* Supports HTTP/2 on the same port if http2 support is enabled.
*/
def bindSync(f: Function[HttpRequest, HttpResponse]): CompletionStage[ServerBinding]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@ abstract class PreviewServerSettings private[akka] () { self: PreviewServerSetti
/**
* Configures the Http extension to bind using HTTP/2 if given an
* [[akka.http.scaladsl.HttpsConnectionContext]]. Otherwise binds as plain HTTP.
*
* Please note that when using this mode of binding you MUST include
* `"com.typesafe.akka" %% "akka-http2-support" % AkkaHttpVersion` in your
* dependencies / classpath.
*/
def enableHttp2: Boolean

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ class HttpExt @InternalStableApi /* constructor signature is hardcoded in Teleme
private def allModules: List[String] = List(
"akka-parsing",
"akka-http-core",
"akka-http2-support",
"akka-http2-tests",
"akka-http",
"akka-http-caching",
"akka-http-testkit",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ trait ServerBuilder {
* the `akka.http.server.max-connections` setting. Please see the documentation in the reference.conf for more
* information about what kind of guarantees to expect.
*
* Supports HTTP/2 on the same port if the akka-http2-support module is on the classpath and http2 support is enabled.
* Supports HTTP/2 on the same port if http2 support is enabled.
*/
def bind(f: HttpRequest => Future[HttpResponse]): Future[ServerBinding]

Expand All @@ -73,7 +73,7 @@ trait ServerBuilder {
* the `akka.http.server.max-connections` setting. Please see the documentation in the reference.conf for more
* information about what kind of guarantees to expect.
*
* Supports HTTP/2 on the same port if the akka-http2-support module is on the classpath and http2 support is enabled.
* Supports HTTP/2 on the same port if http2 support is enabled.
*/
def bindSync(f: HttpRequest => HttpResponse): Future[ServerBinding]

Expand Down
11 changes: 6 additions & 5 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ inThisBuild(Def.settings(
lazy val userProjects: Seq[ProjectReference] = List[ProjectReference](
parsing,
httpCore,
http2Support,
http2Tests,
http,
httpCaching,
httpTestkit,
Expand Down Expand Up @@ -204,14 +204,14 @@ def gustavDir(kind: String) = Def.task {
s"www/$kind/akka-http/$ver"
}

lazy val http2Support = project("akka-http2-support")
lazy val http2Tests = project("akka-http2-tests")
.settings(commonSettings)
.settings(AutomaticModuleName.settings("akka.http.http2"))
.dependsOn(httpCore, httpTestkit % "test", httpCore % "test->test")
.addAkkaModuleDependency("akka-stream", "provided")
.addAkkaModuleDependency("akka-stream-testkit", "test")
.settings(Dependencies.http2)
.settings(Dependencies.http2Support)
.settings(Dependencies.http2Tests)
.settings {
lazy val h2specPath = Def.task {
(Test / target).value / h2specName / h2specExe
Expand Down Expand Up @@ -244,6 +244,7 @@ lazy val http2Support = project("akka-http2-support")
}
.enablePlugins(BootstrapGenjavadoc)
.enablePlugins(ReproducibleBuildsPlugin)
.enablePlugins(NoPublish) // only contains tests, don't release tests
.disablePlugins(MimaPlugin) // experimental module still

lazy val httpTestkit = project("akka-http-testkit")
Expand Down Expand Up @@ -295,7 +296,7 @@ lazy val httpTests = project("akka-http-tests")

lazy val httpJmhBench = project("akka-http-bench-jmh")
.settings(commonSettings)
.dependsOn(http, http2Support % "compile->compile,test")
.dependsOn(http, http2Tests % "compile->compile,test")
.addAkkaModuleDependency("akka-stream")
.enablePlugins(JmhPlugin)
.enablePlugins(NoPublish) // don't release benchs
Expand Down Expand Up @@ -429,7 +430,7 @@ lazy val docs = project("docs")
.addAkkaModuleDependency("akka-stream-testkit", "provided", AkkaDependency.docs)
.addAkkaModuleDependency("akka-actor-testkit-typed", "provided", AkkaDependency.docs)
.dependsOn(
httpCore, http, httpXml, http2Support, httpMarshallersJava, httpMarshallersScala, httpCaching,
httpCore, http, httpXml, http2Tests, httpMarshallersJava, httpMarshallersScala, httpCaching,
httpTests % "compile;test->test", httpTestkit % "compile;test->test", httpScalafixRules % ScalafixConfig
)
.settings(Dependencies.docs)
Expand Down
4 changes: 0 additions & 4 deletions docs/src/main/paradox/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,10 +239,6 @@ Details can be found in sections @ref[Core Server API](server-side/low-level-api
akka-http-testkit
: A test harness and set of utilities for verifying server-side service implementations

akka-http2-support
: The HTTP/2 implementation to be included only if @ref[HTTP/2 support](server-side/http2.md) is needed.


@@@ div { .group-scala }
akka-http-spray-json
: Predefined glue-code for (de)serializing custom types from/to JSON with [spray-json](https://github.com/spray/spray-json)
Expand Down
1 change: 1 addition & 0 deletions docs/src/main/paradox/migration-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

@@@ index

* [migration-guide-10.6.x](migration-guide-10.6.x.md)
* [migration-guide-10.4.x](migration-guide-10.4.x.md)
* [migration-guide-10.2.x](migration-guide-10.2.x.md)
* [migration-guide-10.1.x](migration-guide-10.1.x.md)
Expand Down
24 changes: 24 additions & 0 deletions docs/src/main/paradox/migration-guide/migration-guide-10.6.x.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Migration Guide to and within Akka HTTP 10.6.x

## General Notes

See the general @ref[compatibility guidelines](../compatibility-guidelines.md).

Under these guidelines, minor version updates are supposed to be binary compatible and drop-in replacements
for former versions under the condition that user code only uses public, stable, non-deprecated API.

If you find an unexpected incompatibility please let us know.

No configuration changes are needed for updating an application from Akka HTTP 10.5.x to 10.6.x.

The `akka-http2-support` module, which was an empty place-holder artifact, is no longer published and needs to be removed
from builds using Akka. HTTP/2 support is provided by the akka-http-core module, no new modules needs to be added to a project
using HTTP/2.

The typesafe-ssl-config dependency and deprecated APIs accepting the types from it has been dropped.

## Dependency updates

### Akka

Akka HTTP 10.4.x requires Akka version >= 2.9.0.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import akka.actor.typed.scaladsl.Behaviors
import akka.http.scaladsl.Http
import akka.http.scaladsl.model._
import akka.http.scaladsl.server.Directives._
import akka.http.scaladsl.server.Route.seal

import scala.io.StdIn

object HttpServerRoutingMinimal {
Expand Down
2 changes: 1 addition & 1 deletion project/Dependencies.scala
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ object Dependencies {

lazy val http2 = l ++= Seq()

lazy val http2Support = l ++= Seq(Test.h2spec)
lazy val http2Tests = l ++= Seq(Test.h2spec)

lazy val httpTestkit = Seq(
versionDependentDeps(
Expand Down
4 changes: 2 additions & 2 deletions scripts/commits-for-release-notes.sh
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ echo
git log --no-merges --reverse --oneline ${LAST_VERSION}.. -- $ROOT_DIR/docs | $REPLACEMENT

echo
echo "#### akka-http2-support"
echo "#### akka-http2-tests"
echo
git log --no-merges --reverse --oneline ${LAST_VERSION}.. -- $ROOT_DIR/akka-http2-support | $REPLACEMENT
git log --no-merges --reverse --oneline ${LAST_VERSION}.. -- $ROOT_DIR/akka-http2-tests | $REPLACEMENT

echo
echo "#### akka-http-caching"
Expand Down

0 comments on commit 971fc3a

Please sign in to comment.