Upgrade sphinx-needs to 6.3.0 by arnoox · Pull Request #361 · eclipse-score/docs-as-code

arnoox · 2026-01-22T16:04:20Z

Upgrade sphinx-needs to 6.3.0

📌 Description

Upgrade sphinx-needs to version 6.3.0

Add support for new options (is_import, constraints) introduced in 6.3.0 and remove the plantuml workaround that was only needed for older versions.

🚨 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 · 2026-01-22T16:05:22Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //src:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: 80a638c9-2586-46c5-afa0-1f399eafaa46
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //src:license-check (72 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (88 packages loaded, 191 targets configured)

Analyzing: target //src:license-check (129 packages loaded, 2435 targets configured)

Analyzing: target //src:license-check (134 packages loaded, 2484 targets configured)

INFO: Analyzed target //src:license-check (137 packages loaded, 4500 targets configured).
[7 / 13] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/external/score_tooling+/dash/tool/formatters/dash_format_converter.runfiles [for tool]; 0s local ... (2 actions, 1 running)
INFO: Found 1 target...
Target //src:license.check.license_check up-to-date:
  bazel-bin/src/license.check.license_check
  bazel-bin/src/license.check.license_check.jar
INFO: Elapsed time: 14.143s, Critical Path: 0.74s
INFO: 13 processes: 3 disk cache hit, 9 internal, 1 processwrapper-sandbox.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/src/license.check.license_check src/formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

github-actions · 2026-01-22T16:11:02Z

The created documentation from the pull request is available at: docu-html

ubmarco

LGTM, let's update SN in a first step, then do the schema validation translation.
Which Sphinx version is resolved now? We should also set a minimum version, to also fix deprecations and use latest features. Can also do that in another PR.

arnoox · 2026-01-22T16:34:33Z

LGTM, let's update SN in a first step, then do the schema validation translation. Which Sphinx version is resolved now? We should also set a minimum version, to also fix deprecations and use latest features. Can also do that in another PR.

sphinx==8.2.3, the same than before the sphinx-needs update. I committed the minimum version directly in requirements.in.

AlexanderLanin · 2026-01-26T11:30:21Z

This looks way less complex than expected for that update 👍

For our users this looks like a minor change?! Nothing seems to break from a user perspective.
Do you need some help with ECA?
Can you merge main / rebase?
Can you have a look at the linter warnings? AFAIK you can run scripts/linter.sh (horrible solution, but it works)

arnoox · 2026-01-26T13:07:13Z

For our users this looks like a minor change?! Nothing seems to break from a user perspective.

Yes, at least the score doc built locally with that update.

Do you need some help with ECA?

I just applied, waiting for approval.

Can you merge main / rebase?

Can you have a look at the linter warnings? AFAIK you can run scripts/linter.sh (horrible solution, but it works)

In fact I found the script and had some problem running it. Seems like ruff / actionlint are not found. Maybe I didn't setup my devcontainer correctly? (ide_support ran successfully)

AlexanderLanin

LGTM

MaximilianSoerenPollak · 2026-01-27T09:36:05Z

src/extensions/score_metamodel/tests/__init__.py

+    kwargs.setdefault("id", "test_need")
+    kwargs.setdefault("type", "requirement")
+    kwargs.setdefault("title", "")
+    kwargs.setdefault("status", None)
+    kwargs.setdefault("tags", [])
+    kwargs.setdefault("collapse", False)
+    kwargs.setdefault("hide", False)
+    kwargs.setdefault("layout", None)
+    kwargs.setdefault("style", None)
+    kwargs.setdefault("external_css", "")
+    kwargs.setdefault("type_name", "")
+    kwargs.setdefault("type_prefix", "")
+    kwargs.setdefault("type_color", "")
+    kwargs.setdefault("type_style", "")
+    kwargs.setdefault("constraints", [])
+    kwargs.setdefault("arch", {})
+    kwargs.setdefault("sections", ())
+    kwargs.setdefault("signature", None)
+    kwargs.setdefault("has_dead_links", False)
+    kwargs.setdefault("has_forbidden_dead_links", False)


Seems a bit excessive.
Do we really need to declare all the defaults again? Can't we take the ones from sphinx-needs internally?

These are already the internal attributes, see: https://github.com/useblocks/sphinx-needs/blob/6371b3a0f13f25e85a2c08c568d0b1eba65e060d/sphinx_needs/data.py#L452

Do you think we need to reduce this to a minimum? What required subset would you suggest?

AlexanderLanin · 2026-01-27T09:36:51Z

src/extensions/score_draw_uml_funcs/__init__.py

intentional change? Is that new?

Code relation of the comment got lost. What is going on?

Sorry, I didn't see you're commit earlier. Now that the PR is merge, it's all good, right? Or did I miss something?

AlexanderLanin · 2026-01-27T09:39:30Z

.github/workflows/consumer_test.yml

ah this includes all change on main branch somehow! Can you try rebasing or whatever to clean that up?

Sorry, I didn't see you're commit earlier. Now that the PR is merge, it's all good, right? Or did I miss something?

Add support for new options (is_import, constraints) introduced in 6.3.0 and remove the plantuml workaround that was only needed for older versions.

…test_source_code_link_integration

…tion

AlexanderLanin · 2026-01-27T09:40:29Z

rebased

MaximilianSoerenPollak

Just two questions.
Though those can be also clarified after merge

MaximilianSoerenPollak · 2026-01-27T09:36:39Z

src/extensions/score_metamodel/tests/__init__.py

+    source_content_keys = {
+        "docname",
+        "lineno",
+        "lineno_content",
+        "external_url",
+        "is_import",
+        "is_external",
+        "doctype",
+        "content",
+        "pre_content",
+        "post_content",
+    }


Can you explain this?

These are the internally provided keys by sphinx needs for the NeedItemSourceUnknown and NeedsContent classes, they are filtered out in the next loop.

MaximilianSoerenPollak · 2026-01-27T09:40:49Z

src/extensions/score_source_code_linker/tests/test_source_code_link_integration.py

+            actual_links: set[str] = (
+                set(actual_source_code_link.split(", "))
+                if actual_source_code_link


This will always be true as it has a default value:
treq_info.get("source_code_link", "no source link")

You're right.

I can prepare a fix that aligns the pattern to the check on expected_code_link.

Ye this can happen in a future PR.

THanks again for this work. Great work

* feat: upgrade sphinx-needs to 6.3.0 Add support for new options (is_import, constraints) introduced in 6.3.0 and remove the plantuml workaround that was only needed for older versions. * feat: added a minimum version requirement for sphinx * refactor: replace NeedsInfoType with NeedItem across multiple files * refactor: remove unused link keys from need function * refactor: reorganize imports in test and source code linker modules * refactor: enhance type hints for better clarity in check_options and test_source_code_link_integration * refactor: improve type casting and validation in _get_normalized function

github-project-automation bot added this to INF - Infrastructure Community Jan 22, 2026

github-project-automation bot moved this to Draft in INF - Infrastructure Community Jan 22, 2026

ubmarco reviewed Jan 22, 2026

View reviewed changes

arnoox marked this pull request as ready for review January 26, 2026 09:52

arnoox requested review from AlexanderLanin, MaximilianSoerenPollak, dcalavrezo-qorix and nradakovic as code owners January 26, 2026 09:52

AlexanderLanin approved these changes Jan 26, 2026

View reviewed changes

a-zw approved these changes Jan 26, 2026

View reviewed changes

arnoox force-pushed the feature/update-sphinx-needs-6.3.0 branch from 276c5ce to fd6645c Compare January 26, 2026 13:59

MaximilianSoerenPollak reviewed Jan 27, 2026

View reviewed changes

AlexanderLanin reviewed Jan 27, 2026

View reviewed changes

arnoox added 7 commits January 27, 2026 10:40

feat: upgrade sphinx-needs to 6.3.0

ae3db2d

Add support for new options (is_import, constraints) introduced in 6.3.0 and remove the plantuml workaround that was only needed for older versions.

feat: added a minimum version requirement for sphinx

6aa8265

refactor: replace NeedsInfoType with NeedItem across multiple files

d2fbec0

refactor: remove unused link keys from need function

78fefe8

refactor: reorganize imports in test and source code linker modules

e88b02d

refactor: enhance type hints for better clarity in check_options and …

36541fa

…test_source_code_link_integration

refactor: improve type casting and validation in _get_normalized func…

a7b7354

…tion

AlexanderLanin force-pushed the feature/update-sphinx-needs-6.3.0 branch from fd6645c to a7b7354 Compare January 27, 2026 09:40

MaximilianSoerenPollak reviewed Jan 27, 2026

View reviewed changes

MaximilianSoerenPollak merged commit 5ce4077 into eclipse-score:main Jan 29, 2026
17 of 18 checks passed

github-project-automation bot moved this from Draft to Done in INF - Infrastructure Community Jan 29, 2026

Comments

Conversation

arnoox commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Upgrade sphinx-needs to 6.3.0

📌 Description

🚨 Impact Analysis

✅ Checklist

Uh oh!

github-actions bot commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions bot commented Jan 22, 2026

Uh oh!

ubmarco left a comment

Choose a reason for hiding this comment

Uh oh!

arnoox commented Jan 22, 2026

Uh oh!

AlexanderLanin commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

arnoox commented Jan 26, 2026

Uh oh!

AlexanderLanin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexanderLanin commented Jan 27, 2026

Uh oh!

MaximilianSoerenPollak left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

arnoox Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

arnoox commented Jan 22, 2026 •

edited

Loading

github-actions bot commented Jan 22, 2026 •

edited

Loading

AlexanderLanin commented Jan 26, 2026 •

edited

Loading

AlexanderLanin Jan 27, 2026 •

edited

Loading

MaximilianSoerenPollak left a comment •

edited

Loading

arnoox Feb 2, 2026 •

edited

Loading