Skip to content

Update to Sphinx-Needs 7.0.0#451

Open
a-zw wants to merge 2 commits intoeclipse-score:mainfrom
etas-contrib:sphinx-needs-7
Open

Update to Sphinx-Needs 7.0.0#451
a-zw wants to merge 2 commits intoeclipse-score:mainfrom
etas-contrib:sphinx-needs-7

Conversation

@a-zw
Copy link
Copy Markdown
Contributor

@a-zw a-zw commented Mar 25, 2026

  • Migrate from deprecated needs_extra_options/needs_extra_links to needs_fields/needs_links
  • replace needs_global_options with needs_default_layout
  • remove obsolete filterwarnings

Fixes #442

@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 25, 2026

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.3.0) and connecting to it...
INFO: Invocation ID: 41460285-4e4a-41bf-a621-2383919fe0ce
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
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 (57 packages loaded, 9 targets configured)

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

Analyzing: target //src:license-check (117 packages loaded, 278 targets configured)

Analyzing: target //src:license-check (128 packages loaded, 1673 targets configured)

Analyzing: target //src:license-check (135 packages loaded, 2527 targets configured)

Analyzing: target //src:license-check (140 packages loaded, 2576 targets configured)

Analyzing: target //src:license-check (140 packages loaded, 2576 targets configured)

Analyzing: target //src:license-check (143 packages loaded, 4465 targets configured)

Analyzing: target //src:license-check (143 packages loaded, 4465 targets configured)

Analyzing: target //src:license-check (143 packages loaded, 4465 targets configured)

Analyzing: target //src:license-check (143 packages loaded, 4465 targets configured)

Analyzing: target //src:license-check (144 packages loaded, 4589 targets configured)

Analyzing: target //src:license-check (144 packages loaded, 4589 targets configured)

INFO: Analyzed target //src:license-check (145 packages loaded, 4715 targets configured).
[14 / 16] [Prepa] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar
[15 / 16] Building src/license.check.license_check.jar (); 0s disk-cache, multiplex-worker
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: 25.822s, Critical Path: 2.59s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 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>]

@MaximilianSoerenPollak
Copy link
Copy Markdown
Contributor

Should we not update directly to 8.0, or you think incremental 7.0 => 8.0 is a better approach?

@a-zw
Copy link
Copy Markdown
Contributor Author

a-zw commented Mar 25, 2026

I favor incremental. So only 7.0.0 for now and 8.0.0 later.

@MaximilianSoerenPollak
Copy link
Copy Markdown
Contributor

I favor incremental. So only 7.0.0 for now and 8.0.0 later.

Alright, works for me.

@github-actions
Copy link
Copy Markdown

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

@a-zw
Copy link
Copy Markdown
Contributor Author

a-zw commented Mar 26, 2026

Checked process_description manually. It fails because they do dirty things like needs.__getitem__.

@MaximilianSoerenPollak
Copy link
Copy Markdown
Contributor

Checked process_description manually. It fails because they do dirty things like needs.__getitem__.

This was a way to get some internal links.
I do remember writing this in the documentation somewhere or something.

It seems that the patchnotes of sphinx-needs have a solution for it, we should try if that fixes the issue:

Use the NeedItem API (e.g. get_links(as_str=False)) for direct access to the internal NeedLink objects.

@MaximilianSoerenPollak
Copy link
Copy Markdown
Contributor

We also should check if we make any use of this quirk in docs-as-code:

need["links"] (and other link fields) now returns a fresh list[str] copy rather than a reference to the internal storage ([PR #1670](https://github.com/useblocks/sphinx-needs/pull/1670))

I can't say off the top of my head but it could be possible.

a-zw added 2 commits March 26, 2026 16:15
Migrate from deprecated needs_extra_options/needs_extra_links to needs_fields/needs_links
replace needs_global_options with needs_default_layout
remove obsolete filterwarnings
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog

Development

Successfully merging this pull request may close these issues.

Upgrade Sphinx Needs version

2 participants