docs: update to supported formats by PiotrKorkus · Pull Request #124 · eclipse-score/lifecycle

PiotrKorkus · 2026-03-18T13:08:24Z

Markdown files were not included in documentation and not rendered anywhere
Relative links markdown files were reporting errors in docs_combo_build in reference_integration
.uxf is not supported by sphinx-needs

Please double check diagrams, as I used AI to convert them into PlantUML and they were not rendered anywhere for comparison.

Bugfix

Important

Use this template only for bugfixes that do not influence topics covered by contribution requests or improvements.

Caution

Make sure to submit your pull-request as Draft until you are ready to have it reviewed by the Committers.

Description

[A short description of the bug being fixed by the contribution.]

Related ticket

Important

Please replace [ISSUE-NUMBER] with the issue-number that tracks this bug fix. If there is no such
ticket yet, create one via this issue template.

closes [ISSUE-NUMBER] (bugfix ticket)

- move md to rst - regenerate diagrams in plantuml

github-actions · 2026-03-18T13:09:15Z

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.4.2) and connecting to it...
INFO: Invocation ID: c32a3492-fd44-449b-b73c-880ff4634e9d
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
WARNING: For repository 'score_rust_policies', the root module requires module version score_rust_policies@0.0.3, but got score_rust_policies@0.0.5 in the resolved dependency graph. Please update the version in your MODULE.bazel or set --check_direct_dependencies=off
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: 
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 (57 packages loaded, 9 targets configured)

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

Analyzing: target //:license-check (145 packages loaded, 1975 targets configured)

Analyzing: target //:license-check (153 packages loaded, 5099 targets configured)

Analyzing: target //:license-check (154 packages loaded, 5922 targets configured)

Analyzing: target //:license-check (165 packages loaded, 7899 targets configured)

Analyzing: target //:license-check (165 packages loaded, 7901 targets configured)

Analyzing: target //:license-check (165 packages loaded, 7901 targets configured)

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

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

Analyzing: target //:license-check (169 packages loaded, 9913 targets configured)

INFO: Analyzed target //:license-check (170 packages loaded, 10039 targets configured).
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions running)
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
INFO: Found 1 target...
[16 / 16] no actions running
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 26.440s, Critical Path: 2.67s
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>]

github-actions · 2026-03-18T13:12:53Z

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

pawelrutkaq · 2026-03-18T13:36:52Z

@NicolasFussberger / @SimonKozik can you have a look

NicolasFussberger · 2026-03-25T06:41:35Z


   module/*/index
+   module/lifecycle_client_lib/lifecycle
+   module/lifecycle_client_lib/lifecyclemanager


I think we should introduce a subfolder for launch_manager here inbetween.
Otherwise, these lifecycle_client_lib APIs are visible at the top-level:

NicolasFussberger · 2026-03-25T06:48:39Z

+}
+
+App --|> mwApp : <<uses>>
+App --> LifecycleManager : manages (run, terminate)


direction of the arrow is wrong

NicolasFussberger · 2026-03-25T06:50:05Z

+class "Application Context" as AppCtx #0000FF {
+}
+
+App --|> mwApp : <<uses>>


original diagram says App --> mwApp : implements
and it is not an inheritance arrow but an implements arrow

NicolasFussberger · 2026-03-25T06:50:13Z

+
+LifecycleManager --> ExecMgr : reports state (run, terminate)
+LifecycleManager --> OS : handles application SIGTERM
+


The original diagram also depicted this link:

ExecMgr --> LifecycleManager : handles application SIGTERM

NicolasFussberger · 2026-03-25T06:50:47Z

+LifecycleManager --> ExecMgr : reports state (run, terminate)
+LifecycleManager --> OS : handles application SIGTERM
+
+AppCtx --> ExecMgr : starts


The direction of the arrow is wrong

NicolasFussberger · 2026-03-25T06:52:56Z

+  mw::lifecycle
+end note
+
+@enduml


@PiotrKorkus would you be so kind to check the other diagrams first?
It seems the AI conversion introduced a bunch of errors.
You can use umlet-standalone to view the original uxf diagrams

PiotrKorkus · 2026-03-25T08:16:06Z

Hi @NicolasFussberger,

thanks for checking those diagrams. Those changes are needed for reference_integration build as lifecycle blocks building its documentation there.
I will be able to update this PR next week the earliest, so if you could take over this PR that is more than welcome to unblock reference_integration.

NicolasFussberger · 2026-03-26T06:16:38Z

Hi @NicolasFussberger,

thanks for checking those diagrams. Those changes are needed for reference_integration build as lifecycle blocks building its documentation there. I will be able to update this PR next week the earliest, so if you could take over this PR that is more than welcome to unblock reference_integration.

We discussed in the last lifecycle meeting that @jaakkoaho will have a look at these changes.

jaakkomaho · 2026-04-20T06:46:25Z

+.. uml:: model/lifecycle_system_view.puml
+   :caption: Lifecycle Manager Application Overview
+
+AAS Interfaces


This is relics of Adaptive Autosar world, this can be removed

jaakkomaho · 2026-04-20T06:49:55Z

+* Access persistent storage to read/lookup configuration
+* Search for/start searching for other service instances to be used to provide application services
+
+  * Note: These operations must not be performed in a blocking manner! Otherwise the predefined maximum amount of time to be spent in machine state ``Initializing`` might be exceeded and the ECU will restart immediately once that becomes the case.


time to be spent in machine state Initializing might be exceeded and the ECU will restart immediately once that becomes the case.

This is quite fuzzy and may indicate a project specific behavior

jaakkomaho · 2026-04-20T06:54:36Z

+Introduction
+------------
+
+Purpose of ``score::mw::lifecycle::LifecycleManager`` component is to have a layer of abstraction, that unifies API, for execution managers.


execution managers

Is an ARA term, maybe some other wording would be better here? (application lauch manager)?

jaakkomaho · 2026-04-20T06:57:33Z

+POSIX signals
+~~~~~~~~~~~~~
+
+SIGTERM


I think the implementation also blocks all other signals than the SIGTERM. I think it would be good to check if this still the case and document it here

jaakkomaho · 2026-04-20T07:04:36Z

+
+class "mw:LifecycleManager" as LifecycleManager #FFFF00
+
+class "Execution Manager" as ExecMgr


Execution Manager is an ARA term, I guess this should be changed

docs: update to supported formats

6587a33

- move md to rst - regenerate diagrams in plantuml

PiotrKorkus had a problem deploying to workflow-approval March 18, 2026 13:08 — with GitHub Actions Failure

PiotrKorkus requested a review from pawelrutkaq March 18, 2026 13:09

NicolasFussberger requested changes Mar 25, 2026

View reviewed changes

PiotrKorkus linked an issue Mar 25, 2026 that may be closed by this pull request

Names of modules' index and single index per module. eclipse-score/reference_integration#151

Closed

jaakkomaho reviewed Apr 20, 2026

View reviewed changes


		LifecycleManager --> ExecMgr : reports state (run, terminate)
		LifecycleManager --> OS : handles application SIGTERM


		class "mw:LifecycleManager" as LifecycleManager #FFFF00

		class "Execution Manager" as ExecMgr

Conversation

PiotrKorkus commented Mar 18, 2026

Bugfix

Description

Related ticket

Uh oh!

github-actions bot commented Mar 18, 2026

License Check Results

Uh oh!

github-actions bot commented Mar 18, 2026

Uh oh!

pawelrutkaq commented Mar 18, 2026

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!

PiotrKorkus commented Mar 25, 2026

Uh oh!

NicolasFussberger commented Mar 26, 2026

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!

jaakkomaho Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

jaakkomaho Apr 20, 2026 •

edited

Loading