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

Make documentation bzl_library publicly visible #527

Merged
merged 2 commits into from
Mar 11, 2021

Conversation

shs96c
Copy link
Collaborator

@shs96c shs96c commented Feb 26, 2021

This allows anyone who depends on rules_jvm_external and imports
"something" from these rules into their own rules to be able to
generate stardoc of their own functions.

I've filed bazelbuild/stardoc#93 to track
this issue. Once it's fixed, we can close this.

@jin
Copy link
Collaborator

jin commented Mar 1, 2021

I'm not comfortable for exposing this target because it's meant for RJE-internal docs. If you really need a file, could you create a temporary target with the minimum set of files you need, and expose that instead?

@shs96c
Copy link
Collaborator Author

shs96c commented Mar 1, 2021

The way that stardoc works it that anything that transitively depends upon rules_jvm_external needs to include our bzl files in a bzl_library. Either we need to expose all those files publicly using something like exports_files or we make this rule visible. Exporting the files ties those rules even more intimately to the internals of this ruleset, which is undesirable.

Without this change, any rule that depends upon rules_jvm_external (such as Selenium's own rules) cannot be documented using stardoc. That's why I filed bazelbuild/stardoc#93 and that's why I'm making this change.

@shs96c
Copy link
Collaborator Author

shs96c commented Mar 1, 2021

Also, to create the temporary target, one would need to patch rules_jvm_external since there are build files in our tree, preventing us from just "reaching in and taking what we need"

@jin
Copy link
Collaborator

jin commented Mar 11, 2021

Looks like there's a plan to support bazelbuild/stardoc#93, but work needs to be done to get there. For this PR, could you at least document that the bzl_library is public for stardoc and stardoc only?

shs96c added 2 commits March 11, 2021 11:49
This allows anyone who depends on `rules_jvm_external` and imports
"something" from these rules into their own rules to be able to
generate stardoc of their own functions.

I've filed bazelbuild/stardoc#93 to track
this issue. Once it's fixed, we can close this.
@shs96c shs96c force-pushed the make-docs-visible branch from f96e38b to ea592cb Compare March 11, 2021 11:54
@shs96c shs96c merged commit b2e061d into bazel-contrib:master Mar 11, 2021
@shs96c shs96c deleted the make-docs-visible branch December 9, 2022 16:50
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.

2 participants