feat: publish stardocs on releases, rather than write_source_files #160
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
starlark_doc_extract
rules and request their outputsNote, I've already made this change in several downstream repos, such as tar.bzl and bazel-lib itself, so the pattern is established.