Mature Release Process

From fd.io
Revision as of 08:37, 11 January 2018 by Gzhao (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Introduction

This section is an attempt to provide convenient material in support of the Technical Community Charter (TCC) section 3.4 Mature Release process.

A Project’s Committers make all decisions about Releases of that Project. However, to be eligible to be considered ‘Mature’, and project must demonstrate a history of following the Mature Release Process. The purpose of the Mature Release Process is to insure openness and maximum opportunity for participation. The idea is to have a simple, clear, public declaration of what a project intends to do and when, and what was actually done in a release cycle. Towards that end, a project following the ‘Mature Release Process’ should have a Release Plan published at the beginning of its release cycle by its committers, and a Release Review just prior to the project release. Both Release Plan and Release Review documents are intended to be relatively short, simple, and posted publicly on the wiki to assist project in coordinating amount themselves and the general world in gaining visibility.

Release Plans

Recommendations on Placement of Release Plans

It is recommended that projects create their Release Plan in the wiki in a uniform way at ${url of project page}/Release_Plans/Release_Plan_${release version}. Example: If a projects page is at https://wiki.fd.io/view/Projects/Foo and it is doing release planning for release 1.1.0, then its release plan would then be:

https://wiki.fd.io/view/Projects/Foo/Release_Plans/Release_Plan_1.1.0

Recommended Release Plan Template

There is a Release Plan template. When you go to create your Release Plan page, you can easily copy in the template by appending

?action=edit&preload=Mature_Release_Process/Release_Plan_Template

to the URL for the page you are creating. Example:

https://wiki.fd.io/view/Projects/Foo/Release_Plans/Release_Plan_1.1.0?action=edit&preload=Mature_Release_Process/Release_Plan_Template

Release Reviews

Recommendations on Placement of Release Reviews

It is recommended that projects create their Release Review in the wiki in a uniform way at ${url of project page}/Release_Reviewss/Release_Review_${release version}. Example: If a projects page is at https://wiki.fd.io/view/Projects/Foo and it is doing release planning for release 1.1.0, then its release plan would then be:

https://wiki.fd.io/view/Projects/Foo/Release_Reviews/Release_Review_1.1.0

Recommended Release Review Template

There is a Release Review Template. When you go to create your Release Review, you can copy in this template by appending

?action=edit&preload=Mature_Release_Process/Release_Review_Template

to to the URL for the page you are creating. Example:

https://wiki.fd.io/view/Projects/Foo/Release_Reviewss/Release_Review_1.1.0?action=edit&preload=Mature_Release_Process/Release_Review_Template

Scheduling your Release Review

You should schedule a Release Review when you are ready to 'Release' to the world. This should be clearly communicated, so folks can attend and ask questions. It is fine to use your projects weekly meeting slot for this Release Review. It is polite to invite the TSC to attend by emailing them.