Skip to content

Documentation builds broken for 22.0.0 and 22.0.1 tagsΒ #4505

@spacekookie

Description

@spacekookie

Describe the bug

I might be holding it wrong (I'm not that experienced with the Java ecosystem anymore) but I tried finding api docs for version 22.0.0 of this library and couldn't find any on javadoc.io. I tried building them locally but got some build issues (see below)

Client Version
22.0.0 and 22.0.1

Kubernetes Version
N/A

Java Version
Java 25 and Java 21

To Reproduce

I tried running mvn javadoc:javadoc (and mvn javadoc:javadoc-no-fork -- not sure what exactly the difference is) and got a bunch of warnings based on missing comments and an error for an unknown tag:

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.12.0:javadoc-no-fork (default-cli) on project client-java-examples-release-17: An error has occurred in Javadoc report generation: 
[ERROR] Exit code: 1
[ERROR] /path/to/k8s-client-java/examples/examples-release-17/src/main/java/io/kubernetes/client/examples/WebSocketsExample.java:30: error: unknown tag: podname
[ERROR]  * -Dexec.args=/api/v1/namespaces/default/pods/<podname>/attach?stdout=true
[ERROR]                                                ^
[ERROR] /path/to/k8s-client-java/examples/examples-release-17/src/main/java/io/kubernetes/client/examples/AttachExample.java:34: warning: use of default constructor, which does not provide a comment
[... a whole bunch more ...]

Expected behavior

Working apidoc build

KubeConfig

N/A

Server (please complete the following information):

N/A

Additional context

I use Arch Linux btw (sorry πŸ˜…)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions