Skip to content

Conversation

@alexeagle
Copy link
Contributor

The community already relies on this protobuf format, and that it is a default output of the starlark_doc_extract rule.

Are there specific breaking changes you imagine making here?

FYI @meisterT

The community already relies on this protobuf format, and that it is a default output of the starlark_doc_extract rule.

Are there specific breaking changes you imagine making here?

FYI @meisterT
@alexeagle alexeagle requested a review from lberki as a code owner October 16, 2025 17:49
@github-actions github-actions bot added the awaiting-review PR is awaiting review from an assigned reviewer label Oct 16, 2025
@meisterT meisterT requested a review from tetromino October 16, 2025 17:52
@tetromino
Copy link
Contributor

tetromino commented Oct 16, 2025

Hmm. We do our best to evolve the structure of the output (the proto message format) in a backwards-compatible way. However, the content of the output is absolutely not stable; just to pick the most obvious example, the docstrings for builtin rule/macro attributes will change whenever they are updated in Bazel's source tree.

So the exact output of starlark_doc_extract from a given .bzl file may change even with minor version bumps in Bazel.

Is there a better way of expressing this idea?

@iancha1992 iancha1992 added the team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website label Oct 16, 2025
@tetromino
Copy link
Contributor

tetromino commented Oct 17, 2025

@alexeagle , what do you think about the following wording to replace the old warning:

Note: the exact output of this rule - in particular, the set of natively-defined common rule attributes and their docstrings - can change even with minor Bazel releases. For this reason, we suggest that any golden tests based on this rule to be tagged as "manual" and to require a specific Bazel version when run in CI.

@alexeagle
Copy link
Contributor Author

Sure, I think it's pretty obvious that the documentation strings aren't constant as changes land to the code being documented. want to update the PR?

@tetromino
Copy link
Contributor

@alexeagle - yes, please

@alexeagle
Copy link
Contributor Author

Done, thanks!

@tetromino
Copy link
Contributor

Thanks, sent for review internally

@github-actions github-actions bot removed the awaiting-review PR is awaiting review from an assigned reviewer label Oct 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team-OSS Issues for the Bazel OSS team: installation, release processBazel packaging, website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants