-
Notifications
You must be signed in to change notification settings - Fork 17
Change how docs-as-code is used #187
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: Maximilian Sören Pollak <MaximilianSoerenPollak@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR migrates from a complex multi-target documentation system to a simplified docs-as-code approach with standardized target names at the root level. The changes move away from package-specific docs targets to root-level targets with consistent naming conventions.
Key changes:
- Consolidates documentation targets from
//docs:*to//:*naming pattern - Simplifies the build system by removing complex multi-target configurations
- Updates external dependencies references to use the new
+naming convention instead of~
Reviewed Changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/tests/test_consumer.py | Updates test commands to use simplified root-level targets |
| src/tests/README.md | Updates documentation to reference new target paths |
| src/requirements.txt | Changes external dependency references from ~ to + format |
| src/incremental.py | Simplifies build configuration and removes unused environment variables |
| docs.bzl | Major refactoring from complex multi-target system to simplified single-target approach |
| BUILD | Moves documentation targets to root level and adds process dependency |
| Multiple config files | Updates references to new target naming conventions |
Comments suppressed due to low confidence (1)
src/extensions/score_metamodel/tests/test_external_needs.py:42
- The test function
test_parseris empty and provides no test coverage. Either implement the test or remove it if it's not needed.
def test_parser():
License Check Results🚀 The license check job ran with the Bazel command: bazel run //src:license-checkStatus: ✅ Passed Click to expand output |
| _ = parse_external_needs_sources_from_DATA('["@not_a_valid_string"]') | ||
|
|
||
|
|
||
| def test_parser(): ... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
?
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information | ||
|
|
||
| project = "Score Docs-as-Code" | ||
| project_url = "https://eclipse-score.github.io/docs-as-code/" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this work with ending / as we append '/main here?
|
Note: |
No description provided.