Skip to content

feat: publish stardocs on releases, rather than write_source_files#160

Merged
alexeagle merged 6 commits intomainfrom
stardocs
Oct 21, 2025
Merged

feat: publish stardocs on releases, rather than write_source_files#160
alexeagle merged 6 commits intomainfrom
stardocs

Conversation

@alexeagle
Copy link
Copy Markdown
Contributor

@alexeagle alexeagle commented Sep 29, 2025

The current workflow for docgen is awkward: contributors who change a .bzl file get a red PR telling them to also update a generated .md file in the repo.
It has an ugly dependency shape as well: running stardoc requires a transitive Java and Maven dependency. While bzlmod makes this transparent in the repo's sources, we still observe that slowness when running the target. This means a casual contributor who makes a spelling fix in a .bzl file is immediately confronted with having to perform a long, slow build to get their PR green. Not a good experience for someone evaluating whether they want to use Bazel!

This workflow is replaced by:

Note, I've already made this change in several downstream repos, such as tar.bzl and bazel-lib itself, so the pattern is established.

@alexeagle alexeagle merged commit 3354103 into main Oct 21, 2025
10 checks passed
@alexeagle alexeagle deleted the stardocs branch October 21, 2025 23:26
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.

bzl_library does not validate the inputs are correct

3 participants