Skip to content

Commit dc031be

Browse files
attifunelpahmann
attifunel
and
pahmann
authored
issue_2501_addition_of_missing_safety_docs_templates (#574)
Co-authored-by: Philipp Ahmann <[email protected]>
1 parent 55cfdcc commit dc031be

File tree

29 files changed

+741
-389
lines changed

29 files changed

+741
-389
lines changed

‎MODULE.bazel‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ bazel_dep(name = "rules_pkg", version = "1.1.0")
2929
# Python version
3030
#
3131
###############################################################################
32-
bazel_dep(name = "rules_python", version = "1.4.1")
32+
bazel_dep(name = "rules_python", version = "1.8.3")
3333

3434
PYTHON_VERSION = "3.12"
3535

‎process/folder_templates/features/feature_name/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
:id: doc__feature_name
2424
:status: draft
2525
:safety: ASIL_B
26-
:security: NO
26+
:security: YES
2727
:realizes: wp__feat_request
2828
:tags: template
2929

@@ -33,7 +33,7 @@
3333
- Modify ``document`` to be your Feature Name
3434
- Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__``
3535
- Adjust ``status`` to be ``valid``
36-
- Adjust ``safety`` and ``tags`` according to your needs
36+
- Adjust ``safety``, ``security`` and ``tags`` according to your needs
3737

3838
Feature flag
3939
============

‎process/folder_templates/features/feature_name/requirements/index.rst‎

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
# SPDX-License-Identifier: Apache-2.0
1313
# *******************************************************************************
1414
15-
Requirements
16-
############
15+
Feature Requirements
16+
####################
1717

1818
.. document:: [Your Feature Name] Requirements
1919
:id: doc__feature_name_requirements
@@ -34,25 +34,14 @@ Requirements
3434
<Headlines (for the list of requirements if structuring is needed)>
3535
===================================================================
3636

37-
.. stkh_req:: Template
38-
:id: stkh_req__requirements__template
39-
:reqtype: Non-Functional
40-
:safety: ASIL_B
41-
:security: YES
42-
:rationale: Exists just for the template example
43-
:status: invalid
44-
45-
The platform shall ...
46-
47-
.. attention::
48-
The above stakeholder requirement must be removed, it just serves as a link target for this template.
49-
5037
.. feat_req:: Some Title
5138
:id: feat_req__feature_name__some_title
5239
:reqtype: Process
53-
:security: YES
40+
:security: NO
5441
:safety: ASIL_B
5542
:satisfies: stkh_req__requirements__template
43+
:valid_from: v0.0.1
44+
:valid_until: v1.0.1
5645
:status: invalid
5746
:belongs_to: feat__feature_name
5847

@@ -63,7 +52,7 @@ Requirements
6352
.. aou_req:: Some Other Title
6453
:id: aou_req__feature_name__some_other_title
6554
:reqtype: Process
66-
:security: YES
55+
:security: NO
6756
:safety: ASIL_B
6857
:status: invalid
6958

@@ -73,8 +62,13 @@ Requirements
7362
The above directives must be updated according to your feature requirements.
7463

7564
- Replace the example content by the real content for your first requirement (according to :need:`gd_guidl__req_engineering`)
76-
- Set the status to valid and start the review/merge process
65+
- Set ``belongs_to`` with a link to feature ID
66+
- Set ``reqtype`` with a link to the right value (<Functional|Interface|Process|Non-Functional>)
67+
- Set ``satisfies`` with a link to the right stakeholder requirement
68+
- Adjust ``safety`` and ``security`` to the right value (ASIL B/QM; YES/NO)
7769
- Add other needed requirements for your feature
70+
- Adjust ``valid_from`` and ``valid_until`` to the right version numbers
71+
- Set ``status`` to ``valid`` and start the review/merge process
7872

7973
.. needextend:: docname is not None and "feature_name" in id
8074
:+tags: feature_name

‎process/folder_templates/modules/module_name/component_name/docs/requirements/index.rst‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Requirements
1919
:id: doc__component_name_requirements
2020
:status: draft
2121
:safety: ASIL_B
22-
:security: NO
22+
:security: YES
2323
:realizes: wp__requirements_comp
2424
:tags: template
2525

@@ -29,7 +29,7 @@ Requirements
2929
- Modify ``Your Component Name`` to be your Component Name
3030
- Modify ``id`` to be your Component Name in upper snake case preceded by ``doc__`` and followed by ``_requirements``
3131
- Adjust ``status`` to be ``valid``
32-
- Adjust ``safety`` and ``tags`` according to your needs
32+
- Adjust ``safety``, ``security`` and ``tags`` according to your needs
3333

3434
<Headlines (for the list of requirements if structuring is needed)>
3535
===================================================================
@@ -54,6 +54,9 @@ Component Requirements
5454
The above directive must be updated according to your component requirements.
5555

5656
- Replace the example content by the real content for your first requirement
57+
- Set ``satistifes`` with links to Feature requirements
58+
- Set ``belongs_to`` with a link to the right Component id
59+
- Set ``safety`` and ``security`` to the right value
5760
- Set the status to valid and start the review/merge process
5861
- Add other needed requirements for your component
5962

@@ -67,7 +70,7 @@ Assumption of Use Requirements
6770
:safety: ASIL_B
6871
:status: invalid
6972

70-
The Component User shall do xyz to use the component safely
73+
The Component User shall do xyz to use the component safely/securely
7174

7275
Environmental Requirements
7376
--------------------------
@@ -89,8 +92,10 @@ Hints
8992
The above directives must be updated according to your feature requirements.
9093

9194
- Replace the example content by the real content for your first requirement (according to :need:`gd_guidl__req_engineering`)
92-
- Set the status to valid and start the review/merge process
95+
- Set ``safety`` and ``security`` to the right value (ASIL B/QM; YES/NO)
96+
- Set ``reqtype`` with a link to the right value (<Functional|Interface|Process|Non-Functional>)
9397
- Add other needed requirements for your feature
98+
- Set ``status`` to ``valid`` and start the review/merge process
9499

95100
.. needextend:: "component_name" in id
96101
:+tags: component_name

‎process/folder_templates/modules/module_name/docs/release/release_note.rst‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,6 @@ Release Note
122122
| Contributor 1
123123
| Contributor 2
124124
|
125-
126-
---
127-
128125
| Contact Information
129126
| -------------------
130127
|

‎process/folder_templates/modules/module_name/docs/security_mgt/index.rst‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
..
2-
# *******************************************************************************
3-
# Copyright (c) 2025 Contributors to the Eclipse Foundation
4-
#
5-
# See the NOTICE file(s) distributed with this work for additional
6-
# information regarding copyright ownership.
7-
#
8-
# This program and the accompanying materials are made available under the
9-
# terms of the Apache License Version 2.0 which is available at
10-
# https://www.apache.org/licenses/LICENSE-2.0
11-
#
12-
# SPDX-License-Identifier: Apache-2.0
13-
# *******************************************************************************
14-
15-
Security Management
16-
###################
17-
18-
.. toctree::
19-
:titlesonly:
20-
21-
module_security_plan
22-
module_security_plan_fdr
23-
module_security_package_fdr
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2026 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
Security Management
16+
###################
17+
18+
.. toctree::
19+
:titlesonly:
20+
21+
module_security_plan
22+
module_security_plan_fdr
23+
module_security_package_fdr

‎process/folder_templates/modules/module_name/docs/verification/module_verification_report.rst‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ Verification Report
3333
- Adjust ``status`` to be ``valid``
3434
- Adjust ``safety`` and ``tags`` according to your needs
3535

36-
3736
This verification report is based on the :need:`gd_temp__verification_plan`.
3837
It covers all the components of the above stated module.
3938

@@ -86,6 +85,12 @@ Verification Report contains:
8685
**5. Software component qualification verification report**
8786
- Contains the needed verification results if for some components a qualification of pre-developed SW is performed.
8887

88+
**6. Test results**
89+
- Test result per test case with status passed/failed/not_run
90+
91+
**7. Test logs**
92+
- Test log per test case with status passed/failed/not_run
93+
8994
**Note1:** The verification report is valid for the module version tagged together with the report
9095

9196
**Note2:** All the above lists are generated automatically

‎process/folder_templates/platform/docs/release/release_note.rst‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2025 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
Platform Release Note
16+
=====================
17+
18+
.. note:: Document header
19+
20+
.. document:: Platform Release Note
21+
:id: doc__platform_release_note
22+
:status: draft
23+
:safety: ASIL_B
24+
:security: NO
25+
:realizes: wp__platform_sw_release_note
26+
:tags: template
27+
28+
.. attention::
29+
The above directive must be updated.
30+
31+
- Adjust ``status`` to be ``valid``
32+
- Adjust ``safety`` and ``tags`` according to your needs
33+
34+
35+
36+
| Release Tag: vX.Y.Z
37+
| Origin Release Tag: vU.V.W
38+
| Release Commit Hash: a1b2c3d4e5f6g7h8i9j0
39+
| Release Date: YYYY-MM-DD
40+
| Safety: [QM | ASIL_B]
41+
| Security: [NO | YES]
42+
|
43+
| Overview
44+
| --------
45+
|
46+
| This document provides an overview of the changes, improvements, and bug fixes included in the software platform release version vX.Y.Z
47+
| as compared to the platform's origin release (which is usually the previous release).
48+
|
49+
| Disclaimer
50+
| ----------
51+
| This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment.
52+
| The work products compiled in the safety package are created with care according to a process satisfying standards, but the as the project,
53+
| being a non-profit and open source organization, can not take over any liability for its content.
54+
|
55+
| New Features
56+
| ------------
57+
|
58+
| - **Feature 1**: Brief description of the new feature.
59+
| - **Feature 2**: Brief description of the new feature.
60+
| - **Feature 3**: Brief description of the new feature.
61+
|
62+
| Improvements
63+
| ------------
64+
|
65+
| - **Improvement 1**: Brief description of the improvement.
66+
| - **Improvement 2**: Brief description of the improvement.
67+
| - **Improvement 3**: Brief description of the improvement.
68+
|
69+
| Bug Fixes
70+
| ---------
71+
|
72+
| - **Bug 1**: Brief description of the bug fix.
73+
| - **Bug 2**: Brief description of the bug fix.
74+
| - **Bug 3**: Brief description of the bug fix.
75+
|
76+
| Other changes by Label
77+
| ----------------------
78+
|
79+
| - **Label 1/Refactor 1**: Brief description of the change.
80+
| - **Label 2/Refactor 2**: Brief description of the change.
81+
| - **Label 3/Refactor 3**: Brief description of the change.
82+
|
83+
| Compatibility
84+
| -------------
85+
|
86+
| - **Dependencies**: List any dependencies and their versions.
87+
|
88+
| Performed Verification
89+
| ----------------------
90+
| This release note is based on the verification as documented in platform verification report
91+
| :need:`doc__platform_verification_report`.
92+
|
93+
| Known Issues
94+
| ------------
95+
|
96+
| - **Issue 1**: Brief description of the known issue. Justification regarding safety impact.
97+
| - **Issue 2**: Brief description of the known issue. Justification regarding safety impact.
98+
| - **Issue 3**: Brief description of the known issue. Justification regarding safety impact.
99+
|
100+
| Known Vulnerabilities
101+
| ---------------------
102+
|
103+
| - **CVE 1**: Brief description of the known CVE. Justification regarding security impact.
104+
| - **CVE 2**: Brief description of the known CVE. Justification regarding security impact.
105+
| - **CVE 3**: Brief description of the known CVE. Justification regarding security impact.
106+
|
107+
| Upgrade Instructions
108+
| --------------------
109+
|
110+
| 1. **Step 1**: Description of the first step.
111+
| 2. **Step 2**: Description of the second step.
112+
| 3. **Step 3**: Description of the third step.
113+
|
114+
| Contributors
115+
| ------------
116+
|
117+
| Thanks to everyone who contributed to this release:
118+
|
119+
| Contributor 1
120+
| Contributor 2
121+
|

‎process/folder_templates/platform/docs/safety_mgt/index.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
..
2+
# *******************************************************************************
3+
# Copyright (c) 2026 Contributors to the Eclipse Foundation
4+
#
5+
# See the NOTICE file(s) distributed with this work for additional
6+
# information regarding copyright ownership.
7+
#
8+
# This program and the accompanying materials are made available under the
9+
# terms of the Apache License Version 2.0 which is available at
10+
# https://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# SPDX-License-Identifier: Apache-2.0
13+
# *******************************************************************************
14+
15+
Safety Management
16+
#################
17+
18+
.. toctree::
19+
:titlesonly:
20+
21+
platform_dfa
22+
platform_safety_manual
23+
platform_safety_plan_fdr
24+
platform_safety_package_fdr
25+
platform_safety_analysis_fdr
26+
platform_safety_plan

process/folder_templates/platform/safety_analysis/platform_dfa.rst renamed to process/folder_templates/platform/docs/safety_mgt/platform_dfa.rst

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,6 @@ Platform DFA (Dependent Failure Analysis)
2929

3030
.. note:: Use the content of the document to describe e.g. why a fault model is not applicable for the diagram.
3131

32-
.. attention::
33-
The above directive must be updated according to your Feature.
34-
35-
- Modify ``Your Feature Name`` to be your Feature Name
36-
- Modify ``id`` to be your Feature Name in upper snake case preceded by ``doc__`` and succeeded by ``_dfa``
37-
- Adjust ``status`` to be ``valid``
38-
- Adjust ``safety`` and ``tags`` according to your needs
3932

4033
Dependent Failure Initiators
4134
----------------------------
@@ -44,10 +37,10 @@ Dependent Failure Initiators
4437
4538
.. plat_saf_dfa:: <Title>
4639
:violates: <Feature architecture>
47-
:id: plat_saf_DFA__<Feature>__<Element descriptor>
40+
:id: plat_saf_DFA__Platform__<Element descriptor>
4841
:failure_id: <ID from DFA failure initiators :need:`gd_guidl__dfa_failure_initiators`>
4942
:failure_effect: "description of failure effect of the failure initiator on the element"
50-
:mitigated_by: <ID from Feature Requirement | ID from AoU Feature Requirement>
43+
:mitigated_by: <ID from Stakeholder Requirement | ID from AoU Feature Requirement>
5144
:mitigation_issue: <ID from Issue Tracker>
5245
:sufficient: <yes|no>
5346
:status: <valid|invalid>

0 commit comments

Comments
 (0)