Adding helper_lib by MaximilianSoerenPollak · Pull Request #207 · eclipse-score/docs-as-code

MaximilianSoerenPollak · 2025-08-13T08:42:25Z

Added helper lib that contains some often used functions

MaximilianSoerenPollak · 2025-08-13T08:43:26Z

/consumer-test

github-actions · 2025-08-13T08:43:56Z

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: 63465927-f53b-4dc1-86bb-461e0fd1fed0
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 (73 packages loaded, 9 targets configured)

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

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

Analyzing: target //src:license-check (134 packages loaded, 2472 targets configured)

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

INFO: Analyzed target //src:license-check (137 packages loaded, 4488 targets configured).
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: 14.622s, Critical Path: 0.37s
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>
[main] INFO Querying Eclipse Foundation for license data for 84 items.
[main] INFO Found 58 items.
[main] INFO Querying ClearlyDefined for license data for 26 items.
[main] ERROR Error response from ClearlyDefined 429

github-actions · 2025-08-13T08:45:50Z

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

AlexanderLanin · 2025-08-13T09:15:37Z

Can you check against eclipse-score/tooling#30 please

AlexanderLanin · 2025-08-13T15:26:12Z

@@ -356,35 +359,35 @@ def test_group_by_need_empty_list():
 def test_parse_git_output_ssh_format():


move these tests? (separate PR?)

Yes, need to move these yep.

AlexanderLanin · 2025-08-13T15:31:11Z

+            # fallback to cwd when building with python -m sphinx docs _build -T
+            if recoursion_break:
+                return None


Is it possible to write that loop somehow differently? I still don't get it. And there is no fallback to cwd?

Basically,

In Esbonio or other executions it can happen that it reaches the home directory '/' and there is still no .git.
If this happens it would just loop indifferently without stopping. Therefore if we found the '/' then we tell it that it already did find it and break.

There might be a better way to write this, I have another look at it.

Consider while + else. No idea whether that will make it better, but it sounds like a perfect fit.

AlexanderLanin · 2025-08-13T15:33:36Z

+    Unlike other funcions, this function behaves the same for the following commands:
+
+    'bazel run' => str
+    'bazel build' => str


bazel build should not have .git in the sandbox? And it could run remotely where there is definitely no .git.

I did print the statements inside of the conf.py and accumulated the behaviour via that.

I have not tested it yet as a remote / imported thing.

AlexanderLanin · 2025-08-13T15:34:41Z

+
+def get_github_repo_info(git_root_cwd: Path) -> str:
+    """
+    Unlike other funcions, this function behaves the same for the following commands:


Suggested change

Unlike other funcions, this function behaves the same for the following commands:

Query git for the github remote repository (based on heuristic).

Unlike other funcions, this function behaves the same for the following commands:

AlexanderLanin · 2025-08-13T15:35:26Z

+    return repo
+
+
+def get_git_root(git_root: Path = Path()) -> Path:


get_git_root vs find_git_root is unclear

Funny you mention that. I too am struggling to remember why we had this.
Was copied from the place we had those functions before.

I know it makes testing possible, but there might be a nicer way or better way to name those.

AlexanderLanin · 2025-08-13T15:35:46Z

+    return passed_git_root
+
+
+def get_github_base_url(git_root: Path = Path()) -> str:


Suggested change

def get_github_base_url(git_root: Path = Path()) -> str:

def get_github_pages_url(git_root: Path = Path()) -> str:

MaximilianSoerenPollak · 2025-08-14T09:58:58Z

/consumer-test

MaximilianSoerenPollak · 2025-08-14T21:11:53Z

/consumer-test

MaximilianSoerenPollak · 2025-08-14T21:21:41Z

-        f"{get_github_link(ws_root, n)}<>{n.file}:{n.line}" for n in needlinks
-    )
+def make_source_link(needlinks):
+    return ", ".join(f"{get_github_link(n)}<>{n.file}:{n.line}" for n in needlinks)


It seems that both formaters disagree on this.

Ruff (via multitool) fixed it to be like the old style.
Then our formatter fixed it again to be like the right.

what is "our formatter"?

the one that we run via format.fix bazel run //src:format.fix

MaximilianSoerenPollak · 2025-08-14T21:22:10Z

+    with open(golden_file) as f2:
        json2 = json.load(f2, object_hook=needlink_test_decoder)
    assert len(json1) == len(json2), (
        f"{file1}'s lenth are not the same as in the golden file lenght. "


Nit:

Suggested change

f"{file1}'s lenth are not the same as in the golden file lenght. "

f"{file1}'s lenth is not the same as the golden file. "

MaximilianSoerenPollak · 2025-08-14T21:23:19Z

+    - 'bazel run' => ✅ Full workspace path
+    - 'bazel build' => ❌ None (sandbox isolation)
+    - 'direct sphinx' => ❌ None (no Bazel environment)


Unsure if Icons are a good idea, but I didn't want to bother to remove them.

MaximilianSoerenPollak · 2025-08-14T21:24:47Z

+            f"Got wrong input line from 'get_github_repo_info'. Input: {str_line}. "
+            + "Expected example: 'origin git@github.com:user/repo.git'"
+        )
+        return ""


Nit/Next PR:

Look through this file to find out where we actually can throw exceptions etc.
As this 'empty' return might actually do more harm than good.

MaximilianSoerenPollak · 2025-08-14T21:27:00Z

+        assert all(c in "0123456789abcdef" for c in decoded_result)
+        return decoded_result
+    except Exception as e:
+        LOGGER.warning(f"Unexpected error: {git_root}", exc_info=e)


Nit:

Suggested change

LOGGER.warning(f"Unexpected error: {git_root}", exc_info=e)

LOGGER.warning(f"Unexpected error while trying to get git_hash. Exceuted in: {git_root}", exc_info=e)

MaximilianSoerenPollak · 2025-08-14T21:28:22Z

/consumer-test

MaximilianSoerenPollak · 2025-08-14T21:29:46Z

Overall it looks alright, I did check and don't see any ruff errors in the helper_lib as far as I can tell. Just so I don't introduce new linter warnnings while we try to reduce old ones.

MaximilianSoerenPollak · 2025-08-14T21:31:34Z

Fun..
It breaks consumer-tests.

https://github.com/eclipse-score/docs-as-code/actions/runs/16977114074/job/48128734948

MaximilianSoerenPollak · 2025-08-14T21:39:05Z

Fun.. It breaks consumer-tests.

https://github.com/eclipse-score/docs-as-code/actions/runs/16977114074/job/48128734948

Testing it locally, seems like a simple-ish fix.

Edit:
Seeing some of these errors locally.

WARNING: External need 'PROCESS_wp__tool_verification_report' in
PosixPath('/home/maxi/.cache/bazel/_bazel_maxi/3cd7bd6002cd113bb4e19889316e3ec2/execroot/_main/bazel-out/k8-fastbuild/bin/docs.runfiles/score_process+/needs_json/_build/needs/needs.json') could not be added: A need with ID
'PROCESS_wp__tool_verification_report' already exists.
WARNING: External need 'PROCESS_wp__training_path' in
PosixPath('/home/maxi/.cache/bazel/_bazel_maxi/3cd7bd6002cd113bb4e19889316e3ec2/execroot/_main/bazel-out/k8-fastbuild/bin/docs.runfiles/score_process+/needs_json/_build/needs/needs.json') could not be added: A need with ID
'PROCESS_wp__training_path' already exists

I'm guessing the consumer tests then aren't cleaning properly? Not sure where this comes from?
Could only explain it to myself if there is a re-import?

* Followup PR to integrate nits of #207

Adding a helper_lib which adds some common used functionality. Added following functions: - find workspace root (based on bazel workspace environment var) - find git root - get & parse git remote repo - get git hash

* Followup PR to integrate nits of eclipse-score#207

MaximilianSoerenPollak requested review from AlexanderLanin and dcalavrezo-qorix as code owners August 13, 2025 08:42

github-project-automation Bot added this to INF - Infrastructure Community Aug 13, 2025

github-project-automation Bot moved this to Draft in INF - Infrastructure Community Aug 13, 2025

MaximilianSoerenPollak force-pushed the MSP_add_git_lib branch from bfd3507 to 5afbace Compare August 13, 2025 14:21

AlexanderLanin reviewed Aug 13, 2025

View reviewed changes

MaximilianSoerenPollak mentioned this pull request Aug 14, 2025

Fix linting errors part 2 #211

Merged

Added helper_lib

4deec1a

MaximilianSoerenPollak force-pushed the MSP_add_git_lib branch from 6116710 to 4deec1a Compare August 14, 2025 21:11

MaximilianSoerenPollak added 2 commits August 14, 2025 23:17

Formatting

4fa2e30

Fixing imports

d334d95

MaximilianSoerenPollak commented Aug 14, 2025

View reviewed changes

Comment thread src/helper_lib/__init__.py

MaximilianSoerenPollak commented Aug 14, 2025

View reviewed changes

Comment thread src/helper_lib/__init__.py Outdated

MaximilianSoerenPollak commented Aug 14, 2025

View reviewed changes

MaximilianSoerenPollak added 2 commits August 14, 2025 23:44

Fixed consumer_tests & removed print

9a1bad5

Formatting

09cd960

AlexanderLanin approved these changes Aug 14, 2025

View reviewed changes

MaximilianSoerenPollak merged commit 71a1ec1 into eclipse-score:main Aug 14, 2025
7 of 8 checks passed

github-project-automation Bot moved this from Draft to Done in INF - Infrastructure Community Aug 14, 2025

MaximilianSoerenPollak added a commit to MaximilianSoerenPollak/docs-as-code that referenced this pull request Aug 14, 2025

Followup PR to integrate nits of eclipse-score#207

b176d4d

This was referenced Aug 14, 2025

Followup PR to integrate nits of #207 #212

Merged

Simplify Docs-As-Code structure #213

Closed

MaximilianSoerenPollak added a commit to MaximilianSoerenPollak/docs-as-code that referenced this pull request Aug 18, 2025

Followup PR to integrate nits of eclipse-score#207

b78bbc5

MaximilianSoerenPollak added a commit that referenced this pull request Aug 18, 2025

Followup PR to integrate nits of #207 (#212)

5531393

* Followup PR to integrate nits of #207

arnoox pushed a commit to arnoox/score-docs-as-code that referenced this pull request Feb 20, 2026

Followup PR to integrate nits of eclipse-score#207 (eclipse-score#212)

e48a1fc

* Followup PR to integrate nits of eclipse-score#207

		@@ -356,35 +359,35 @@ def test_group_by_need_empty_list():
		def test_parse_git_output_ssh_format():

		return repo


		def get_git_root(git_root: Path = Path()) -> Path:

		return passed_git_root


		def get_github_base_url(git_root: Path = Path()) -> str:

	def get_github_base_url(git_root: Path = Path()) -> str:
	def get_github_pages_url(git_root: Path = Path()) -> str:

	f"{file1}'s lenth are not the same as in the golden file lenght. "
	f"{file1}'s lenth is not the same as the golden file. "

	LOGGER.warning(f"Unexpected error: {git_root}", exc_info=e)
	LOGGER.warning(f"Unexpected error while trying to get git_hash. Exceuted in: {git_root}", exc_info=e)

Conversation

MaximilianSoerenPollak commented Aug 13, 2025

Uh oh!

MaximilianSoerenPollak commented Aug 13, 2025

Uh oh!

github-actions Bot commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions Bot commented Aug 13, 2025

Uh oh!

AlexanderLanin commented Aug 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MaximilianSoerenPollak commented Aug 14, 2025

Uh oh!

MaximilianSoerenPollak commented Aug 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MaximilianSoerenPollak commented Aug 14, 2025

Uh oh!

MaximilianSoerenPollak commented Aug 14, 2025

Uh oh!

MaximilianSoerenPollak commented Aug 14, 2025

Uh oh!

MaximilianSoerenPollak commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented Aug 13, 2025 •

edited

Loading

MaximilianSoerenPollak commented Aug 14, 2025 •

edited

Loading