This repository has been archived by the owner on Nov 15, 2022. It is now read-only.
#32: Enable publishing bdk-android sources and java docs #33
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
AGP 7.1.0 adds maven-publish APIs for making publishing javadocs and sources for Android libraries very easy. We can use that to resolve bitcoindevkit#32. Changelog: https://developer.android.com/studio/releases/gradle-plugin#versioning-update.
This resolves bitcoindevkit#32. Using new API from AGP 7.1.0 to generate and publish Android sources and javadocs. https://developer.android.com/studio/releases/gradle-plugin#publish-javadoc-jar https://developer.android.com/studio/releases/gradle-plugin#publish-sources-jar
kirillzh
commented
Mar 20, 2022
| publishing { | ||
| singleVariant("release") { | ||
| withSourcesJar() | ||
| withJavadocJar() |
There was a problem hiding this comment.
As mentioned in #32 this will probably need to be custom implemented to use dokka instead of actual javadocs.
thunderbiscuit
approved these changes
Mar 23, 2022
|
This works as-is and builds the sources jar and the javadocs jar for me. As mentioned, a future PR should try and populate that javadocs jar with the Dokka output if possible, but that's not necessary at this point. This does outline the fact that the releases should run the docs/patch workflow before publishing so as to have this jar file populated with our actual documentation, dokka or not. ACK aea8d70. |
|
@kirillzh if you mark this as ready for review I think we can merge. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
Currently sources and javadocs are not being published for bdk-android artifact (unlike bdk-jvm) which makes it impossible to look up sources and documentation of bdk-android in IDE when using it in any project. AGP 7.1.0 added new APIs to
maven-publishplugin to allow publishing sources and javadocs for Android super easy, which are being used here.All Submissions:
cargo fmtandcargo clippybefore committingNew Features:
CHANGELOG.mdBugfixes: