feat!: drop deprecated scan_code parameter - #802
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The deprecated API is removed consistently and the replacement path has focused integration coverage.
Pull request overview
Removes the deprecated scan_code API and standardizes source-link generation on code_targets.
Changes:
- Simplifies bundle source-link handling to one generated JSON target.
- Removes deprecated API documentation.
- Adds integration coverage for source links across nested bundles.
File summaries
| File | Description |
|---|---|
docs.bzl |
Removes scan_code and simplifies source-link targets. |
bzl/bundle_rules.bzl |
Replaces the link list attribute with one optional file. |
docs/reference/bazel_macros.rst |
Updates public macro documentation. |
docs/how-to/source_to_doc_links.rst |
Removes deprecated parameter guidance. |
src/extensions/docs/source_code_linker.md |
Documents code_targets as the supported mechanism. |
src/tests/docs_bzl/test_reference_integration.py |
Tests nested source-link generation and rendering. |
src/tests/docs_bzl/scenarios/reference_integration/BUILD |
Documents the expanded integration scenario. |
src/tests/docs_bzl/scenarios/reference_integration/legacy_module/BUILD |
Scopes legacy module test sources. |
src/tests/docs_bzl/scenarios/reference_integration/modern_module/BUILD |
Scopes modern module test sources. |
src/tests/docs_bzl/scenarios/reference_integration/legacy_module/docs/components/component/BUILD |
Adds legacy component code scanning. |
src/tests/docs_bzl/scenarios/reference_integration/modern_module/docs/components/component/BUILD |
Adds modern component code scanning. |
src/tests/docs_bzl/scenarios/reference_integration/legacy_module/docs/components/component/index.rst |
Adds a legacy traceable requirement. |
src/tests/docs_bzl/scenarios/reference_integration/modern_module/docs/components/component/index.rst |
Adds a modern traceable requirement. |
src/tests/docs_bzl/scenarios/reference_integration/legacy_module/docs/components/component/implementation.py |
Adds legacy traceability fixture code. |
src/tests/docs_bzl/scenarios/reference_integration/modern_module/docs/components/component/implementation.py |
Adds modern traceability fixture code. |
Review details
- Files reviewed: 15/15 changed files
- Comments generated: 0
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
Documentation preview for this pull request is available at: |
| project = "S-CORE Modern Module", | ||
| project_url = "https://example.invalid/score-modern-module", | ||
| source_dir = "docs", | ||
| test_sources = ["src/tests/docs_bzl/scenarios/reference_integration"], |
There was a problem hiding this comment.
Does this work as just a folder not a bazel target?
There was a problem hiding this comment.
test_sources is a list of repo-relative paths. I was not even aware we have test_sources
There was a problem hiding this comment.
I just checked, it has 0 users. Next candidate for removal.
MaximilianSoerenPollak
left a comment
MaximilianSoerenPollak
left a comment
There was a problem hiding this comment.
Just one question but looks simple enough I would say.
|
We need to fix module_template though if we want to merge this as well. |
coincidentally already addressed in https://github.com/eclipse-score/module_template/pull/169/changes |
this is simplification only, and some new tests which thanksfully pass