[docs] Document the release management principles #9974

rtsisyk · 2024-12-30T12:26:40Z

rtsisyk commented

2024-12-30 12:26:40 +00:00

No description provided.

👍 1

vng (Migrated from github.com) reviewed 2024-12-30 12:26:40 +00:00

oleg-rswll reviewed 2024-12-30 12:26:40 +00:00

pastk reviewed 2025-01-01 17:16:23 +00:00

docs/RELEASE_MANAGEMENT.md

pastk commented

2025-01-01 16:39:08 +00:00

## Guidelines

A more common term for English-speakers?

```suggestion ## Guidelines ``` A more common term for English-speakers?

pastk commented

2025-01-01 16:39:16 +00:00

The release management follows the **Fixed-Time, Variable-Scope** principle. This means that releases occur on a **predictable** schedule, while the scope of each release **may vary**.

```suggestion The release management follows the **Fixed-Time, Variable-Scope** principle. This means that releases occur on a **predictable** schedule, while the scope of each release **may vary**. ```

pastk commented

2025-01-01 16:42:57 +00:00

Everyone should expect that each release will include only what was finished on time and **won't be delayed** to include any particular "almost ready" change (there could be exceptions for important hot fixes only).

```suggestion Everyone should expect that each release will include only what was finished on time and **won't be delayed** to include any particular "almost ready" change (there could be exceptions for important hot fixes only). ```

pastk commented

2025-01-01 16:51:03 +00:00

Hence the scope of each release **may vary** based on the readiness of the features. Volunteer Contributors work at their own pace while the funded work adheres to the scope and schedule outlined in the agreed project plan.

Seems like too much detail about funded work planning not really related to releases?..

```suggestion Hence the scope of each release **may vary** based on the readiness of the features. Volunteer Contributors work at their own pace while the funded work adheres to the scope and schedule outlined in the agreed project plan. ``` Seems like too much detail about funded work planning not really related to releases?..

pastk commented

2025-01-01 16:57:05 +00:00

Each release has one person appointed as the Release Manager to oversee the upcoming release.

```suggestion Each release has one person appointed as the Release Manager to oversee the upcoming release. ```

pastk commented

2025-01-01 16:58:09 +00:00

It is the duty of the Release Manager to drive the entire process to the successful completion, utilizing all available resources and means. Specific tasks may be delegated to individual team members as required.

```suggestion It is the duty of the Release Manager to drive the entire process to the successful completion, utilizing all available resources and means. Specific tasks may be delegated to individual team members as required. ```

pastk commented

2025-01-01 16:58:54 +00:00

The person holds the authority to make final decisions on cut-off and release dates, and can exclude or revert changes to ensure the release schedule and quality targets are met.

```suggestion The person holds the authority to make final decisions on cut-off and release dates, and can exclude or revert changes to ensure the release schedule and quality targets are met. ```

pastk commented

2025-01-01 17:16:02 +00:00

### Release Tracking

Each release should have its own Release Tracking Issue on GitHub, which contains a schedule and a checklist of items to be executed in the correct order.

Also each release should have a dedicated 20YY.MM github milestone. All contributors are encouraged to use it for organizing their work and to communicate clearly with the Release Manager about their schedules, as well as any potential risks or regressions after merging each feature.

Any regressions discovered must be filed as blocking bug tickets and added to the milestone with a clear and understandable description. Contributors are encouraged to proactively revert their changes if it is unrealistic to stabilize them before the cut-off date.

Any decision made must be documented in writing within the Release Tracking Issue, ensuring that the motivation and reasoning are clear and understandable to all.

IMHO it was too many sub-titles each containing just one line of text.

```suggestion ### Release Tracking Each release should have its own Release Tracking Issue on GitHub, which contains a schedule and a checklist of items to be executed in the correct order. Also each release should have a dedicated 20YY.MM github milestone. All contributors are encouraged to use it for organizing their work and to communicate clearly with the Release Manager about their schedules, as well as any potential risks or regressions after merging each feature. Any regressions discovered must be filed as blocking bug tickets and added to the milestone with a clear and understandable description. Contributors are encouraged to proactively revert their changes if it is unrealistic to stabilize them before the cut-off date. Any decision made must be documented in writing within the Release Tracking Issue, ensuring that the motivation and reasoning are clear and understandable to all. ``` IMHO it was too many sub-titles each containing just one line of text.

docs/RELEASE_MANAGEMENT.md

					
				@ -6,0 +20,4 @@

				### Schedule vs Scope

				Each release aims to include all features that have been merged into the master branch before the release cut-off date and have not caused regressions during the QA validation process. If certain changes are not included in the current release, they will be postponed to the next one.

pastk commented

2025-01-01 16:55:55 +00:00

I'd just merge this section into the previous one and make it shorter overall (the following paragraphs convey the same meaning as above, but are more detailed)