Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix apiURL for autoAPIMappings #252

Merged
merged 1 commit into from
Sep 20, 2023
Merged

Fix apiURL for autoAPIMappings #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/src/main/paradox/release-notes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

To understand the forces on version numbers, read about @ref:[Apache Pekko Connectors' versioning scheme](../other-docs/versioning.md).

## 1.0.1

### Bug Fixes

* Fix `apiURL` so that projects depending on pekko-connectors have the correct
url in their scaladocs via sbt's [autoAPIMappings](https://www.scala-sbt.org/1.x/docs/Howto-Scaladoc.html#Define+the+location+of+API+documentation+for+a+library) feature ([PR252](https://github.com/apache/incubator-pekko-connectors/pull/252))

## 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
Expand Down
6 changes: 4 additions & 2 deletions project/Common.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,8 +111,10 @@ object Common extends AutoPlugin {
case _ => Seq.empty[String]
}),
autoAPIMappings := true,
apiURL := Some(url(
s"https://pekko.apache.org/api/pekko-connectors/${version.value}/org/apache/pekko/stream/connectors/index.html")),
apiURL := {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taken from https://github.com/apache/incubator-pekko-http/blob/75f26d6c45d4f0ea78737d8daf96020b3327f703/build.sbt#L37-L40 so we know it should work.

val apiVersion = if (isSnapshot.value) "current" else version.value
Some(url(s"https://pekko.apache.org/api/pekko-connectors/$apiVersion/"))
},
// show full stack traces and test case durations
Test / testOptions += Tests.Argument("-oDF"),
// -a Show stack traces and exception class name for AssertionErrors.
Expand Down