feat: allow non root docs()#657
Merged
Merged
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //src:license-checkStatus: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
AlexanderLanin
marked this pull request as ready for review
July 22, 2026 14:34
AlexanderLanin
requested review from
MaximilianSoerenPollak,
dcalavrezo-qorix and
nradakovic
as code owners
July 22, 2026 14:34
MaximilianSoerenPollak
left a comment
MaximilianSoerenPollak
left a comment
Contributor
There was a problem hiding this comment.
Overall looks good, just some questions I have that we should address.
| data: Additional data files to include in the documentation build. | ||
| deps: Additional dependencies for the documentation build. | ||
| scan_code: List of code targets to scan for source code links. | ||
| test_sources: Optional list of repo-relative directory paths which will be used to filter testcases for documentation generation. |
Contributor
There was a problem hiding this comment.
What happens to testcases that do not have file in the attributes?
As that is added by our plugin I think?
Member
Author
There was a problem hiding this comment.
Yeah those would show up in all docs as unlinked tests. Acceptable for now / for my test-use-case.
Comment on lines
+75
to
+87
| def is_testcase_in_scope(test_file: str | None, allowed_dirs: list[str]) -> bool: | ||
| """Return True if the testcase should be turned into a need. | ||
|
|
||
| An empty `allowed_dirs` disables filtering (everything is in scope). Otherwise | ||
| a testcase is in scope only if it has a `file` attribute that is located under | ||
| one of the allowed (repo-relative) directories. | ||
| """ | ||
| if not allowed_dirs: | ||
| return True | ||
| if not test_file: | ||
| return False | ||
| file_path = Path(test_file) | ||
| return any(file_path.is_relative_to(allowed) for allowed in allowed_dirs) |
Contributor
There was a problem hiding this comment.
If this is now new behaviour, and different than what currently is (have everything regardlesss of attributes & properties be a testcase due to the metrics) we should think if this is okay and if so it should be documented
Member
Author
There was a problem hiding this comment.
Default is unfiltered. The entire new docs()-parameter / behavior is undocumented.
Maybe we should call it experimental?
Contributor
There was a problem hiding this comment.
Hmm I think we should do that, but in seperate PR's.
We need to document the docs macro somewhere in the future.
MaximilianSoerenPollak
approved these changes
Jul 24, 2026
MaximilianSoerenPollak
left a comment
MaximilianSoerenPollak
left a comment
Contributor
There was a problem hiding this comment.
Looks like a good step in the right direction.
Talked about in calls & explained. So all fine for me atm.
MaximilianSoerenPollak
merged commit Jul 24, 2026
99e070e
into
eclipse-score:main
16 of 20 checks passed
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.
📌 Description
So far docs() was only callable from the root BUILD file. While that was intentional, this also prevents us from running docs() commands in order to test them properly.
Quite a lot of technical debt has accumulated due to this restriction we imposed. Notably:
🚨 Impact Analysis
✅ Checklist