-
Notifications
You must be signed in to change notification settings - Fork 31
adopt to folder structure and process template #226
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
Changes from all commits
69948b9
dd1be37
a23f69c
d733865
dc47406
b3e5edf
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -12,12 +12,12 @@ | |||||
| # SPDX-License-Identifier: Apache-2.0 | ||||||
| # ******************************************************************************* | ||||||
|
|
||||||
| S-CORE v0.7-release notes | ||||||
| ========================= | ||||||
| S-CORE Platform v0.7-release note | ||||||
| ================================= | ||||||
|
|
||||||
| .. document:: S-CORE v0.7 release note | ||||||
| :id: doc__score_v07_release_note | ||||||
| :status: draft | ||||||
| :status: valid | ||||||
| :safety: QM | ||||||
| :security: YES | ||||||
| :realizes: wp__platform_sw_release_note | ||||||
|
|
@@ -31,33 +31,54 @@ S-CORE v0.7-release notes | |||||
| Overview | ||||||
| ^^^^^^^^ | ||||||
|
|
||||||
| This document provides an overview of the changes, improvements, and bug fixes included in the software platform release version v0.7.0 as compared to the platform’s origin release (v0.6). | ||||||
|
|
||||||
| The SCORE 0.7 platform release centers on safety formalization (vulnerability management, OS tier definitions, safety manuals), Rust interoperability (FFI bindings in baselibs and a full Rust COM API in communication), | ||||||
| and infrastructure hardening (toolchain improvements, Dependabot, CodeQL). | ||||||
|
|
||||||
| 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 | ||||||
| ------------ | ||||||
|
|
||||||
| No new features were added in this release. | ||||||
|
|
||||||
| Improvements | ||||||
| ------------ | ||||||
|
|
||||||
| The release significantly expanded integration testing capabilities, with ITF upgrade and test execution now supported on both Docker and QNX targets using the new py_itf_test Bazel rule. | ||||||
| The CI/CD pipeline was overhauled — the bash-based integration script was replaced with Python and the pipeline became more robust with improved build caching, automatic cancellation of superseded runs, and workflow steps pinned to exact commit SHAs for supply-chain safety. | ||||||
| EBcLfSA integration was updated to the new structure and extended with Rust application support. | ||||||
| On the documentation side, the build pipeline was fixed and an integration status dashboard was introduced to provide visibility into module health across the platform. | ||||||
| Infrastructure-wise, Bzlmod lockfile consistency is now enforced in CI, the AutoSD image version is frozen for reproducible builds, and image filesystem rules were migrated to the new Bazel API. | ||||||
|
|
||||||
|
|
||||||
| Eclipse S-CORE book | ||||||
| ------------------- | ||||||
|
|
||||||
| The `Eclipse S-CORE book <https://eclipse-score.github.io/score/main/handbook/index.html>`_ | ||||||
| is a “how-to” guide for users getting started with the project or who want to contribute new modules. | ||||||
|
|
||||||
| S-CORE Platform | ||||||
| ^^^^^^^^^^^^^^^^^^ | ||||||
| S-CORE Platform scope | ||||||
| ^^^^^^^^^^^^^^^^^^^^^ | ||||||
|
|
||||||
| - **Version:** ``score v0.5.5`` | ||||||
| - **Release notes**: `S-CORE Platform release notes <https://github.com/eclipse-score/score/releases/tag/v0.5.5>`_ | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Integrated Software Modules | ||||||
| ----------------------------- | ||||||
|
|
||||||
| Baselibs | ||||||
| ~~~~~~~~~~~~~ | ||||||
| ~~~~~~~~ | ||||||
|
|
||||||
| Selection of basic C++ utility libraries for common use in the S-CORE project | ||||||
|
|
||||||
| - **Version:** ``baselibs v0.2.7`` | ||||||
|
|
@@ -74,6 +95,7 @@ Selection of basic Rust utility libraries for common use in the S-CORE project | |||||
|
|
||||||
| Communication | ||||||
| ~~~~~~~~~~~~~ | ||||||
|
|
||||||
| Zero-copy, shared-memory based inter-process communication for minimal-latency intra-ECU messaging. | ||||||
|
|
||||||
| - **Version:** ``communication v0.2.1`` | ||||||
|
|
@@ -82,6 +104,7 @@ Zero-copy, shared-memory based inter-process communication for minimal-latency i | |||||
|
|
||||||
| Persistency | ||||||
| ~~~~~~~~~~~ | ||||||
|
|
||||||
| Ensures long-term storage and retrieval of data and provides a reliable mechanism for | ||||||
| preserving application state and data integrity over time. | ||||||
|
|
||||||
|
|
@@ -98,14 +121,16 @@ Logging | |||||
|
|
||||||
| Orchestrator | ||||||
| ~~~~~~~~~~~~~ | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| Orchestrator module provides a framework for defining and executing complex workflows and task sequences in a coordinated manner. | ||||||
|
|
||||||
| - **Version:** ``orchestrator v0.1.1`` | ||||||
| - **Release notes**: `Orchestrator release notes <https://github.com/eclipse-score/orchestrator/releases/tag/v0.1.1>`_ | ||||||
|
|
||||||
|
|
||||||
| Kyron | ||||||
| ~~~~~~~~~~~~~~ | ||||||
| ~~~~~ | ||||||
|
|
||||||
| Kyron is a customizable, high-performance async/await runtime designed for advanced concurrent programming with focus on functional safety. | ||||||
| It allows fine-grained control over scheduling, thread management, and workload isolation through configurable execution engines. | ||||||
|
|
||||||
|
|
@@ -114,15 +139,17 @@ It allows fine-grained control over scheduling, thread management, and workload | |||||
|
|
||||||
|
|
||||||
| Lifecycle & Health Management | ||||||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
|
||||||
| Lifecycle module provides a Launch Manager for process lifecycle management as well as a Health Monitoring library to support supervision of process behavior. | ||||||
|
|
||||||
| - **Version:** ``lifecycle v0.2.0`` | ||||||
| - **Release notes**: `Lifecycle release notes <https://github.com/eclipse-score/lifecycle/releases/tag/v0.2.0>`_ | ||||||
|
|
||||||
|
|
||||||
| Reference integration | ||||||
| ~~~~~~~~~~~~~~~~~~~~~~ | ||||||
| ~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
|
||||||
| Central integration of Eclipse S-CORE modules | ||||||
|
|
||||||
| - **Version:** ``reference integration v0.7.0`` | ||||||
|
|
@@ -131,6 +158,7 @@ Central integration of Eclipse S-CORE modules | |||||
|
|
||||||
| Reference QNX image | ||||||
| +++++++++++++++++++++ | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| - No changes compared to the previous software version. | ||||||
|
|
||||||
| Reference Red Hat AutoSD Linux image (Experimental) | ||||||
|
|
@@ -147,31 +175,35 @@ Reference Elektrobit corbos Linux for Safety Applications Linux image (Experimen | |||||
| Associated Infrastructure Modules | ||||||
| ----------------------------------- | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
|
||||||
| process_description | ||||||
| Process description | ||||||
| ~~~~~~~~~~~~~~~~~~~ | ||||||
|
|
||||||
| Provides a process model establishing organizational rules for developing open source software | ||||||
| in the automotive domain, suitable for safety and security contexts. | ||||||
|
|
||||||
| - **Version:** ``process description v1.5.4`` | ||||||
| - **Release notes**: `process_description release <https://github.com/eclipse-score/process_description/releases/tag/v1.5.4>`_ | ||||||
|
|
||||||
| docs-as-code | ||||||
| ~~~~~~~~~~~~~~ | ||||||
| Docs-as-code | ||||||
| ~~~~~~~~~~~~ | ||||||
|
|
||||||
| Tooling for linking and generation of documentation. | ||||||
|
|
||||||
| - **Version:** ``docs-as-code v4.0.3`` | ||||||
| - **Source / tag:** `docs-as-code GitHub release <https://github.com/eclipse-score/docs-as-code/releases/tag/v4.0.3>`_ | ||||||
|
|
||||||
| tooling | ||||||
| ~~~~~~~~~~~~~~ | ||||||
| Tooling | ||||||
| ~~~~~~~ | ||||||
|
|
||||||
| Tooling for S-CORE development. | ||||||
|
|
||||||
| - **Version:** ``tooling v1.1.2`` | ||||||
| - **Source / tag:** `tooling GitHub release <https://github.com/eclipse-score/tooling/releases/tag/v1.1.2>`_ | ||||||
|
|
||||||
|
|
||||||
| ITF (Integration Testing Framework) | ||||||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||||||
|
|
||||||
| ITF is a pytest-based testing framework designed for ECU (Electronic Control Unit) testing in automotive domains. | ||||||
| It provides a flexible, plugin-based architecture that enables testing on multiple target environments including Docker containers, | ||||||
| QEMU virtual machines, and real hardware. | ||||||
|
|
@@ -180,29 +212,47 @@ QEMU virtual machines, and real hardware. | |||||
| - **Source / tag:** `ITF GitHub release <https://github.com/eclipse-score/itf/releases/tag/v0.3.0>`_ | ||||||
|
|
||||||
| Test Scenarios | ||||||
| ~~~~~~~~~~~~~~~ | ||||||
| ~~~~~~~~~~~~~~ | ||||||
|
|
||||||
| Test scenarios provide a backend for defining C++ and Rust implemented test scenarios that allow parametrized execution of built scenario applications which are the input for test cases. | ||||||
|
|
||||||
| - **Version:** ``Test Scenarios v0.4.1`` | ||||||
| - **Source / tag:** `Test Scenarios GitHub release <https://github.com/eclipse-score/testing_tools/releases/tag/v0.4.1>`_ | ||||||
|
|
||||||
|
|
||||||
| Bazel CPP Toolchain | ||||||
| ~~~~~~~~~~~~~~~~~~~~ | ||||||
| ~~~~~~~~~~~~~~~~~~~ | ||||||
|
|
||||||
| - **Version:** ``bazel_cpp_toolchains v0.5.1`` | ||||||
| - **Release notes**: `Bazel CPP Toolchain release notes <https://github.com/eclipse-score/bazel_cpp_toolchains/releases/tag/v0.5.1>`_ | ||||||
|
|
||||||
|
|
||||||
| Known Issues | ||||||
| ---------------------- | ||||||
| Compatibility | ||||||
| ^^^^^^^^^^^^^ | ||||||
|
|
||||||
| - **Dependencies:** None known ... | ||||||
|
|
||||||
| Performed Verification | ||||||
| ^^^^^^^^^^^^^^^^^^^^^^ | ||||||
|
|
||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Shouldn't we have a link to the verification report here? |
||||||
| Known Issues/Vulnerabilities and Bug Fixes | ||||||
| ------------------------------------------ | ||||||
|
|
||||||
| - see release notes of every module separately | ||||||
|
|
||||||
| Upgrade Instructions | ||||||
| ---------------------- | ||||||
| -------------------- | ||||||
|
|
||||||
| - Increase to newest bazel registry versions: https://eclipse-score.github.io/bazel_registry_ui | ||||||
| - Versions can be found under: https://github.com/eclipse-score/reference_integration/blob/v0.7.0/known_good.json | ||||||
|
|
||||||
| Upgrade Instructions | ||||||
| ^^^^^^^^^^^^^^^^^^^^ | ||||||
|
|
||||||
| Not evaluated yet, but expected to be straightforward as no breaking changes are introduced in this release. Please refer to the release notes of the individual modules for any specific upgrade instructions. | ||||||
|
|
||||||
| Contact Information | ||||||
| ---------------------- | ||||||
| ------------------- | ||||||
|
|
||||||
| For any questions or support, please contact the *Project leads* or raise an issue/discussion. | ||||||
| https://projects.eclipse.org/projects/automotive.score | ||||||
This file was deleted.
|
PiotrKorkus marked this conversation as resolved.
|
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # 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 Verification Report | ||
| ============================ | ||
|
|
||
| .. document:: Platform Verification Report | ||
| :id: doc__platform_verification_report_v07 | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is the report for 0.7 and the score_releases includes a file with the specific extension _07. In case we move to a new version like 0.8 and create a new file with _08 for the release note, this could break the link. Or in other words. you cannot see the past verification results when a new release is created, but you will still see the release note. It could be something to discuss and improve. Of course we also have versioning via GitHub, so it is always possible to go back to a specifically tagged version. So this may be of a minor issue. I just spot inconsistency between release note and verification report. |
||
| :status: valid | ||
| :safety: QM | ||
| :security: YES | ||
| :realizes: wp__verification_platform_ver_report | ||
|
|
||
|
|
||
| This is the content according to the template (see :need:`doc__platform_verification_report`) for the platform verification report, filled in with the information available for this release. | ||
|
|
||
| 1. Verification Coverage | ||
| ------------------------- | ||
|
|
||
| 1.1. Requirements | ||
| ~~~~~~~~~~~~~~~~~ | ||
|
|
||
| For this release, the requirements-related verification output is as follows: | ||
|
|
||
| * Lists of stakeholder and feature requirements tested (split in separate lists for QM and ASIL) by which test case, passed/failed/not_run and completeness verdict: | ||
| No release-specific requirement verification matrix is available in this platform verification report. | ||
|
|
||
| * List of external component Assumptions of Use and coverage by platform safety manual: | ||
| Assumptions of Use requirements and safety manual content exist in the documentation set, but no release-specific coverage matrix is provided in this platform verification report. | ||
|
|
||
| * List of stakeholder requirements (ASIL rated) linked to inspection checklist and verdict derived from PR export: | ||
| No PR-export-derived stakeholder requirement inspection list is available in this repository for this release. | ||
|
|
||
| 1.2. Architecture | ||
| ~~~~~~~~~~~~~~~~~ | ||
|
|
||
| For this release, the architecture-related verification output is as follows: | ||
|
|
||
| * List of feature architecture tags (split into separate lists for QM and ASIL) tested by test case or other verification method: | ||
| No release-specific architecture-tag verification matrix is available in this platform verification report. | ||
|
|
||
| * List of feature architecture tags (ASIL rated) linked to inspection checklist and verdict derived from PR export: | ||
| Architecture inspection checklists exist in the documentation set for individual modules and features, but no release-specific PR-export-derived list is available in this repository for this release. | ||
|
|
||
| 2. Safety Analyses Report | ||
| ------------------------- | ||
|
|
||
| For this release, the safety-analyses-related verification output is as follows: | ||
|
|
||
| * List of the performed Platform and Feature Safety Analyses: | ||
| No release-specific consolidated list of performed platform-level and feature-level safety analyses is available in this platform verification report. | ||
|
|
||
| * Pass/fail result and open mitigations for each safety analysis: | ||
| No release-specific result table for safety analyses, including open mitigations, is provided in this report. | ||
|
|
||
|
|
||
| 3. Test results | ||
| --------------- | ||
|
|
||
| Test result per test case with status passed/failed/not_run for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test`. | ||
|
|
||
| For this release, detailed per-test-case results are not available in this report yet. | ||
| The following referenced summary pages exist only. | ||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| Unit Tests Summary <unit_test_summary> | ||
| Coverage Analysis Summary <coverage_summary> | ||
|
|
||
|
|
||
| 4. Test logs | ||
| --------------- | ||
|
|
||
| Link to test log per test case for :need:`wp__verification_platform_int_test` and :need:`wp__verification_feat_int_test`. | ||
|
|
||
| For this release, detailed test logs are not available in this report yet. | ||
|
|
||
|
|
||
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.