Skip to content

Commit d057079

Browse files
masc2023PandaeDo
authored andcommitted
update release management
Add new wor product handbook and workflow remove build configurations as separate wps, but add it to the release notes Resolves: #212
1 parent 78d6b48 commit d057079

File tree

6 files changed

+46
-35
lines changed

6 files changed

+46
-35
lines changed

process/folder_templates/modules/module_name/docs/safety_mgt/module_safety_plan.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Module Work products List
129129
- <Link to WP>
130130
- <WP status (manual)>
131131

132-
* - :need:`wp__module_sw_build_config`
132+
* - :need:`wp__module_sw_release_note`
133133
- :need:`gd_temp__software_development_plan`
134134
- `copy('status', need_id='gd_temp__software_development_plan')`
135135
- <Link to issue>

process/process_areas/release_management/release_getstrt.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Releases can be done in every repository, mainly:
2727
* Platform (Main project/Integration) repository
2828
* Module (platform's components) repositories
2929

30-
For this are available: templates :need:`gd_temp__rel_plat_rel_note` & :need:`gd_temp__rel_mod_rel_note`
30+
For these are available: templates :need:`gd_temp__rel_plat_rel_note` & :need:`gd_temp__rel_mod_rel_note`
3131
or `Combined Release Template <https://github.com/eclipse-score/process_description/blob/main/.github/RELEASE_TEMPLATE.md>`_,
3232
guidelines :need:`gd_guidl__rel_management` and a :need:`doc_concept__rel_process`
3333
are available.
@@ -42,5 +42,6 @@ The following workflows are executed:
4242
* Create a release plan for the platform according to :need:`wf__rel_plat_rel_plan`
4343
* Create a release plan for the module according to :need:`wf__rel_mod_rel_plan`
4444
* According to the planning create release notes for modules :need:`wf__rel_mod_rel_note` and platform :need:`wf__rel_platform_rel_note`
45+
* According to the planning create the platform handbook :need:`wf__rel_platform_handbook`
4546

4647
In addition create a release management plan as part of the platform management plan according to :need:`wf__platform_cr_mt_platform_mgmt_plan`.

process/process_areas/release_management/release_workflow.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,20 @@ For a detailed explanation of workflows and their role within the process model,
6969

7070
The platform release plan is created as part of the project planning and documented in the platform management plan.
7171

72+
73+
.. workflow:: Create/Maintain Platform Handbook
74+
:id: wf__rel_platform_handbook
75+
:status: valid
76+
:responsible: rl__project_lead
77+
:approved_by: rl__project_lead
78+
:input: wp__platform_safety_package, wp__platform_sw_release_plan, wp__verification_platform_ver_report
79+
:output: wp__platform_handbook
80+
:contains:
81+
:has: doc_concept__rel_process, doc_getstrt__release_process
82+
83+
The platform handbook is prepared and approved by the project lead circle.
84+
It may be updated later in case of bugs found after the release is published.
85+
7286
RAS(IC) for Release Management:
7387
*******************************
7488

process/process_areas/release_management/release_workproducts.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ Release Management Work Products
2626
platform versions and provide information regarding the time of the release.
2727
It includes known bugs from own testing and field reporting, with clear statement,
2828
that these bugs do not lead to violation of any safety requirements or which workaround measures need to be applied.
29+
It contains also the build configuration capable to create the SEooC Library for the
30+
reference HW, platform level.
31+
32+
Note: Embedded software in the sense of the Iso (i.e. deployed on the production HW)
33+
is not part of our delivery.
2934

3035
.. workproduct:: Module Release Notes
3136
:id: wp__module_sw_release_note
@@ -37,6 +42,11 @@ Release Management Work Products
3742
information regarding the time of the release. It includes known bugs from own testing and field reporting,
3843
with clear statement, that these bugs do not lead to violation of any safety requirements or
3944
which workaround measures need to be applied.
45+
It contains also the build configuration capable to create the SEooC Library for the
46+
reference HW, module level.
47+
48+
Note: Embedded software in the sense of the Iso (i.e. deployed on the production HW)
49+
is not part of our delivery.
4050

4151
.. workproduct:: Platform Release Plan
4252
:id: wp__platform_sw_release_plan
@@ -56,3 +66,20 @@ Release Management Work Products
5666
module releases along with their estimated release dates. It provides a roadmap for the
5767
development and release of new features, ensuring that all stakeholders are aligned on the
5868
module's future direction.
69+
70+
.. workproduct:: Platform Handbook
71+
:id: wp__platform_handbook
72+
:status: valid
73+
74+
The platform handbook is a tutorial to explain how the project works from a technical
75+
perspective. It explains the background of the project, but also what the project is
76+
not about.
77+
78+
Further it contains:
79+
80+
- Overview of the technologies used within the project
81+
- Software architecture overview
82+
- Module structure overview
83+
- Integration process
84+
- Getting started guide
85+
- Contribution guide

process/process_areas/security_management/guidance/security_management_module_security_plan_template.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ Module Security Plan Template
102102
- <Link to WP>
103103
- <WP status (manual)>
104104

105-
* - :need:`wp__module_sw_build_config`
105+
* - :need:`wp__module_sw_release_note`
106106
- :need:`Software Development Plan Template <gd_temp__software_development_plan>`
107107
- <automated>
108108
- <Link to issue>

process/workproducts/index.rst

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,7 @@ An work product is an items needed as input or created as output of one or more
2222
The project development work product traceability model overview can be found here: :ref:`general_concepts_traceability`.
2323

2424

25-
Platform management
26-
--------------------
27-
28-
General
29-
^^^^^^^
25+
Here only project specific work products are listed, which are generic for the platform.
3026

3127
.. workproduct:: Policies
3228
:id: wp__policies
@@ -55,33 +51,6 @@ General
5551
ones from ECLIPSE.
5652

5753

58-
Product development
59-
-------------------
60-
61-
Platform development
62-
^^^^^^^^^^^^^^^^^^^^
63-
64-
.. workproduct:: Platform Build Configuration
65-
:id: wp__platform_sw_build_config
66-
:status: draft
67-
:tags: safety
68-
:complies: std_wp__iso26262__software_1052
69-
70-
Build configuration capable to create the SEooC Library for the reference HW, platform level.
71-
Note: Embedded software in the sense of the Iso (i.e. deployed on the production HW) is not part of our delivery.
72-
73-
74-
Component development
75-
^^^^^^^^^^^^^^^^^^^^^
76-
77-
.. workproduct:: Module Build Configuration
78-
:id: wp__module_sw_build_config
79-
:status: draft
80-
:tags: safety
81-
:complies: std_wp__iso26262__software_1052
82-
83-
Build configuration capable to create the SEooC Library for the reference HW, module level.
84-
Note: Embedded software in the sense of the Iso (i.e. deployed on the production HW) is not part of our delivery.
8554

8655

8756
Project Work product Linkage

0 commit comments

Comments
 (0)