Include all templates for documentation by PandaeDo · Pull Request #62 · eclipse-score/inc_security_crypto

PandaeDo · 2026-06-29T11:30:44Z

Include all templates from module_templates. With this we can setup the documentation. Please copy the component_example under score/ for every component when you want to start documentation

github-actions · 2026-06-29T11:31:10Z

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.3.0) and connecting to it...
INFO: Invocation ID: ee8fca96-37bd-413c-ab55-13adf35e3c85
Computing main repo mapping: 
Computing main repo mapping: 
DEBUG: Rule 'abseil-cpp+' indicated that a canonical reproducible form can be obtained by modifying arguments integrity = "sha256-m3oGQwXp/ZTRJP+mzDWFkutCtdpYj7TgfQklSqQAhts="
DEBUG: Repository abseil-cpp+ instantiated at:
  <builtin>: in <toplevel>
Repository rule http_archive defined at:
  /home/runner/.bazel/external/bazel_tools/tools/build_defs/repo/http.bzl:394:31: in <toplevel>
Computing main repo mapping: 
Computing main repo mapping: 
DEBUG: Rule 'grpc+' indicated that a canonical reproducible form can be obtained by modifying arguments integrity = "sha256-CvN7gAlTEwtHwHW1ZoPuYL3D7aPDf8YAQZP1tWl1ggQ="
DEBUG: Repository grpc+ instantiated at:
  <builtin>: in <toplevel>
Repository rule http_archive defined at:
  /home/runner/.bazel/external/bazel_tools/tools/build_defs/repo/http.bzl:394:31: in <toplevel>
DEBUG: Rule 'protobuf+' indicated that a canonical reproducible form can be obtained by modifying arguments integrity = "sha256-w6Cp7OiTLjHDtzbi2xixxC5wcM2biBOIsm0BqnHiTKI="
DEBUG: Repository protobuf+ instantiated at:
  <builtin>: in <toplevel>
Repository rule http_archive defined at:
  /home/runner/.bazel/external/bazel_tools/tools/build_defs/repo/http.bzl:394:31: in <toplevel>
Computing main repo mapping: 
Loading: 
Loading: 1 packages loaded
Loading: 1 packages loaded
    currently loading: 
Loading: 1 packages loaded
    currently loading: 
WARNING: Target pattern parsing failed.
ERROR: Skipping '//:license-check': no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/inc_security_crypto/inc_security_crypto/BUILD
ERROR: no such target '//:license-check': target 'license-check' not declared in package '' defined by /home/runner/work/inc_security_crypto/inc_security_crypto/BUILD
INFO: Elapsed time: 9.542s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

github-actions · 2026-06-29T11:37:32Z

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

sunildevda · 2026-06-29T13:52:53Z

@PandaeDo this is wonderful that you picked it up :) we were planning to do this in coming days. will have a look and give my points.
CC : @GuruprasadBhatL

masc2023 · 2026-07-01T05:34:23Z

+   .. comp:: Crypto
+      :id: comp__crypto
+      :security: YES
+      :safety: QM


Depends, where the components are called from, as part of communication may safety relevant

PandaeDo · 2026-07-02T06:35:22Z

@copilot resolve the merge conflicts in this pull request

sunildevda

@PandaeDo i checked against the latest module templates i see here and found some points that i have noted in various files. is my reference correct or i need to check against something else?

sunildevda · 2026-07-02T17:49:40Z

@@ -0,0 +1,124 @@
+..


content looks to be different to the current latest version mentioned here: https://github.com/eclipse-score/module_template/blob/main/score/component_example/docs/architecture/component_architecture.rst ?

sunildevda · 2026-07-02T17:51:49Z

@@ -0,0 +1,162 @@
+..
+   # *******************************************************************************


conent looks to be different when compared to https://github.com/eclipse-score/module_template/blob/main/score/component_example/docs/architecture/index.rst ?

sunildevda · 2026-07-02T17:53:59Z

@@ -0,0 +1,42 @@
+..
+   # *******************************************************************************


contents seems to be different to https://github.com/eclipse-score/module_template/blob/main/score/component_example/docs/detailed_design/detailed_design_example.rst ?

sunildevda · 2026-07-02T17:55:18Z

@@ -0,0 +1,104 @@
+..


content seems to be different from https://github.com/eclipse-score/module_template/blob/main/score/component_example/docs/detailed_design/index.rst ?

sunildevda · 2026-07-02T17:55:56Z

@@ -0,0 +1,111 @@
+..


contents does not match with https://github.com/eclipse-score/module_template/blob/main/score/component_example/docs/requirements/index.rst

sunildevda · 2026-07-02T18:10:44Z

@@ -0,0 +1,154 @@
+..


information is not same as https://github.com/eclipse-score/module_template/blob/main/docs/features/feature_example/architecture/index.rst. intentional?

sunildevda · 2026-07-02T18:12:09Z

+   # SPDX-License-Identifier: Apache-2.0
+   # *******************************************************************************
+
+AoU Feature Requirements Template


contents dont match to https://github.com/eclipse-score/module_template/blob/e177d146a39d8330ccc1557080534f3e058535a2/docs/features/feature_example/safety_analysis/aou_requirements.rst?plain=1#L18-L35

sunildevda · 2026-07-02T18:14:08Z

@@ -0,0 +1,145 @@
+..


this file seems to be missing here: https://github.com/eclipse-score/module_template/tree/main/docs/features/feature_example/security_analysis ?

sunildevda · 2026-07-02T18:15:43Z

+
+.. toctree::
+   :titlesonly:
+


user manual is missing: https://github.com/eclipse-score/module_template/blob/main/docs/manuals/user_manual.rst

sunildevda · 2026-07-02T18:17:40Z

+        * - :need:`wp__fdr_reports` (module's Safety Analyses & DFA)
+          - :need:`gd_chklst__safety_analysis`
+          - :ndf:`copy('status', need_id='gd_chklst__safety_analysis')`
+          - <Link to WP>


WP link mentioned here is not added: https://github.com/eclipse-score/module_template/blob/e177d146a39d8330ccc1557080534f3e058535a2/docs/safety_mgt/module_safety_plan.rst?plain=1#L113

PandaeDo · 2026-07-03T06:28:24Z

@PandaeDo i checked against the latest module templates i see here and found some points that i have noted in various files. is my reference correct or i need to check against something else?

@sunildevda Hey Sunil. It was correct when I created the PR... In between there where several changes which also impacts other modules. Really appreciate your effort. Looking forward to have versioning everywhere so we will be automatically notified if there are changes. For now I will close this PR and create a new one with the new content of module_templates.

initial setup documents

d082923

PandaeDo added 2 commits June 29, 2026 13:33

fix error

3c23de2

fix build errors

766c3a1

PandaeDo force-pushed the vohae_docu_structure branch from f63f13d to 766c3a1 Compare June 29, 2026 11:36

PandaeDo added 3 commits June 29, 2026 13:41

update bazel lockfile

7a7d603

update dependencies

4045869

update bazel lock

5543926

PandaeDo requested review from ChansAlive and sunildevda June 29, 2026 13:11

masc2023 reviewed Jul 1, 2026

View reviewed changes

fix bazel.lock

7a738b9

sunildevda reviewed Jul 2, 2026

View reviewed changes

PandaeDo closed this Jul 3, 2026

		@@ -0,0 +1,162 @@
		..
		# *******************************************************************************

		@@ -0,0 +1,42 @@
		..
		# *******************************************************************************

Uh oh!

Conversation

PandaeDo commented Jun 29, 2026

Uh oh!

github-actions Bot commented Jun 29, 2026 • 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 Jun 29, 2026

Uh oh!

sunildevda commented Jun 29, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PandaeDo commented Jul 2, 2026

Uh oh!

sunildevda left a comment

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!

PandaeDo commented Jul 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Jun 29, 2026 •

edited

Loading