Source links as Bazel target

[a-zw]

📌 Description

Provides a Bazel command for source links to make source dependency explicit.
Use this target in docs() instead of implicitly scanning the git repo.
This allows to have source links even for other modules.

🚨 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]

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: 5b173c5c-ac1e-4221-a42c-a3638269209e
Computing main repo mapping: 
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 (58 packages loaded, 9 targets configured)

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

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

Analyzing: target //src:license-check (126 packages loaded, 1594 targets configured)

Analyzing: target //src:license-check (138 packages loaded, 2450 targets configured)

Analyzing: target //src:license-check (138 packages loaded, 2456 targets configured)

Analyzing: target //src:license-check (138 packages loaded, 2456 targets configured)

Analyzing: target //src:license-check (142 packages loaded, 4590 targets configured)

INFO: Analyzed target //src:license-check (143 packages loaded, 4716 targets configured).
[9 / 13] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions running)
[11 / 13] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
[12 / 13] 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: 21.568s, Critical Path: 2.51s
INFO: 13 processes: 9 internal, 3 processwrapper-sandbox, 1 worker.
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]

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

[MaximilianSoerenPollak]

Overall looks great from my side.
Script part is simple and concise.

Just had some questions regarding some of the things done as I don't understand them.

[MaximilianSoerenPollak]

Overall great stuff, thanks for the work.

Just couple comments / questions.

[MaximilianSoerenPollak]

If I remember correctly it was requested that we use non direct language (like you etc.)
Though I don't care too much about it personally.
What's the opinion of the others?

Here is a suggestion how that could look like:

Suggested change

	In you ``BUILD`` files, you specify which source files to scan
	with ``filegroup`` or ``glob`` or whatever Bazel mechanism you prefer.
	Then, you use the ``sourcelinks_json`` rule to scan those files.
	Finally, pass the scan results to the ``docs`` rule as ``sourcelinks`` attribute.
	In the ``BUILD`` files, it can be specified which source files should be scanned.
	This can be achieved with ``filegroup``, ``glob`` or whatever Bazel mechanism is prefered.
	Then, the ``sourcelinks_json`` rule is used to scan those files.
	Finally, the scanned results need to be passed into ``docs`` rule as ``sourcelinks`` attribute.

[MaximilianSoerenPollak]

Is this following symlinks?
Though not sure if it matters.

[a-zw]

I assume it does because Bazel is using symlinks everywhere.

[MaximilianSoerenPollak]

Thanks for this work. Truly appreciated.

[AlexanderLanin]

I'd like to discuss the user facing API. As needs_json is hidden within docs() but this new target is not.

[MaximilianSoerenPollak]

I'd like to discuss the user facing API. As needs_json is hidden within docs() but this new target is not.

We for sure have to do this.
A unified user facing interface that is simple to use & understand is for sure needed.

I think that we could introduce with the further functionality that is I think still missing here?