Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions process/process_areas/release_management/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,17 @@
.. _release_management:

Release Management
########################
##################

.. toctree::
:maxdepth: 1

release_getstrt
release_concept
release_workflow
guidance/index
release_workproducts
release_roles
release_workflow
release_workproducts

.. needextend:: docname is not None and "process_areas/release_management" in docname
:+tags: release_mgt
45 changes: 45 additions & 0 deletions process/process_areas/release_management/release_getstrt.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
..
# *******************************************************************************
# 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
# *******************************************************************************

Getting Started
###############

.. doc_getstrt:: Getting Started on Release Management
:id: doc_getstrt__release_process
:status: valid
:tags: release_mgt

This document describes the steps to create a release of the SW and collaterals (test, documentation).

Releases can be done in every repository, mainly:

* Platform (Main project/Integration) repository
* Module (platform's components) repositories

For this a templates :need:`gd_temp__rel_plat_rel_note` & :need:`gd_temp__rel_mod_rel_note`, guidelines
:need:`gd_guidl__rel_management` and a :need:`doc_concept__rel_process`
are available.

General Workflow
****************

The workflows are defined in the :ref:`release_workflows` section.

The following workflows are executed:

* Create a release plan for the platform according to :need:`wf__rel_plat_rel_plan`
* Create a release plan for the module according to :need:`wf__rel_mod_rel_plan`
* According to the planning create release notes for modules :need:`wf__rel_mod_rel_note` and platform :need:`wf__rel_platform_rel_note`

In addition create a release management plan as part of the platform management plan according to :need:`wf__platform_cr_mt_platform_mgmt_plan`.
22 changes: 17 additions & 5 deletions process/process_areas/release_management/release_workflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

.. _release_workflows:

Workflow Release Management
#################################
###########################

.. workflow:: Create/Maintain Module Release Note
:id: wf__rel_mod_rel_note
Expand All @@ -24,7 +25,7 @@ Workflow Release Management
:input: wp__module_safety_package, wp__module_sw_release_plan, wp__verification_module_ver_report
:output: wp__module_sw_release_note
:contains: gd_temp__rel_mod_rel_note, gd_guidl__rel_management
:has: doc_concept__rel_process
:has: doc_concept__rel_process, doc_getstrt__release_process

The module release note is created for each release by the module technical lead. It may be updated
later in case of bugs found after the release is published.
Expand All @@ -37,7 +38,7 @@ Workflow Release Management
:input: wp__platform_safety_package, wp__platform_sw_release_plan, wp__verification_platform_ver_report
:output: wp__platform_sw_release_note
:contains: gd_temp__rel_plat_rel_note, gd_guidl__rel_management
:has: doc_concept__rel_process
:has: doc_concept__rel_process, doc_getstrt__release_process

The platform release note is created for each release by the technical lead circle. It may be updated
later in case of bugs found after the release is published.
Expand All @@ -50,7 +51,7 @@ Workflow Release Management
:input: wp__issue_track_system, wp__platform_mgmt
:output: wp__module_sw_release_plan
:contains: gd_temp__rel_issue, gd_guidl__rel_management
:has: doc_concept__rel_process
:has: doc_concept__rel_process, doc_getstrt__release_process

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

Expand All @@ -62,6 +63,17 @@ Workflow Release Management
:input: wp__issue_track_system, wp__platform_mgmt
:output: wp__platform_sw_release_plan
:contains: gd_temp__rel_issue, gd_guidl__rel_management
:has: doc_concept__rel_process
:has: doc_concept__rel_process, doc_getstrt__release_process

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

RAS(IC) for Release Management:
*******************************

.. needtable:: RASIC Overview for Release Management
:tags: release_mgt
:filter: "release_mgt" in tags and type == "workflow" and is_external == False
:style: table
:sort: status
:columns: id as "Activity";responsible as "Responsible";approved_by as "Approver";supported_by as "Supporter"
:colwidths: 30,30,30,30
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
# SPDX-License-Identifier: Apache-2.0
# *******************************************************************************

Workproducts
############
Work Products Release Management
################################

.. workproduct:: Platform Release Notes
:id: wp__platform_sw_release_note
Expand Down
Loading