Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,8 @@ python.toolchain(
#
###############################################################################
bazel_dep(name = "score_docs_as_code", version = "4.4.1")
git_override(
module_name = "score_docs_as_code",
commit = "4090f017f935899b15ea3d0b2649b359ee6a72d8",
remote = "https://github.com/eclipse-score/docs-as-code.git",
)
2 changes: 0 additions & 2 deletions MODULE.bazel.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

243 changes: 122 additions & 121 deletions process/folder_templates/platform/docs/release/release_note.rst
Original file line number Diff line number Diff line change
@@ -1,121 +1,122 @@
..
# *******************************************************************************
# 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


| **Platform Name:** <Your platform name>
| **Release Tag:** vX.Y.Z
| **Origin Release Tag:** vU.V.W
| **Release Date:** YYYY-MM-DD

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.

Changes to the Platform
^^^^^^^^^^^^^^^^^^^^^^^

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.

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.

Platform Scope
^^^^^^^^^^^^^^

- **Version:** <Version number of delivery container>
- **Source / tag:** <Link to archived artefacts>
- **Release notes:** <Link to delivery container's release notes>

Integrated Software Modules
---------------------------

<Module Name>
~~~~~~~~~~~~~

<brief description>

- **Version:** <Version number of delivery container>
- **Source / tag:** <Link to archived artefacts>
- **Release notes:** <Link to delivery container's release notes>


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/Vulnerabilities and Bug Fixes
------------------------------------------

- see release notes of every module separately


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.

For any questions or support, please contact the *Project lead* or raise an issue/discussion.
..
# *******************************************************************************
# 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
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__platform_sw_release_note[version==1]
:tags: template

.. attention::
The above directive must be updated.

- Adjust ``status`` to be ``valid``
- Adjust ``safety`` and ``tags`` according to your needs


| **Platform Name:** <Your platform name>
| **Release Tag:** vX.Y.Z
| **Origin Release Tag:** vU.V.W
| **Release Date:** YYYY-MM-DD

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.

Changes to the Platform
^^^^^^^^^^^^^^^^^^^^^^^

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.

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.

Platform Scope
^^^^^^^^^^^^^^

- **Version:** <Version number of delivery container>
- **Source / tag:** <Link to archived artefacts>
- **Release notes:** <Link to delivery container's release notes>

Integrated Software Modules
---------------------------

<Module Name>
~~~~~~~~~~~~~

<brief description>

- **Version:** <Version number of delivery container>
- **Source / tag:** <Link to archived artefacts>
- **Release notes:** <Link to delivery container's release notes>


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/Vulnerabilities and Bug Fixes
------------------------------------------

- see release notes of every module separately


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.

For any questions or support, please contact the *Project lead* or raise an issue/discussion.
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ Platform DFA (Dependent Failure Analysis)
.. document:: Platform DFA
:id: doc__platform_dfa
:status: draft
:version: 1
:safety: ASIL_B
:security: NO
:realizes: wp__platform_dfa
:realizes: wp__platform_dfa[version==1]
:tags: template

.. note:: The platform DFA is only performed once at platform level to analyse the dependencies between the features of the platform.
Expand Down Expand Up @@ -268,6 +269,7 @@ For all identified applicable failure initiators, the DFA is performed in the fo
:mitigation_issue: <ID from Issue Tracker>
:sufficient: <yes|no>
:status: <valid|invalid>
:version: 1
.. note:: Argument is inside the 'content'. Therefore content is mandatory.

.. attention::
Expand Down
Loading
Loading