From de6e73925b77aa248582b4f07178cc3b1dce2909 Mon Sep 17 00:00:00 2001 From: Shady Mohamed Date: Tue, 5 May 2026 23:02:10 +0200 Subject: [PATCH 1/5] ADd Release notes for v0.2.0 --- .github/RELEASE_TEMPLATE.md | 100 +++++++++++++++++++ docs/release_notes/Release_note_v_0_2_0.rst | 102 ++++++++++++++++++++ docs/release_notes/index.rst | 0 3 files changed, 202 insertions(+) create mode 100644 .github/RELEASE_TEMPLATE.md create mode 100644 docs/release_notes/Release_note_v_0_2_0.rst create mode 100644 docs/release_notes/index.rst diff --git a/.github/RELEASE_TEMPLATE.md b/.github/RELEASE_TEMPLATE.md new file mode 100644 index 00000000..ea1e905f --- /dev/null +++ b/.github/RELEASE_TEMPLATE.md @@ -0,0 +1,100 @@ + + +Release Note +============ + +.. note:: Document header + +.. document:: Lifecycle Release Note + :id: doc__lifecycle_release_note + :status: valid + :safety: ASIL_B + :security: NO + :realizes: wp__module_sw_release_note + :tags: template + + + +| **Module Name:** lifecycle +| **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 module release version vX.Y.Z +as compared to the module'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 Module +^^^^^^^^^^^^^^^^^^^^^ + +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 module verification report +:need:`doc__module_name_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. + +For any questions or support, please contact the *Project lead* or raise an issue/discussion. diff --git a/docs/release_notes/Release_note_v_0_2_0.rst b/docs/release_notes/Release_note_v_0_2_0.rst new file mode 100644 index 00000000..1227adf6 --- /dev/null +++ b/docs/release_notes/Release_note_v_0_2_0.rst @@ -0,0 +1,102 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +Release Note +============ + +.. note:: Document header + +.. document:: lifecycle Release Note + :id: doc__lifecycle_release_note + :status: valid + :safety: ASIL_B + :security: NO + :realizes: wp__module_sw_release_note + :tags: + + +| **Module Name:** lifecycle +| **Release Tag:** v0.2.0 +| **Origin Release Tag:** v0.1.0 +| **Release Date:** 2026-04-29 + + +Overview +^^^^^^^^ + +This document provides an overview of the changes, improvements, and bug fixes included in the software module release version vX.Y.Z +as compared to the module'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 Module +^^^^^^^^^^^^^^^^^^^^^ + +New Features +------------ + +- **New Configuration Schema:** Introduce first version of JSON schema intended for Launch Manager configuration. +- **Heartbeat monitor API:** Health monitoring library provides heartbeat monitor API. +- **Logic monitor API:** Health monitoring library provides logic monitor API. + +Improvements +------------ + +- **Quality improvements:** testing anddocumentation updates. + +Bug Fixes +--------- + +- + +Other changes by Label +---------------------- + + +Compatibility +^^^^^^^^^^^^^ + +- The following platforms are supported using the [bazel_cpp_toolchains](https://github.com/eclipse-score/bazel_cpp_toolchains): + - `x86_64-unknown-linux-gnu` + - `aarch64-unknown-linux-gnu` + - `x86_64-unknown-nto-qnx800` + - `aarch64-unknown-nto-qnx800` + +Performed Verification +^^^^^^^^^^^^^^^^^^^^^^ +- Build on all supported platforms +.. This release note is based on the verification as documented in module verification report +.. :need:`doc__module_name_verification_report`. + +Known Issues +------------ + +- + +Known Vulnerabilities +--------------------- + +- + +Upgrade Instructions +^^^^^^^^^^^^^^^^^^^^ + +- Backward compatibility with the previous release is not guaranteed. + +For any questions or support, please contact the [Project Team](https://github.com/orgs/eclipse-score/projects/33) or raise an issue/discussion. diff --git a/docs/release_notes/index.rst b/docs/release_notes/index.rst new file mode 100644 index 00000000..e69de29b From 7f9726c75b340160e19f0636e776acd67ad3611a Mon Sep 17 00:00:00 2001 From: Shady Mohamed Date: Wed, 6 May 2026 19:43:50 +0200 Subject: [PATCH 2/5] Add Release workflow --- .github/RELEASE_TEMPLATE.md | 104 ++---------------- .github/release.yml | 116 ++++++++++++++++++++ docs/release_notes/Release_note_v_0_2_0.rst | 31 ++---- docs/release_notes/index.rst | 37 +++++++ 4 files changed, 175 insertions(+), 113 deletions(-) create mode 100644 .github/release.yml diff --git a/.github/RELEASE_TEMPLATE.md b/.github/RELEASE_TEMPLATE.md index ea1e905f..a4b45241 100644 --- a/.github/RELEASE_TEMPLATE.md +++ b/.github/RELEASE_TEMPLATE.md @@ -1,100 +1,18 @@ - - -Release Note -============ - -.. note:: Document header - -.. document:: Lifecycle Release Note - :id: doc__lifecycle_release_note - :status: valid - :safety: ASIL_B - :security: NO - :realizes: wp__module_sw_release_note - :tags: template - - - -| **Module Name:** lifecycle -| **Release Tag:** vX.Y.Z -| **Origin Release Tag:** vU.V.W -| **Release Date:** YYYY-MM-DD - +**Module Name:** lifecycle +**Release Tag:** $RELEASE_TAG +**Origin Release Tag:** $PREVIOUS_RELEASE_TAG +**Release Commit Hash:** $COMMIT_SHA +**Release Date:** $RELEASE_DATE Overview -^^^^^^^^ - -This document provides an overview of the changes, improvements, and bug fixes included in the software module release version vX.Y.Z +======== +This document provides an overview of the changes, improvements, and bug fixes included in the software module release version $RELEASE_TAG as compared to the module'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 Module -^^^^^^^^^^^^^^^^^^^^^ - -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 module verification report -:need:`doc__module_name_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 -^^^^^^^^^^^^^^^^^^^^ +========== +This release is not intended for production use, as it does not include a safety argumentation or a completed safety assessment. +The work products compiled in the safety package are created with care according to the [S-CORE process](https://eclipse-score.github.io/process_description/main/index.html). However, as a non-profit, open-source organization, the project cannot assume any liability for its content. -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 details on the features, see https://eclipse-score.github.io/score/main/features/lifecycle/index.html -For any questions or support, please contact the *Project lead* or raise an issue/discussion. diff --git a/.github/release.yml b/.github/release.yml new file mode 100644 index 00000000..448e5f84 --- /dev/null +++ b/.github/release.yml @@ -0,0 +1,116 @@ +# ******************************************************************************* +# 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 +# ******************************************************************************* +# +# This workflow automates the release process for the lifecycle repository. +# It is triggered manually to build, test, and validate release artifacts. +# The workflow creates a draft release with a filled-out description for +# maintainers to approve and publish. + +name: Release +run-name: Release ${{ inputs.tag }} +permissions: + contents: read +on: + workflow_dispatch: + inputs: + tag: + description: 'Release tag (e.g., v1.0.0)' + required: true + type: string +concurrency: + group: release +jobs: + build-linux: + uses: ./.github/workflows/build.yml + + build-qnx: + uses: ./.github/workflows/build_qnx8.yml + permissions: + contents: read + pull-requests: read + secrets: inherit + + coverage-report: + uses: ./.github/workflows/code_coverage.yml + +# lint: +# uses: ./.github/workflows/lint.yml +# sanitizers: +# uses: ./.github/workflows/sanitizers_linux.yml + + create-release: + needs: [build-linux, build-qnx, coverage-report] + runs-on: ubuntu-latest + permissions: + contents: write + env: + COVERAGE_ARCHIVE: ${{ github.event.repository.name }}-${{ inputs.tag }}-cpp-coverage + steps: + - name: Checkout Repository + uses: actions/checkout@v6 + - name: Get Current Date and Previous Release Tag + env: + GH_TOKEN: ${{ github.token }} + run: | + PREVIOUS_TAG=$(gh release view --json tagName --jq '.tagName' 2>/dev/null || echo "N/A") + echo "RELEASE_DATE=$(date --rfc-3339=date)" >> $GITHUB_ENV + echo "PREVIOUS_RELEASE_TAG=$PREVIOUS_TAG" >> $GITHUB_ENV + - name: Generate Release Body + env: + RELEASE_TAG: ${{ inputs.tag }} + COMMIT_SHA: ${{ github.sha }} + ACTION_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} + run: | + envsubst '$RELEASE_TAG $PREVIOUS_RELEASE_TAG $COMMIT_SHA $RELEASE_DATE $ACTION_RUN_URL' < .github/RELEASE_TEMPLATE.md > release_body.md + - name: Find Latest Release Note + run: | + LATEST_RELEASE_NOTE=$( + for f in docs/release_notes/Release_note_v_*.rst; do + [ -e "$f" ] || continue + ver=$(basename "$f" .rst | sed 's/Release_note_v_//' | tr '_' '.') + echo "$ver $f" + done | sort -t '.' -k1,1n -k2,2n -k3,3n | tail -1 | awk '{print $2}' + ) + echo "LATEST_RELEASE_NOTE=$LATEST_RELEASE_NOTE" >> "$GITHUB_ENV" + - name: Append Release Note to Release Body + if: env.LATEST_RELEASE_NOTE != '' + run: | + printf '\n---\n\n## Release Notes\n\n' >> release_body.md + sed -n '/^Changes to the Module$/,$p' "$LATEST_RELEASE_NOTE" >> release_body.md + - name: Download Coverage Report Artifact + uses: actions/download-artifact@v7 + with: + name: ${{ format('{0}_cpp_coverage{1}', github.event.repository.name, '_cpp') }} + path: ${{ env.COVERAGE_ARCHIVE }} + - name: Create Coverage Report Archive + run: | + tar --sort=name --owner=0 --group=0 --numeric-owner \ + -cJf "$COVERAGE_ARCHIVE.tar.xz" "$COVERAGE_ARCHIVE" + - name: Create Draft Release + uses: softprops/action-gh-release@v2 + id: draft_release + with: + tag_name: ${{ inputs.tag }} + body_path: release_body.md + draft: true + generate_release_notes: true + target_commitish: ${{ github.sha }} + files: | + ${{ env.COVERAGE_ARCHIVE }}.tar.xz + - name: Summary + run: | + echo "### Draft Release Created :rocket:" >> $GITHUB_STEP_SUMMARY + echo "Tag: **${{ inputs.tag }}**" >> $GITHUB_STEP_SUMMARY + echo "Branch: \`${{ github.ref_name }}\`" >> $GITHUB_STEP_SUMMARY + echo "Commit: \`${{ github.sha }}\`" >> $GITHUB_STEP_SUMMARY + echo "Maintainers can review at: ${{ steps.draft_release.outputs.url }}" >> $GITHUB_STEP_SUMMARY diff --git a/docs/release_notes/Release_note_v_0_2_0.rst b/docs/release_notes/Release_note_v_0_2_0.rst index 1227adf6..3ccca196 100644 --- a/docs/release_notes/Release_note_v_0_2_0.rst +++ b/docs/release_notes/Release_note_v_0_2_0.rst @@ -12,10 +12,6 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Release Note -============ - -.. note:: Document header .. document:: lifecycle Release Note :id: doc__lifecycle_release_note @@ -26,27 +22,21 @@ Release Note :tags: -| **Module Name:** lifecycle -| **Release Tag:** v0.2.0 -| **Origin Release Tag:** v0.1.0 -| **Release Date:** 2026-04-29 - - Overview -^^^^^^^^ +======== -This document provides an overview of the changes, improvements, and bug fixes included in the software module release version vX.Y.Z +This document provides an overview of the changes, improvements, and bug fixes included in the software module release version vx.x.z as compared to the module'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 Module -^^^^^^^^^^^^^^^^^^^^^ +===================== New Features ------------ @@ -68,9 +58,10 @@ Bug Fixes Other changes by Label ---------------------- +- Compatibility -^^^^^^^^^^^^^ +------------- - The following platforms are supported using the [bazel_cpp_toolchains](https://github.com/eclipse-score/bazel_cpp_toolchains): - `x86_64-unknown-linux-gnu` @@ -79,10 +70,10 @@ Compatibility - `aarch64-unknown-nto-qnx800` Performed Verification -^^^^^^^^^^^^^^^^^^^^^^ +---------------------- + - Build on all supported platforms -.. This release note is based on the verification as documented in module verification report -.. :need:`doc__module_name_verification_report`. +- Unit test execution on all supported platforms Known Issues ------------ @@ -95,8 +86,8 @@ Known Vulnerabilities - Upgrade Instructions -^^^^^^^^^^^^^^^^^^^^ +-------------------- - Backward compatibility with the previous release is not guaranteed. -For any questions or support, please contact the [Project Team](https://github.com/orgs/eclipse-score/projects/33) or raise an issue/discussion. +*For any questions or support, please contact the [Project Team](https://github.com/orgs/eclipse-score/projects/33) or raise an issue/discussion.* diff --git a/docs/release_notes/index.rst b/docs/release_notes/index.rst index e69de29b..0b0f0d35 100644 --- a/docs/release_notes/index.rst +++ b/docs/release_notes/index.rst @@ -0,0 +1,37 @@ +.. + # ******************************************************************************* + # 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 + # ******************************************************************************* + +.. _lifecycle_release_notes: + +Release notes +============= + +Overview +-------- + +This document provides an overview of the changes, improvements, and bug fixes included in the software module release version v0.2.0 +as compared to the module'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. + +.. toctree:: + :maxdepth: 1 + :caption: Content + + release_note_v_0_2_0.rst \ No newline at end of file From 75fe0e77727c09fa813dced5a81698451b07cd76 Mon Sep 17 00:00:00 2001 From: Shady Mohamed Date: Thu, 7 May 2026 11:59:45 +0200 Subject: [PATCH 3/5] Update rst format issues --- .github/{ => workflows}/release.yml | 14 +++++++------- docs/release_notes/Release_note_v_0_2_0.rst | 5 +++-- docs/release_notes/index.rst | 2 +- 3 files changed, 11 insertions(+), 10 deletions(-) rename .github/{ => workflows}/release.yml (97%) diff --git a/.github/release.yml b/.github/workflows/release.yml similarity index 97% rename from .github/release.yml rename to .github/workflows/release.yml index 448e5f84..63c6c098 100644 --- a/.github/release.yml +++ b/.github/workflows/release.yml @@ -32,22 +32,22 @@ concurrency: jobs: build-linux: uses: ./.github/workflows/build.yml - + build-qnx: uses: ./.github/workflows/build_qnx8.yml permissions: contents: read pull-requests: read secrets: inherit - + coverage-report: uses: ./.github/workflows/code_coverage.yml -# lint: -# uses: ./.github/workflows/lint.yml -# sanitizers: -# uses: ./.github/workflows/sanitizers_linux.yml - + # lint: + # uses: ./.github/workflows/lint.yml + # sanitizers: + # uses: ./.github/workflows/sanitizers_linux.yml + create-release: needs: [build-linux, build-qnx, coverage-report] runs-on: ubuntu-latest diff --git a/docs/release_notes/Release_note_v_0_2_0.rst b/docs/release_notes/Release_note_v_0_2_0.rst index 3ccca196..983a3a91 100644 --- a/docs/release_notes/Release_note_v_0_2_0.rst +++ b/docs/release_notes/Release_note_v_0_2_0.rst @@ -48,14 +48,14 @@ New Features Improvements ------------ -- **Quality improvements:** testing anddocumentation updates. +- **Quality improvements:** testing and documentation updates. Bug Fixes --------- - -Other changes by Label +Other Changes by Label ---------------------- - @@ -64,6 +64,7 @@ Compatibility ------------- - The following platforms are supported using the [bazel_cpp_toolchains](https://github.com/eclipse-score/bazel_cpp_toolchains): + - `x86_64-unknown-linux-gnu` - `aarch64-unknown-linux-gnu` - `x86_64-unknown-nto-qnx800` diff --git a/docs/release_notes/index.rst b/docs/release_notes/index.rst index 0b0f0d35..28c403c0 100644 --- a/docs/release_notes/index.rst +++ b/docs/release_notes/index.rst @@ -34,4 +34,4 @@ being a non-profit and open source organization, can not take over any liability :maxdepth: 1 :caption: Content - release_note_v_0_2_0.rst \ No newline at end of file + release_note_v_0_2_0 \ No newline at end of file From d3ab7ab51be79975c45c697785e985635669789d Mon Sep 17 00:00:00 2001 From: Shady Mohamed Date: Thu, 7 May 2026 12:11:57 +0200 Subject: [PATCH 4/5] Update rst format issues --- docs/release_notes/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release_notes/index.rst b/docs/release_notes/index.rst index 28c403c0..a109c37e 100644 --- a/docs/release_notes/index.rst +++ b/docs/release_notes/index.rst @@ -34,4 +34,4 @@ being a non-profit and open source organization, can not take over any liability :maxdepth: 1 :caption: Content - release_note_v_0_2_0 \ No newline at end of file + ./release_note_v_0_2_0.rst \ No newline at end of file From 2fb8adb65f6699932a551f2ef06c6001afbef518 Mon Sep 17 00:00:00 2001 From: Shady Mohamed Date: Thu, 7 May 2026 13:10:23 +0200 Subject: [PATCH 5/5] Update Release note template --- .github/RELEASE_TEMPLATE.md | 8 ++++---- .github/workflows/release.yml | 8 ++++---- docs/index.rst | 11 +++++++++++ ...ease_note_v_0_2_0.rst => release_note_v_0_2_0.rst} | 0 4 files changed, 19 insertions(+), 8 deletions(-) rename docs/release_notes/{Release_note_v_0_2_0.rst => release_note_v_0_2_0.rst} (100%) diff --git a/.github/RELEASE_TEMPLATE.md b/.github/RELEASE_TEMPLATE.md index a4b45241..0ef19cba 100644 --- a/.github/RELEASE_TEMPLATE.md +++ b/.github/RELEASE_TEMPLATE.md @@ -1,16 +1,16 @@ +# Module Release Notes + **Module Name:** lifecycle **Release Tag:** $RELEASE_TAG **Origin Release Tag:** $PREVIOUS_RELEASE_TAG **Release Commit Hash:** $COMMIT_SHA **Release Date:** $RELEASE_DATE -Overview -======== +## Overview This document provides an overview of the changes, improvements, and bug fixes included in the software module release version $RELEASE_TAG as compared to the module's origin release (which is usually the previous release). -Disclaimer -========== +## Disclaimer This release is not intended for production use, as it does not include a safety argumentation or a completed safety assessment. The work products compiled in the safety package are created with care according to the [S-CORE process](https://eclipse-score.github.io/process_description/main/index.html). However, as a non-profit, open-source organization, the project cannot assume any liability for its content. diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 63c6c098..819448a4 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -75,9 +75,9 @@ jobs: - name: Find Latest Release Note run: | LATEST_RELEASE_NOTE=$( - for f in docs/release_notes/Release_note_v_*.rst; do + for f in docs/release_notes/release_note_v_*.rst; do [ -e "$f" ] || continue - ver=$(basename "$f" .rst | sed 's/Release_note_v_//' | tr '_' '.') + ver=$(basename "$f" .rst | sed 's/release_note_v_//' | tr '_' '.') echo "$ver $f" done | sort -t '.' -k1,1n -k2,2n -k3,3n | tail -1 | awk '{print $2}' ) @@ -85,8 +85,8 @@ jobs: - name: Append Release Note to Release Body if: env.LATEST_RELEASE_NOTE != '' run: | - printf '\n---\n\n## Release Notes\n\n' >> release_body.md - sed -n '/^Changes to the Module$/,$p' "$LATEST_RELEASE_NOTE" >> release_body.md + printf '\n---\n\n## Changes to the Module\n\n' >> release_body.md + sed -n '/^Changes to the Module$/,$p' "$LATEST_RELEASE_NOTE" | sed '1,2d' >> release_body.md - name: Download Coverage Report Artifact uses: actions/download-artifact@v7 with: diff --git a/docs/index.rst b/docs/index.rst index 3dfd4d99..f1ebd433 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -43,3 +43,14 @@ To run tests: .. code-block:: bash bazel test //tests/... + + +Release Notes +------------- + +Release notes collection. + +.. toctree:: + :maxdepth: 1 + + release_notes/index diff --git a/docs/release_notes/Release_note_v_0_2_0.rst b/docs/release_notes/release_note_v_0_2_0.rst similarity index 100% rename from docs/release_notes/Release_note_v_0_2_0.rst rename to docs/release_notes/release_note_v_0_2_0.rst