[JAVA-4577] Gradle task doesn't appear to build scala driver API docs Created: 15/Apr/22 Updated: 28/Oct/23 Resolved: 19/Apr/22 |
|
| Status: | Closed |
| Project: | Java Driver |
| Component/s: | Documentation |
| Affects Version/s: | None |
| Fix Version/s: | 4.7.0 |
| Type: | Improvement | Priority: | Minor - P4 |
| Reporter: | Christopher Cho | Assignee: | Ross Lawley |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | internal-user | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||
| Description |
SummaryThe "gradlew docs" command and target, run from the root of the mongodb-java-driver repository, is expected to generates API documentation for the JVM drivers in the build/docs directory, but it currently omits the scala API docs. Here's the output from the run (I think it only shows scala tasks since the rest of the API docs were already built in my directory
Here's the directory listing in build/docs:
This appears to be missing the scala API documentation directory. Please provide the version of the driver. If applicable, please provide the MongoDB server version and topology (standalone, replica set, or sharded cluster).Only tested the gradle script on the r4.5.0 branch since the r4.4.0 version appears to require a version of the JRE I don't currently have installed. How to ReproduceSteps to reproduce. If possible, please include a Short, Self Contained, Correct (Compilable), Example. Additional BackgroundPlease provide any additional background information that may be helpful in diagnosing the bug. |
| Comments |
| Comment by Ross Lawley [ 19/Apr/22 ] | |
|
The cause of the issue seems to be related to Gradle and how we configure the build - a reliance of tasks with type scaladoc and the creation of a task in a sub project. I've added Ross | |
| Comment by Ross Lawley [ 19/Apr/22 ] | |
|
I've fixed the issue in master but on the 4.5 and 4.6 branches please also run:
To get the scala docs. Ross | |
| Comment by Githook User [ 19/Apr/22 ] | |
|
Author: {'name': 'Ross Lawley', 'email': 'ross.lawley@gmail.com', 'username': 'rozza'}Message: Ensure docs task also runs aggregatedScalaDoc
| |
| Comment by Jeffrey Yemin [ 15/Apr/22 ] | |
|
Confirmed that on the 4.4 branch there is a mongo-scala-driver directory in build/docs. |