refactor: reorganize the documentation CLI - #811
Merged
Conversation
AlexanderLanin
requested review from
MaximilianSoerenPollak,
dcalavrezo-qorix and
nradakovic
as code owners
September 9, 2026 10:20
Comment on lines
+33
to
+43
| @pytest.fixture | ||
| def docs_workspace(fs: FFS, monkeypatch: pytest.MonkeyPatch) -> Path: | ||
| """Create the minimal workspace environment used by ``cli.main``.""" | ||
| monkeypatch.setenv("BUILD_WORKSPACE_DIRECTORY", str(_WORKSPACE)) | ||
| monkeypatch.setenv("PACKAGE_DIR", "component") | ||
| monkeypatch.setenv("SOURCE_DIRECTORY", "docs") | ||
| monkeypatch.setenv("DATA", "[]") | ||
| fs.create_dir(_WORKSPACE / "component") | ||
| for name in ("MODULE.bazel", "MODULE.bazel.lock", "component/BUILD"): | ||
| fs.create_file(_WORKSPACE / name, contents="stable") | ||
| return _WORKSPACE |
Contributor
There was a problem hiding this comment.
Does it test the mock then or does it acutally test implementation details?
Member
Author
There was a problem hiding this comment.
this is a fixture for the other tests. no test here. it's just the common setup portion for all testcases.
Contributor
|
Documentation preview for this pull request is available at: |
MaximilianSoerenPollak
approved these changes
Sep 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Why
The documentation CLI is a distinct runtime used by every
docs()command, but keeping it in the top-levelsrcpackage makes its Bazel ownership and integration contract difficult to discover and extend. Giving it a dedicated package makes the CLI boundary explicit and provides focused regression coverage for the behavior that depends on Bazel-provided configuration.What changed
src/docs_cli.docs.bzlto use the packaged entry point for all interactive documentation commands.