Skip to content

test: add docs() tests#665

Merged
AlexanderLanin merged 14 commits into
eclipse-score:mainfrom
etas-contrib:testing2
Jul 24, 2026
Merged

test: add docs() tests#665
AlexanderLanin merged 14 commits into
eclipse-score:mainfrom
etas-contrib:testing2

Conversation

@AlexanderLanin

@AlexanderLanin AlexanderLanin commented Jul 24, 2026

Copy link
Copy Markdown
Member

⚠️ blocked by #657

📌 Description

🚨 Impact Analysis

  • This change does not violate any tool requirements and is covered by existing tool requirements
  • This change does not violate any design decisions
  • Otherwise I have created a ticket for new tool qualification

✅ Checklist

  • Added/updated documentation for new or changed features
  • Added/updated tests to cover the changes
  • Followed project coding standards and guidelines

@github-actions

github-actions Bot commented Jul 24, 2026

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //src:license-check

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 311fd421-4f91-48e5-90c4-dd8e5a3e18d3
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
DEBUG: /home/runner/.bazel/external/rules_python+/python/private/repo_utils.bzl:101:16: 
rules_python:coverage_dep WARNING: rules_python's bundled coverage tool has no wheel for python_version=3.12.13, platform=ppc64le-unknown-linux-gnu. `bazel coverage` will produce empty lcov for py_test targets in this configuration. Either pin python_version to a version in the bundled set (see python/private/coverage_deps.bzl), or configure coverage manually via py_runtime.coverage_tool. See docs/coverage.md.
DEBUG: /home/runner/.bazel/external/rules_python+/python/private/repo_utils.bzl:101:16: 
rules_python:coverage_dep WARNING: rules_python's bundled coverage tool has no wheel for python_version=3.12.13, platform=riscv64-unknown-linux-gnu. `bazel coverage` will produce empty lcov for py_test targets in this configuration. Either pin python_version to a version in the bundled set (see python/private/coverage_deps.bzl), or configure coverage manually via py_runtime.coverage_tool. See docs/coverage.md.
DEBUG: /home/runner/.bazel/external/rules_python+/python/private/repo_utils.bzl:101:16: 
rules_python:coverage_dep WARNING: rules_python's bundled coverage tool has no wheel for python_version=3.12.13, platform=s390x-unknown-linux-gnu. `bazel coverage` will produce empty lcov for py_test targets in this configuration. Either pin python_version to a version in the bundled set (see python/private/coverage_deps.bzl), or configure coverage manually via py_runtime.coverage_tool. See docs/coverage.md.
DEBUG: /home/runner/.bazel/external/rules_python+/python/private/repo_utils.bzl:101:16: 
rules_python:coverage_dep WARNING: rules_python's bundled coverage tool has no wheel for python_version=3.12.13, platform=x86_64-unknown-linux-musl. `bazel coverage` will produce empty lcov for py_test targets in this configuration. Either pin python_version to a version in the bundled set (see python/private/coverage_deps.bzl), or configure coverage manually via py_runtime.coverage_tool. See docs/coverage.md.
Loading: 0 packages loaded
    currently loading: src
WARNING: Target pattern parsing failed.
ERROR: Skipping '//src:license-check': no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
ERROR: no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
INFO: Elapsed time: 9.652s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@AlexanderLanin
AlexanderLanin marked this pull request as ready for review July 24, 2026 16:53

@MaximilianSoerenPollak MaximilianSoerenPollak left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks quiet close, I had some questions but overall great solid start.
I think we can soon merge this

Comment thread src/tests/downstream_compatibility/BUILD Outdated
Comment on lines +20 to +25
# FIXME:
# sphinx-needs refuses to add an external need whose type is not registered in
# this project's needs_types, so the consumer must declare the producer's
# `test_req` type. score_metamodel's own checks skip external needs, so the
# id/parts rules never run here. Loaded via the score_metamodel_yaml config
# value because docs(metamodel=...) does not reach the build target.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You could just add the test_req to the config here no?
That would make for a simpler / nicer way of fixing this issue?

well okay not that simple, if I look at how it is done in the rst tests:
Though that is more complex due to it defining NEW options that all need to have. Which you don't need, so yo ucan make it simpl.er

https://github.com/eclipse-score/docs-as-code/blob/main/src/extensions/score_metamodel/tests/rst/conf.py#L42-L129

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is just temp, we need to fix the underlying issue in docs(). Then this can be removed completely.

Comment thread .github/workflows/test.yml
Comment thread .github/workflows/downstream_compatibility.yml
Comment thread src/tests/docs_bzl/fixtures/external_needs/consumer/docs/conf.py

@MaximilianSoerenPollak MaximilianSoerenPollak left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine for me now.
All questions answered, good start with a framework to continue building on top of it.

@AlexanderLanin
AlexanderLanin merged commit 7257af8 into eclipse-score:main Jul 24, 2026
10 of 14 checks passed
@AlexanderLanin
AlexanderLanin deleted the testing2 branch July 24, 2026 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

2 participants