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

Generate Stardoc #67

Merged
merged 5 commits into from
Nov 11, 2024
Merged

Generate Stardoc #67

merged 5 commits into from
Nov 11, 2024

Conversation

jadenPete
Copy link

@jadenPete jadenPete commented Nov 1, 2024

This PR adds Stardoc to the repository. Previously, we generated Skydoc (now deprecated), but that was removed out of convenience when we upgraded to Bazel 7: d3d6f240312

I also improved some of our documentation, specifically in rules/scala.bzl and rules/scala_with_scalafmt.bzl, which is what most people will use this repository for. Documentation is still lacking in other areas, but I'll leave improving that for another PR.

Jaden Peterson added 5 commits November 1, 2024 11:30
This file just contains aliases to
`@rules_java//toolchains:toolchain_utils.bzl`, so it's not that useful
anyway.

More importantly, Stardoc complains if we do because it needs a
`bzl_library` target for every `*.bzl` file we directly or indirectly
depend upon, and bazel_tools uses a different version of rules_java than
we do. This means we can't depend on `rules_java`'s `bzl_library`
target because Stardoc recognizes our version as a different repository.
@jadenPete jadenPete requested a review from jjudd November 1, 2024 15:36
@jadenPete jadenPete self-assigned this Nov 1, 2024
Copy link

@jjudd jjudd left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for doing this.

@jjudd jjudd merged commit 15dd785 into lucid-master Nov 11, 2024
1 check passed
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.

2 participants