Skip to content

Conversation

@notusedusername
Copy link
Contributor

@notusedusername notusedusername commented Feb 7, 2025

Applied the mitigation that appeared for Gradle after the subdirectory handling for the subdirectories too.

This is just a proposal, as it is a bit error-prone to have the input value and the step output value too for the javadoc-source-folder variable, it can be easily missed which one should be used in future development.

close #95
close #93

@MathieuSoysal MathieuSoysal self-requested a review February 9, 2025 10:47
@MathieuSoysal
Copy link
Owner

Hi notusedusername,

Thank you for your contribution 🎉 and the proposed fix for using Gradle's default output folder in Gradle projects. We appreciate your effort in addressing the subdirectory handling.

Before we proceed, could you please confirm if you have tested the changes? It would be helpful to know if the modifications were verified in different scenarios to ensure they work as expected.

Thank you again for your contribution! 🥳

@notusedusername notusedusername marked this pull request as draft February 10, 2025 09:32
@notusedusername
Copy link
Contributor Author

Hi @MathieuSoysal,

it's still under testing as I didn't really have the time to do that properly on Friday. I put this PR to draft until it's done, sorry that I missed that before.

@notusedusername notusedusername marked this pull request as ready for review February 10, 2025 10:35
@notusedusername
Copy link
Contributor Author

@MathieuSoysal I tested the changes, and it's looking good to me.

@notusedusername
Copy link
Contributor Author

Uh, these test results look pretty bad 😢 . As I saw all of the Gradle cases passed, only the Maven-related cases failed, but all of them.

I dug around the issue a bit, and it seems like the default javadoc generation path has been changed in theorg.apache.maven.plugins:maven-javadoc-plugin from target/site/apidocs to target/reports/apidocs.

As the action generates the docs into the plugin's default directory, and then uses the hardcoded (and it seems outdated) default path to aggregate/copy them, it won't work with newer plugin versions.

I couldn't find the exact mention of this change in the release notes, but locally I used 3.5.0 and it worked like charm.
If I upgrade it to 3.11.2 (the latest and also the version used by the tests), then it'll generate to the new path (and fail).

Meanwhile, as I was writing this lorem ipsum, I figured that these tests have been failing for months, so they are definitely not regression.

@MathieuSoysal ☝️

@MathieuSoysal
Copy link
Owner

MathieuSoysal commented Feb 10, 2025

@notusedusername I have implemented the fix for issue #95. Could you please grant me permission to commit to your repository/branch ?

@MathieuSoysal
Copy link
Owner

Hi @notusedusername,

I have pushed the latest fix, but there is still one test that is failing. Do you have any suggestions on how to resolve it?

Thank you!

@MathieuSoysal MathieuSoysal self-assigned this Feb 11, 2025
Copy link
Owner

@MathieuSoysal MathieuSoysal left a comment

Choose a reason for hiding this comment

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

Perfect ! Thank you a lot for your contribution 🥳

@MathieuSoysal MathieuSoysal merged commit f5f4bc3 into MathieuSoysal:main Feb 26, 2025
162 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

default javadoc generation path has been changed Subdirectiories with Gradle and java-source-folder not set are looking for docs on the wrong path

2 participants