Skip to content

docs: clarify coverage architecture for readers - #18

Merged
AlexanderLanin merged 3 commits into
eclipse-score:mainfrom
etas-contrib:docs/clarify-coverage-architecture
Oct 2, 2026
Merged

AlexanderLanin merged 3 commits into
eclipse-score:mainfrom
etas-contrib:docs/clarify-coverage-architecture

Conversation

@AlexanderLanin

Copy link
Copy Markdown
Member

Why

The architecture page should help repository users understand what coverage the tool measures, how test results relate to the configured coverage scope, and how the gate reaches its result. The previous page led with Bazel and coverage internals, making those concepts hard to follow for readers who maintain the configuration but do not work on the tooling itself.

What changed

@github-actions

github-actions Bot commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //: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: 68d34894-97fb-427f-aa3e-8ff75745fd28
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //:license-check (5 packages loaded, 6 targets configured)

Analyzing: target //:license-check (5 packages loaded, 6 targets configured)

Analyzing: target //:license-check (5 packages loaded, 6 targets configured)

Analyzing: target //:license-check (5 packages loaded, 6 targets configured)

Analyzing: target //:license-check (5 packages loaded, 6 targets configured)

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

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

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

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

Analyzing: target //:license-check (160 packages loaded, 3551 targets configured)

Analyzing: target //:license-check (160 packages loaded, 6245 targets configured)

Analyzing: target //:license-check (161 packages loaded, 6245 targets configured)

Analyzing: target //:license-check (174 packages loaded, 8310 targets configured)

Analyzing: target //:license-check (178 packages loaded, 11535 targets configured)

Analyzing: target //:license-check (178 packages loaded, 11535 targets configured)

INFO: Analyzed target //:license-check (179 packages loaded, 11662 targets configured).
[13 / 16] Generating Dash formatted dependency file ...; 0s disk-cache, processwrapper-sandbox ... (2 actions, 1 running)
INFO: Found 1 target...
Target //tools:license.check.license_check up-to-date:
  bazel-bin/tools/license.check.license_check
  bazel-bin/tools/license.check.license_check.jar
INFO: Elapsed time: 28.375s, Critical Path: 2.09s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/tools/license.check.license_check tools/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>]

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The documentation accurately reflects the implementation and linked known limitations.

Review effort: Balanced
Findings: None

What changed in this PR

Clarifies the coverage architecture from collection and scope through gate evaluation, while documenting implementation limitations.

Changes:

  • Adds collection, scope, and evaluation diagrams.
  • Defines raw/effective coverage with a worked example.
  • Documents backend details and known gate defects.
File Description
docs/​architecture/​index.rst Reorganizes and expands the coverage architecture documentation.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@github-actions

github-actions Bot commented Oct 1, 2026

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-18: https://eclipse-score.github.io/coverage_tool/pr-18/

Comment thread docs/architecture/index.rst Outdated
Comment thread docs/architecture/index.rst Outdated

@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.

Questions / Comments from @dcalavrezo-qorix have been answered.

@AlexanderLanin
AlexanderLanin dismissed dcalavrezo-qorix’s stale review October 2, 2026 14:35

feedback was addressed. merging as better-than-before. Can be adjusted later.

@AlexanderLanin
AlexanderLanin merged commit 2329a18 into eclipse-score:main Oct 2, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants