Skip to content

Remove test log display from docs and clean up conf.py#283

Open
shegazyy wants to merge 1 commit into
eclipse-score:mainfrom
Valeo-S-CORE-Organization:fix/remove_test_logs_from_docs
Open

Remove test log display from docs and clean up conf.py#283
shegazyy wants to merge 1 commit into
eclipse-score:mainfrom
Valeo-S-CORE-Organization:fix/remove_test_logs_from_docs

Conversation

@shegazyy

@shegazyy shegazyy commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

The DisplayTestLogs Sphinx directive collected bazel-testlogs at build time and embedded them in the verification report. This had two problems:

  • The directive was registered in the local conf.py which is not executed in the score reference integration (docs-as-code), making it a no-op in official releases.
  • The project has decided not to include test logs in documentation.

Remove the directive class, its registration, and the "Test Log Files" section in statistics.rst. Also drop the now-unused docutils imports.

Closes #266

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //: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: c130d9aa-f942-4b80-a7cc-99dd1afc8d67
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //:license-check (33 packages loaded, 10 targets configured)

Analyzing: target //:license-check (80 packages loaded, 10 targets configured)

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

Analyzing: target //:license-check (151 packages loaded, 5479 targets configured)

Analyzing: target //:license-check (163 packages loaded, 5825 targets configured)

Analyzing: target //:license-check (163 packages loaded, 8263 targets configured)

Analyzing: target //:license-check (164 packages loaded, 8271 targets configured)

Analyzing: target //:license-check (164 packages loaded, 8271 targets configured)

Analyzing: target //:license-check (167 packages loaded, 10159 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10283 targets configured)

INFO: Analyzed target //:license-check (169 packages loaded, 10409 targets configured).
[1 / 1] no actions running
[14 / 16] [Prepa] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar
[15 / 16] Building license.check.license_check.jar (); 0s disk-cache, multiplex-worker
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 24.481s, Critical Path: 2.61s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./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>]

@shegazyy

shegazyy commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

Hey @AlexanderLanin 🙏 ready for review whenever you have a moment!

@github-actions

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

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

The DisplayTestLogs Sphinx directive collected bazel-testlogs at build
time and embedded them in the verification report. This had two problems:
- The directive was registered in the local conf.py which is not executed
  in the score reference integration (docs-as-code), making it a no-op
  in official releases.
- The project has decided not to include test logs in documentation.

Remove the directive class, its registration, and the "Test Log Files"
section in statistics.rst. Also drop the now-unused docutils imports.

Closes eclipse-score#266
@shegazyy shegazyy force-pushed the fix/remove_test_logs_from_docs branch from 79fd187 to 5e0cc09 Compare July 8, 2026 12:34
@shegazyy shegazyy requested a deployment to workflow-approval July 8, 2026 12:34 — with GitHub Actions Waiting
@shegazyy shegazyy requested a deployment to workflow-approval July 8, 2026 12:34 — with GitHub Actions Waiting
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.

docs-as-code mismatch

1 participant