prepare release notes for s-core v0.5

Author: antonkri

docs/score_releases/_assets/architecture.drawio.svg

@@ -17,116 +17,7 @@
 S-CORE Releases Overview
 ========================
 
-Roadmap
---------
-Roadmap is a living document.
-
-.. image:: _assets/score_timeline.svg
-   :width: 700
-   :alt: Infrastructure overview
-   :align: center
-
-Overview
---------
-
-.. image:: _assets/architecture.drawio.svg
-   :width: 1000
-   :alt: Infrastructure overview
-   :align: center
-
-SW Module List
---------------
-
-.. list-table:: S-CORE software modules overview
-   :header-rows: 1
-
-   * - SW Module Name
-     - Committer List
-     - Release
-     - Date
-     - Feature (Change) Request
-     - Repo
-     - GitHub Discussions
-   * - IPC
-     - Holger Grandy, Gerd Schäfer, Nico Hartmann, Sven Kappel, Thilo Schmitt
-     - v0.5
-     - Q4
-     - _
-     - `inc_mw_com <https://github.com/eclipse-score/inc_mw_com>`_
-     - `Communication CTF <https://github.com/orgs/eclipse-score/discussions/categories/communication-ft>`_
-   * - Fixed Execution Order Framework (incl. Orchestrator)
-     - Holger Grandy, Gerd Schäfer, Nico Hartmann, Sven Kappel, Thilo Schmitt
-     - v0.5
-     - Q4
-     - _
-     - `inc_feo <https://github.com/eclipse-score/inc_feo>`_
-     - `FEO CTF <https://github.com/orgs/eclipse-score/discussions/categories/feo-ft>`_
-   * - Logging
-     - Holger Grandy, Gerd Schäfer, Nico Hartmann
-     - v0.5
-     - Q4
-     - _
-     - `inc_mw_log <https://github.com/eclipse-score/inc_mw_log>`_
-     - `Logging CTF <https://github.com/orgs/eclipse-score/discussions/categories/logging-ft>`_
-   * - Persistency
-     - Gerd Schäfer, Nico Hartmann, Sven Kappel
-     - v0.5
-     - Q4
-     - _
-     - `inc_mw_per <https://github.com/eclipse-score/inc_mw_per>`_
-     - `Persistency CTF <https://github.com/orgs/eclipse-score/discussions/categories/persistency-ft>`_
-   * - Integration Testing Framework
-     - Holger Grandy
-     - v0.5
-     - Q4
-     - _
-     - _
-     - _
-   * - SOME/IP
-     - _
-     - _
-     - _
-     - _
-     - _
-     - _
-   * - Lifecycle
-     - _
-     - _
-     - _
-     - _
-     - _
-     - _
-   * - Diagnosis
-     - _
-     - _
-     - _
-     - _
-     - _
-     - _
-   * - OS Abstraction Layer
-     - _
-     - _
-     - _
-     - _
-     - _
-     - _
-   * - Time Sync
-     - _
-     - _
-     - _
-     - _
-     - _
-     - _
-   * - Firewall
-     - _
-     - _
-     - _
-     - _
-     - _
-     - _
-
 .. toctree::
-   :hidden:
-   :maxdepth: 2
+   :maxdepth: 1
 
-   platform_release_note
+   score_releases/index.rst

docs/score_releases/_assets/score_release_plan.drawio.svg

@@ -0,0 +1,8 @@
+S-CORE Releases
+===============
+
+
+.. toctree::
+   :maxdepth: 1
+
+   score_v0_5_alpha.rst

docs/score_releases/_assets/score_timeline.svg

@@ -0,0 +1,148 @@
+..
+   # *******************************************************************************
+   # 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
+   # *******************************************************************************
+
+S-Core v0.5-alpha release notes
+===============================
+
+.. document:: S-Core v0.5-alpha release note
+   :id: doc__score_v05_alpha_release_note
+   :status: draft
+   :safety: ASIL_B
+   :realizes: PROCESS_wp__platform_sw_release_note
+
+| **Platform Name**: S-CORE
+| **Release Tag**: v0.5.0-alpha
+| **Origin Release Tag**: none - first published release
+| **Release Commit Hash**: <add hash>
+| **Release Date**: 2025-11-11
+
+Overview
+^^^^^^^^^
+
+This document provides an overview of the changes, improvements, and bug fixes included in the software platform release version v0.5.0-alpha.
+This is the very first release of the **Eclipse S-Core platform**. The software architectue and implemented modules are presented at the image below.
+
+.. image:: ../_assets/architecture.drawio.svg
+   :width: 1000
+   :alt: Architecture overview
+   :align: center
+
+|
+
+Timeline
+---------
+The current timeline for Eclipse S-Core releases is shown below.
+
+.. image:: ../_assets/score_release_plan.drawio.svg
+   :width: 800
+   :alt: Architecture overview
+   :align: center
+
+|
+
+For more detailed planning overview please check our `GitHub project <https://github.com/orgs/eclipse-score/projects/17/views/26>`_.
+
+S-Core book
+------------
+First version of **Eclipse S-Core book**, that can be used as "how-to" for all who wants to start with S-Core project, can be found here: TODO Link.
+This book provides explanation of general concepts of **Eclipse S-Core project** and contains a "step-by-step" guide for building a first application
+based on Eclipse S-Core platform modules.  
+
+New Features
+^^^^^^^^^^^^^
+
+- **Inter-process Communication**
+- **Base libs**
+- **Fixed execution order framework**
+- **Logging**
+- **Persistency Key-Value-Storage**
+- **Reference integration**
+
+Improvements
+^^^^^^^^^^^^^
+
+- please consider release notes of every module
+
+Bug Fixes
+^^^^^^^^^^^^
+
+- please consider release notes of every module
+
+Integrated Software Modules
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- **Communication**: (Version). Link to Software module release note. 
+- **FEO**: (Version). Link to Software module release note. 
+- **Logging**: (Version). Link to Software module release note.
+- **Tracing**: (Version). Link to Software module release note.
+- **Baselibs**: (Version). Link to Software module release note.
+- **OS**: (Version). Link to Software module release note (external module).
+- **Persistency**: (Version). Link to Software module release note.
+- **Reference integration**: central place for integration of Eclipse S-Core modules
+
+  - **Link to release**: tbd
+  - **Release notes**
+
+    - Provides reference QNX x86_64 qemu image, for usage see `reference integration README <https://github.com/eclipse-score/reference_integration/blob/main/qnx_qemu/README.md>`_
+    - Provides integration of all 0.5 modules including `scrample demo application <https://github.com/eclipse-score/scrample>`_
+    - Provides `basic itf tests <https://github.com/eclipse-score/reference_integration/tree/main/qnx_qemu/test/itf>`_.
+      Check following `build commands <https://github.com/eclipse-score/reference_integration/tree/main/qnx_qemu#build-commands>`_ for running itf tests locally and for other important commands.  
+    - Provide CI/CD workflows to ensure stability of the reference integration:
+       
+      - `build and test on every pr <https://github.com/eclipse-score/reference_integration/blob/main/.github/workflows/build_and_test_on_every_pr.yml>`_ executes all itf tests in reference qnx image on every pr
+        to ensure that the image is still functional
+      - `release verification <https://github.com/eclipse-score/reference_integration/blob/main/.github/workflows/release_verification.yml>`_ does the same on every release    
+      - `test integration <https://github.com/eclipse-score/reference_integration/blob/main/.github/workflows/test_integration.yml>`_ for every pr and on every release builds all functional modules of Eclipse S-Core v0.5
+        release and additionally executes component tests with `<score-test-scenarios https://github.com/eclipse-score/testing_tools>`_ framework for some of components.     
+
+
+Associated Infrastructure Modules
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- **process_description**: (Version). Process description of S-CORE. Link to release note?
+- **docs-as-code**: (Version). Tooling for linking and generation of documentation. Link to release note?
+- **tooling**: (Version). Provided tooling for S-CORE development. Link to release note?
+- **ITF**: Integration Testing Framework for execution of feature integration tests on the reference image
+
+  - **Link to release**: `itf v0.1.0  <https://github.com/eclipse-score/itf/releases/tag/0.1.0>`_
+  - **Release notes**
+
+    - Bazel setup for macro *py_itf_test*
+    - Pinging target
+    - SSH and SPTP module
+    - DLT module
+    - Starting Qemu from `reference_integration <https://github.com/eclipse-score/reference_integration/tree/main/qnx_qemu>`_ repository
+    - `ITF readme <https://github.com/eclipse-score/itf/blob/main/README.md>`_
+    - `reference_integration readme <https://github.com/eclipse-score/reference_integration/blob/main/qnx_qemu/README.md#build-commands>`_
+
+
+Performed Verification
+^^^^^^^^^^^^^^^^^^^^^^^^
+Following tests were executed:
+
+- every module has executed its unit-tests
+- few basic integration tests were executed with reference integration qnx image in Qemu as can be seen e.g. in the following `Action Run <https://github.com/eclipse-score/reference_integration/actions/runs/19128779084/job/54664320615#step:7:689>`_.
+- for some of the modules (**TODO**), component tests with score-test-scenarios framework were executed
+
+Known Issues
+^^^^^^^^^^^^^^^^
+- see release notes of every module seperately 
+
+Upgrade Instructions
+^^^^^^^^^^^^^^^^^^^^^^^^
+- none, first published release.
+
+Contact Information
+^^^^^^^^^^^^^^^^^^^^
+For any questions or support, please contact the *Project lead* or raise an issue/discussion.