-
Notifications
You must be signed in to change notification settings - Fork 20
issue_2501_addition_of_missing_safety_docs_templates #574
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
attifunel
wants to merge
36
commits into
eclipse-score:main
Choose a base branch
from
attifunel:attifunel_missing_safety_docs_templates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
36 commits
Select commit
Hold shift + click to select a range
64933d4
2501 attifunel: added missing templates
attifunel f15c6d4
2501 attifunel: added missing templates
attifunel 6548948
2501 attifunel: fixed index errors
attifunel fabd70c
2501 attifunel fixed hopefully last index error
attifunel 7a74e1b
issue 2501 attifunel fixed TOC conflict
attifunel 0e54cb9
Fix build issues created during merge
pahmann 0c2c356
issue 574 attifunel fixed comments from review
attifunel 97298f7
issue 2501 attifunel fixed TOC problem
attifunel 5b6a3f0
issue 2501 attifunel fixed python version in bazel file
attifunel ed6cc64
issue 2501 attifunel fixed missing link
attifunel 3bb6966
issue 2501 attifunel fixing "platform name"-type link
attifunel 4fb3d34
issue 2501 attifunel fixed further comments
attifunel 422dce0
2501 attifunel fixed further review comments
attifunel 987e20e
2501 attifunel: fixed build errors
attifunel a4c8721
2501 attifunel fixed errors and further comments
attifunel 72755c3
2501 attifunel try to fix again ref error
attifunel 5b9d554
2501 attifunel try to fix again ref error
attifunel e0c3d0b
2501 attifunel fixed duplicate ver. rep. templates
attifunel d1d955e
2501 attifunel fixed duplicate ver. rep. templates
attifunel 77ca7ed
2501 fix links from guidance to templates
attifunel e315dde
2501 fixing wrong links again
attifunel 7c3662c
2501 fixing further indent problems
attifunel f88b151
2501 fixing further indent and links problems
attifunel 919dc34
2501 fixed copypaste error
attifunel e644491
2501 fixing wrong doc id
attifunel 8af722f
2501 fixing ambiguity in Safety Analyses
attifunel c947aaa
2501 some fixes at verification report template
attifunel 82b1737
2501 fixed indent error
attifunel f34ceda
fixing merging conflicts + further comments
attifunel 37f3368
fixed header subtitle in RN
attifunel 369d7c1
fixed subtitle
attifunel b0185c0
fixed duplicate header
attifunel 7871058
fixing indentation
attifunel 42cc947
fixing indentation
attifunel a10598f
trying to fix indent issues
attifunel e1fd4a0
restored 6. and 7. of module verification report
attifunel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -122,9 +122,6 @@ Release Note | |
| | Contributor 1 | ||
| | Contributor 2 | ||
| | | ||
|
|
||
| --- | ||
|
|
||
| | Contact Information | ||
| | ------------------- | ||
| | | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
121 changes: 121 additions & 0 deletions
121
process/folder_templates/platform/docs/release/release_note.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2025 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Platform Release Note | ||
| ===================== | ||
|
|
||
| .. note:: Document header | ||
|
|
||
| .. document:: Platform Release Note | ||
| :id: doc__platform_release_note | ||
| :status: draft | ||
| :safety: ASIL_B | ||
| :security: NO | ||
| :realizes: wp__platform_sw_release_note | ||
| :tags: template | ||
|
|
||
| .. attention:: | ||
| The above directive must be updated. | ||
|
|
||
| - Adjust ``status`` to be ``valid`` | ||
| - Adjust ``safety`` and ``tags`` according to your needs | ||
|
|
||
|
|
||
|
|
||
| | Release Tag: vX.Y.Z | ||
| | Origin Release Tag: vU.V.W | ||
| | Release Commit Hash: a1b2c3d4e5f6g7h8i9j0 | ||
| | Release Date: YYYY-MM-DD | ||
| | Safety: [QM | ASIL_B] | ||
| | Security: [NO | YES] | ||
| | | ||
| | Overview | ||
| | -------- | ||
| | | ||
| | This document provides an overview of the changes, improvements, and bug fixes included in the software platform release version vX.Y.Z | ||
| | as compared to the platform's origin release (which is usually the previous release). | ||
| | | ||
| | Disclaimer | ||
| | ---------- | ||
| | This release note does not "release for production", as it does not come with a safety argumentation and a performed safety assessment. | ||
| | The work products compiled in the safety package are created with care according to a process satisfying standards, but the as the project, | ||
| | being a non-profit and open source organization, can not take over any liability for its content. | ||
| | | ||
| | New Features | ||
| | ------------ | ||
| | | ||
| | - **Feature 1**: Brief description of the new feature. | ||
| | - **Feature 2**: Brief description of the new feature. | ||
| | - **Feature 3**: Brief description of the new feature. | ||
| | | ||
| | Improvements | ||
| | ------------ | ||
| | | ||
| | - **Improvement 1**: Brief description of the improvement. | ||
| | - **Improvement 2**: Brief description of the improvement. | ||
| | - **Improvement 3**: Brief description of the improvement. | ||
| | | ||
| | Bug Fixes | ||
| | --------- | ||
| | | ||
| | - **Bug 1**: Brief description of the bug fix. | ||
| | - **Bug 2**: Brief description of the bug fix. | ||
| | - **Bug 3**: Brief description of the bug fix. | ||
| | | ||
| | Other changes by Label | ||
| | ---------------------- | ||
| | | ||
| | - **Label 1/Refactor 1**: Brief description of the change. | ||
| | - **Label 2/Refactor 2**: Brief description of the change. | ||
| | - **Label 3/Refactor 3**: Brief description of the change. | ||
| | | ||
| | Compatibility | ||
| | ------------- | ||
| | | ||
| | - **Dependencies**: List any dependencies and their versions. | ||
| | | ||
| | Performed Verification | ||
| | ---------------------- | ||
| | This release note is based on the verification as documented in platform verification report | ||
| | :need:`doc__platform_verification_report`. | ||
| | | ||
| | Known Issues | ||
| | ------------ | ||
| | | ||
| | - **Issue 1**: Brief description of the known issue. Justification regarding safety impact. | ||
| | - **Issue 2**: Brief description of the known issue. Justification regarding safety impact. | ||
| | - **Issue 3**: Brief description of the known issue. Justification regarding safety impact. | ||
| | | ||
| | Known Vulnerabilities | ||
| | --------------------- | ||
| | | ||
| | - **CVE 1**: Brief description of the known CVE. Justification regarding security impact. | ||
| | - **CVE 2**: Brief description of the known CVE. Justification regarding security impact. | ||
| | - **CVE 3**: Brief description of the known CVE. Justification regarding security impact. | ||
| | | ||
| | Upgrade Instructions | ||
| | -------------------- | ||
| | | ||
| | 1. **Step 1**: Description of the first step. | ||
| | 2. **Step 2**: Description of the second step. | ||
| | 3. **Step 3**: Description of the third step. | ||
| | | ||
| | Contributors | ||
| | ------------ | ||
| | | ||
| | Thanks to everyone who contributed to this release: | ||
| | | ||
| | Contributor 1 | ||
| | Contributor 2 | ||
| | |
26 changes: 26 additions & 0 deletions
26
process/folder_templates/platform/docs/safety_mgt/index.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
| Safety Management | ||
| ################# | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| platform_dfa | ||
| platform_safety_manual | ||
| platform_safety_plan_fdr | ||
| platform_safety_package_fdr | ||
| platform_safety_analysis_fdr | ||
| platform_safety_plan | ||
aschemmel-tech marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
process/folder_templates/platform/docs/safety_mgt/platform_safety_analysis_fdr.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
|
|
||
| Platform Safety Analysis Formal Review Report | ||
| ============================================= | ||
|
|
||
| .. document:: Platform Safety Analysis Formal Review Report | ||
| :id: doc__platform_safety_analysis_fdr | ||
| :status: draft | ||
| :safety: ASIL_B | ||
| :security: YES | ||
| :realizes: wp__fdr_reports | ||
| :tags: template | ||
|
|
||
|
|
||
|
|
||
| **Purpose** | ||
| The purpose of this Safety Analysis (DFA and FMEA) formal review report template is to collect the topics to be checked during verification of the Platform Safety Analysis. | ||
|
|
||
| **Conduct** | ||
| As described in :need:`wf__p_formal_rv`, the formal document review is performed by an "external" safety manager: | ||
|
|
||
| - reviewer: **<committer with safety manager skills explicitly named here>** | ||
|
|
||
| **Checklist** | ||
|
|
||
| Please note that it is mandatory to fill in the "passed" column with "yes" or "no" for each checklist item and additional to add in the remarks why it is passed or not passed. In case of "no" an issue link to the issue tracking system has to be added in the last column. See also :ref:`review_concept` for further information about reviews in general and inspection in particular. | ||
|
|
||
| .. list-table:: Safety Analysis Checklist | ||
| :header-rows: 1 | ||
| :widths: 10,10,30,30,20 | ||
|
|
||
| * - ID | ||
| - Safety analysis activity | ||
| - Compliant to ISO 26262? | ||
| - Reference | ||
| - Comment | ||
|
|
||
| * - 1 | ||
| - Is it plausible that each potential identified dependent failure that has been identified, will lead to a dependent failure which cause a violation of FFI? | ||
| - [YES | NO ] | ||
| - :need:`[[title]] <std_req__iso26262__analysis_742>` | ||
| - <Rationale for result> | ||
|
|
||
| * - 2 | ||
| - Are the failure initiators :need:`[[title]] <gd_guidl__dfa_failure_initiators>` / fault models :need:`[[title]] <gd_guidl__fault_models>` applied? | ||
| - [YES | NO ] | ||
| - :need:`[[title]] <std_req__iso26262__analysis_744>` | ||
| - <Rationale for result> | ||
|
|
||
| * - 3 | ||
| - Are measures defined to resolute the identified potential dependent failures? | ||
| - [YES | NO ] | ||
| - :need:`[[title]] <std_req__iso26262__analysis_746>`, :need:`[[title]] <std_req__iso26262__analysis_747>` | ||
| - <Rationale for result> | ||
|
|
||
| * - 4 | ||
| - Is the result of the safety analysis indicate if the safety requirements are complied? | ||
| - [YES | NO ] | ||
| - :need:`[[title]] <std_req__iso26262__analysis_842>` | ||
| - <Rationale for result> | ||
|
|
||
| * - 5 | ||
| - Are for all not complied safety requirements mitigations defined to resolute the non-compliance? The mitigations shall have a direct influence on the violation by prevention, detection or mitigation to reduce the risk to an acceptable level. | ||
| - [YES | NO ] | ||
| - :need:`[[title]] <std_req__iso26262__analysis_843>` | ||
| - <Rationale for result> | ||
|
|
||
| * - 6 | ||
| - Are the mitigations effective and implemented? | ||
| - [YES | NO ] | ||
| - :need:`[[title]] <std_req__iso26262__analysis_844>` | ||
| - <Rationale for result> | ||
|
|
||
| * - 7 | ||
| - Are the templates for DFA and/or FMEA used? See :ref:`dfa_templates` / :ref:`FMEA_templates` and also :ref:`process_requirements_safety_analysis` | ||
| - [YES | NO ] | ||
| - :need:`[[title]] <std_req__iso26262__analysis_748>`, :need:`[[title]] <std_req__iso26262__analysis_849>`, :need:`[[title]] <std_req__iso26262__analysis_8410>` | ||
| - <Rationale for result> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if you introduce here a new folder, why not move also Safety Planning here Platform DFA, etc. align with Security, that we can have there also a subfolder, Verification Report can stay on top level as well Stakeholder Requirements
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I aligned with Module Directories
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please move the safety Plan template also in this folder?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes please (and delete the old folder "safety_planning")
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmhmhm... Platform safety plan template was embedded in the "index.rst" of the specific directory, something I needed some time to sort out. I removed directory there and created a new file here with the right name
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be compliant with your requests now. Can you check?