Skip to content
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

Allow package exclusions and inclusions in javadocs #1293

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

vinnybod
Copy link
Contributor

@vinnybod vinnybod commented Dec 5, 2024

There are times where developers want to exclude specific packages from being generated in the javadocs such as internal code. This is commonly offered as a feature of javadoc generation in both maven and gradle.

An exact package can be provided to remove the first level of files, or a .* to remove all subpackages under it.

java_export(
  ...
  doc_excluded_packages = [
    "com.example.internal.*"
  ]
)
java_export(
  ...
  doc_included_packages = [
    "com.example.processor.*"
  ],
  doc_excluded_packages = [
    "com.example.processor.internal.*"
  ]
)

updated_deploy_env = deploy_env + [KOTLIN_STDLIB]
else:
updated_deploy_env = deploy_env
updated_excluded_workspaces = {name: None for name in excluded_workspaces}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

deploy_env gets added back into the docs so we were generating docs for kotlin stdlib which seems wrong. Changed to excluded_workspace to keep it out of the docs, which seems like what was actually intended.
This is also how we handle scala_export in confluent's fork of rules_jvm_external.

@vinnybod
Copy link
Contributor Author

vinnybod commented Dec 6, 2024

Hm, only windows is failing. not sure why

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant