Dennis-Mircea Ciupitu created FLINK-40413:
---------------------------------------------
Summary: Autoscaling example classes leak into the operator
javadoc site
Key: FLINK-40413
URL: https://issues.apache.org/jira/browse/FLINK-40413
Project: Flink
Issue Type: Bug
Components: Kubernetes Operator
Reporter: Dennis-Mircea Ciupitu
Fix For: kubernetes-operator-1.16.0
h1. Summary
The published operator javadocs
([https://nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/api/java/])
contain an {{autoscaling}} package with the two example classes
{{AutoscalingExample}} and {{LoadSimulationPipeline}} from
{{examples/autoscaling}}. Examples are not part of the operator API surface and
should not appear on the site, which otherwise only hosts operator and
autoscaler packages.
h1. Cause
The nightly docs workflow ({{.github/workflows/docs.yaml}}) builds the site
with {{mvn javadoc:aggregate}} over the whole reactor, which includes the
{{examples}} module, and filters examples out with
{{-DexcludePackageNames="org.apache.flink.examples"}}.
The autoscaling example however declares the bare package {{autoscaling}}
instead of a package under {{org.apache.flink}}, so the exclusion pattern does
not match it. All other Java examples use {{org.apache.flink.examples}} and are
filtered correctly, making this the only leaked package on the site.
h1. Proposed fix
Move the two classes into {{org.apache.flink.examples.autoscaling}} so they
fall under the exclusion already in place. This needs no workflow change and
also removes a bare top-level package name from the codebase. The shade plugin
{{mainClass}} and the {{entryClass}} in {{autoscaling-dynamic.yaml}} need the
matching update.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
