issue_2501_addition_of_missing_safety_docs_templates #574
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,23 +1,23 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # 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 | ||
| # ******************************************************************************* | ||
| Security Management | ||
| ################### | ||
| .. toctree:: | ||
| :titlesonly: | ||
| module_security_plan | ||
| module_security_plan_fdr | ||
| module_security_package_fdr |
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 |
|---|---|---|
| @@ -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 | ||
|
Contributor
There was a problem hiding this comment. In general, why did you remove Security: YES and let safety to ASIL_B? Please set both so user must actively set NO or QM, if needed. Not everything is safety: ASIL_B by default.
Contributor
Author
There was a problem hiding this comment. In other templates it is always Safety ASIL B, security NO. In general this is just an example, I added a specific request below to set the required values
Contributor
Author
There was a problem hiding this comment. Anyway I think I fixed |
||
| :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 | ||
| | | ||
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 | ||
aschemmel-tech marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| ################# | ||
|
|
||
| .. 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
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.
Uh oh!
There was an error while loading. Please reload this page.