Skip to content

Javadoc error when linking to Spring Security's javadoc using Java 8 #9528

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.

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

Closed
wilkinsona opened this issue Mar 30, 2021 · 1 comment · Fixed by #9562
Closed

Javadoc error when linking to Spring Security's javadoc using Java 8 #9528

wilkinsona opened this issue Mar 30, 2021 · 1 comment · Fixed by #9562
Assignees
Labels
in: build An issue in the build type: bug A general bug

Comments

@wilkinsona
Copy link
Member

It looks like Spring Security's javadoc is being built with Java 11. This prevents a Java 8 build from linking to it with the following error:

javadoc: warning - Error fetching URL: https://docs.spring.io/spring-security/site/docs/5.5.0-M3/api/

The error isn't very clear, but it's due to a missing package-list file at https://docs.spring.io/spring-security/site/docs/5.5.0-M3/api/package-list. This is a regression from M2 where https://docs.spring.io/spring-security/site/docs/5.5.0-M2/api/package-list exists.

Until we raise the minimum supported version of Java, I think it would be preferable to use Java 8 to generate the project's javadoc to avoid this sort of problem. It would also be consistent with other Spring projects which, AFAIK, are all using Java 8 for javadoc generation at the moment.

If Java 11 has to be used, perhaps you could put a workaround in place that's similar to the one that the Gradle team used?

@wilkinsona wilkinsona added status: waiting-for-triage An issue we've not yet triaged type: bug A general bug labels Mar 30, 2021
@jzheaux jzheaux self-assigned this Mar 30, 2021
@jzheaux jzheaux added in: build An issue in the build and removed status: waiting-for-triage An issue we've not yet triaged labels Mar 30, 2021
jzheaux added a commit to jzheaux/spring-security that referenced this issue Apr 9, 2021
jzheaux added a commit that referenced this issue Apr 9, 2021
@wilkinsona
Copy link
Member Author

Thanks, @jzheaux. Did you consider switching to Java 8 so that Spring Security's javadoc is consistent with the other projects'?

akohli96 pushed a commit to akohli96/spring-security that referenced this issue Aug 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: build An issue in the build type: bug A general bug
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants