Fix apiURL for autoAPIMappings #252
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mdedetrich
requested review from
jrudolph,
gmethvin,
He-Pin,
nvollmar,
seglo and
pjfanning
mdedetrich
commented
Sep 20, 2023
| @@ -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 := { | |||
There was a problem hiding this comment.
Taken from https://github.com/apache/incubator-pekko-http/blob/75f26d6c45d4f0ea78737d8daf96020b3327f703/build.sbt#L37-L40 so we know it should work.
mdedetrich
force-pushed
the
fix-auto-api-mappings
branch
from
1ffc848
to
c549431
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pekko projects use a feature called autoAPIMappings which allows a project itself to specify where its docs are published to so that when other projects include this project as a dependency, scaladoc/javadoc automatically know. where to link the URL.
This is was the core issue behind apache/pekko-persistence-cassandra#102 (comment).
@pjfanning This may be strong enough grounds for a new release because basically any project that references anything in Pekko Connectors will have incorrect links in docs.