Concept Description#

Concept Description
status: valid
tags: release_mgt
relates to: wf__rel_mod_rel_note, wf__rel_platform_rel_note, wf__rel_mod_rel_plan, wf__rel_plat_rel_plan
doc_concept__rel_process
Concept Definition

This section describes the general concept for the release management process. The release process can be separated into two parts. On the first level are the software module releases. These are independent from the platform and can be separated over various repositories. Once a software module is released it can be contained within a platform release which can include multiple software module releases within a platform release scope.

Inputs#

  1. Module safety package

  2. Platform safety package

  3. Module verification report

  4. Platform verification report

  5. Issue tracking system

  6. Platform Management Plan

Outputs#

  1. Module release plan

  2. Module release note

  3. Platform release plan

  4. Platform release note

Platform Release Plan#

The platform release plan provides a reliable plan on what software modules can be expected in the upcoming platform release. The platform release plan is reflected by feature requests which are demanded. Therefore it is of importance that the Project Leads on platform level are aligned with the various software Module Leads and to align the platform release plan properly with the module release plan as the platform release plan has a clear dependency on its output.

  1. Project Lead Circle (rl__project_lead)

    • Defines and proposes scope of individual module release

    • Creates and maintains the platform release plan

    • Aligns module release timeline with platform release plan

    • Approves the platform release plan

Platform Release#

The Platform Release contains the full <Project> scope which spans over many modules. The releases are proposed and approved by Project Leads. Every software module has its own repository which contains multiple components, their requirements, architecture, implementation and tests.

  1. Project Lead Circle (rl__project_lead)

    • Define and proposes scope of release

    • Writes platform release notes

    • Approves the platform release notes

    • Adds and removes software modules to the platform

    • Releases the platform

Module Release Plan#

The module release plan gives a guidance when certain features can be expected on a module level. It is created by the respective Module Leads.

  1. Committer (acting as Module Lead) (rl__committer)

    • Define and proposes scope of individual module Release

    • Creates and maintains the module release plan

  2. Project Lead Circle (rl__project_lead)

    • Approves the module release plan

Module Release#

Each software module needs to have its dedicated release and the accompanying release notes. Only released software modules can be included into a platform release.

  1. Committer (acting as Module Lead) (rl__committer)

    • Provides the software module release notes

  2. Project Lead Circle (rl__project_lead)

    • Approves the module release notes

    • Adds and removes Software modules to the Platform

    • Releases the module

Branching Strategy#

Branches: * master: for implementation and documentation in development phase. * release/*: Branches for distinct releases, named release/<version-number>, no functional changes, only bugfixes, quality and documentation improvements.

Workflow:

When ready for a new release, create a branch release/<version-number> from master. Perform final testing and adjustments on the release branch. Tag the release in the release branch.