Skip to content

Conversation

@a-zw
Copy link
Contributor

@a-zw a-zw commented Oct 31, 2025

📌 Description

Offers an additional Bazel target for docs-as-code users to build inside the Bazel sandbox.

As a side effect, another commit on the main branch becomes part of this version increment. If we merge this first, then we can remove the git override in this other PR.

🚨 Impact Analysis

Additional feature fully backwards compatible.

  • 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
Copy link

github-actions bot commented Oct 31, 2025

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: f6b3dd24-a568-4a73-851d-5dd5df62b7c3
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 (71 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (88 packages loaded, 236 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).
[10 / 13] [Prepa] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar
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: 13.873s, Critical Path: 0.36s
INFO: 13 processes: 4 disk cache hit, 9 internal.
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
Copy link

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

| Target | What it does |
| --------------------------- | ---------------------------------------------------------------------- |
| `bazel run //:docs` | Builds documentation |
| `bazel build //:html` | Builds documentation in Bazel sandbox |
Copy link
Member

Choose a reason for hiding this comment

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

We need a better name here, as having docs and html is confusing.

And I would not add a build target until we considered the other DRs. The effort and direction in the last months was to get away from bazel build. Maintaining build and run targets at the same time was enormous effort in the past.

We could add an "docs_experimental_sandbox" target, if we have any usecase for it. I don't want to open a lengthy discussion here in parallel to the DRs. But as it stands today, sandbox has only downsides for the sphinx build.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Draft

Development

Successfully merging this pull request may close these issues.

2 participants