Skip to content

Commit f601db0

Browse files
docs: release process small bugfixes
Ref: closes #313 Signed-off-by: aschemmel-tech <[email protected]>
1 parent 9a1fa19 commit f601db0

File tree

4 files changed

+23
-29
lines changed

4 files changed

+23
-29
lines changed

docs/process/process_areas/release_management/guidance/release_guideline.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ Guideline
1717

1818
.. gd_guidl:: Release Management Guideline
1919
:id: gd_guidl__rel_management
20-
:status: draft
20+
:status: valid
21+
:complies: std_req__iso26262__management_64131, std_req__iso26262__management_64132, std_req__iso26262__management_64133
2122

2223
.. _workflow_release:
2324

@@ -45,7 +46,7 @@ Software Module Release
4546

4647
* Update the version number according to the versioning policy (defined in :need:`doc__platform_release_management_plan`).
4748
* Prepare release notes documenting the changes, improvements, and bug fixes.
48-
* Ensure the relevant safety packages are available.
49+
* Ensure the relevant safety packages are available and complete.
4950
* Tag the release in the GitHub repository.
5051

5152
5. **Release Execution**:
@@ -78,9 +79,9 @@ Platform Release
7879
4. **Release Preparation**:
7980

8081
* Check if modules are released.
81-
* Update the platform version number according to the versioning policy.
82+
* Update the platform version number according to the versioning policy (defined in :need:`doc__platform_release_management_plan`).
8283
* Prepare platform release notes summarizing the updates from all integrated software modules.
83-
* Ensure the relevant safety packages are available.
84+
* Ensure the relevant safety packages are available and complete.
8485
* Tag the platform release in the GitHub repository.
8586

8687
5. **Release Execution**:

docs/process/process_areas/release_management/release_concept.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,7 @@ Concept Description
1717

1818
.. doc_concept:: Concept Description
1919
:id: doc_concept__rel__process
20-
:status: draft
21-
:tags: release_management
20+
:status: valid
2221

2322
This section describes the general concept for the release management process.
2423
The release process can be separated into two parts. On the first level are the software module

docs/process/process_areas/release_management/release_roles.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,4 @@ Contributing Roles:
2323
* :need:`Project Lead <rl__project_lead>`
2424

2525
A detailed overview of the responsibility for the steps of the Release Management process
26-
is listed here:
27-
28-
:ref:`workflow_release`
26+
is listed here: :need:`doc_concept__rel__process`

docs/process/process_areas/release_management/release_workflow.rst

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,54 +18,50 @@ Workflow Release Management
1818

1919
.. workflow:: Create/Maintain Module Release Note
2020
:id: wf__rel__mod_rel_note
21-
:status: draft
22-
:tags: release_management
21+
:status: valid
2322
:responsible: rl__technical_lead
2423
:approved_by: rl__project_lead
2524
:input: wp__module_safety_package, wp__module_sw_release_plan, wp__verification__module_ver_report
2625
:output: wp__module_sw_release_note
27-
:contains: gd_temp__rel__mod_rel_note
28-
:has: doc_concept__req__process, doc_concept__req__process
26+
:contains: gd_temp__rel__mod_rel_note, gd_guidl__rel_management
27+
:has: doc_concept__rel__process
2928

3029
The module release note is created for each release by the module technical lead. It may be updated
3130
later in case of bugs found after the release is published.
3231

3332
.. workflow:: Create/Maintain Platform Release Note
3433
:id: wf__rel__platform_rel_note
35-
:status: draft
36-
:tags: release_management
34+
:status: valid
3735
:responsible: rl__technical_lead
3836
:approved_by: rl__project_lead
3937
:input: wp__platform_safety_package, wp__platform_sw_release_plan, wp__verification__platform_ver_report
40-
:output: wp__module_sw_release_note
41-
:contains: gd_temp__rel__mod_rel_note
42-
:has: doc_concept__req__process, doc_concept__req__process
38+
:output: wp__platform_sw_release_note
39+
:contains: gd_temp__rel__plat_rel_note, gd_guidl__rel_management
40+
:has: doc_concept__rel__process
4341

4442
The platform release note is created for each release by the technical lead circle. It may be updated
4543
later in case of bugs found after the release is published.
4644

4745
.. workflow:: Plan Module Release
4846
:id: wf__rel__mod_rel_plan
49-
:status: draft
50-
:tags: release_management
47+
:status: valid
5148
:responsible: rl__technical_lead
5249
:approved_by: rl__project_lead
53-
:input: wp__module_safety_package, wp__issue_track_system, wp__platform_mgmt
54-
:output: wp__module_sw_release_note
55-
:contains: gd_temp__rel__issue
50+
:input: wp__issue_track_system, wp__platform_mgmt
51+
:output: wp__module_sw_release_plan
52+
:contains: gd_temp__rel__issue, gd_guidl__rel_management
5653
:has: doc_concept__rel__process
5754

5855
The module release plan is created as part of the modules planning and documented as part of the module's project planning.
5956

6057
.. workflow:: Plan Platform Release
61-
:id: wf__rel__issue
62-
:status: draft
63-
:tags: release_management
58+
:id: wf__rel__plat_rel_plan
59+
:status: valid
6460
:responsible: rl__technical_lead
6561
:approved_by: rl__project_lead
66-
:input: wp__module_safety_package, wp__platform_safety_package, wp__issue_track_system, wp__platform_mgmt
67-
:output: wp__module_sw_release_note
68-
:contains: gd_temp__rel__mod_rel_note
62+
:input: wp__issue_track_system, wp__platform_mgmt
63+
:output: wp__platform_sw_release_plan
64+
:contains: gd_temp__rel__issue, gd_guidl__rel_management
6965
:has: doc_concept__rel__process
7066

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

0 commit comments

Comments
 (0)