doc: refactor the release process and release management guideline #53
Conversation
Signed-off-by: Feynman Zhou <[email protected]>
FeynmanZhou
requested review from
sabre1041,
sajayantony,
shizhMSFT,
SteveLasker and
TerryHowe
as code owners
Signed-off-by: Feynman Zhou <[email protected]>
|
|
||
| ## Release process | ||
|
|
||
| Before cutting a release for a project, ORAS project maintainers need to open a Pull Request to update version. The release request PR could be merged after a majority of approval from the sub-project maintainers. |
There was a problem hiding this comment.
Is it a two-thirds supermajority or just more than one-half?
There was a problem hiding this comment.
One-half is good enough since we only have 5 maintainers for oras.
One-half means 3 / 5 where two-thirds means 4 / 5.
There was a problem hiding this comment.
Precisely,
| #Maintainers | One-half | Rate | Two-thirds | Rate |
|---|---|---|---|---|
| 1 | 1 | 100% | 1 | 100% |
| 2 | 2 | 100% | 2 | 100% |
| 3 | 2 | 66.7% | 2 | 66.7% |
| 4 | 3 | 75% | 3 | 75% |
| 5 | 3 | 60% | 4 | 80% |
| 6 | 4 | 66.7% | 4 | 66.7% |
| 7 | 4 | 57.1% | 5 | 71.4% |
| 8 | 5 | 62.5% | 6 | 75% |
| 9 | 5 | 55.6% | 6 | 66.7% |
| 10 | 6 | 60% | 7 | 70% |
| 11 | 6 | 54.5% | 8 | 72.7% |
| 12 | 7 | 58.3% | 8 | 66.7% |
There was a problem hiding this comment.
The truth is that we don't have many maintainers for oras.
| ## Glossary of Terms | ||
|
|
||
| - **X.Y.Z** refers to the version (based on git tag) of ORAS sub-project that is released. | ||
| - **Breaking changes** refer to schema changes, flag changes, and behavior changes of ORAS sub-projects that may require existing content to be upgraded and may also introduce changes that could break backward compatibility. |
There was a problem hiding this comment.
I want to call out that breaking changes to experimental features are not considered as breaking changes.
|
|
||
| ## Glossary of Terms | ||
|
|
||
| - **X.Y.Z** refers to the version (based on git tag) of ORAS sub-project that is released. |
There was a problem hiding this comment.
Is that vX.Y.Z or X.Y.Z?
|
|
||
| ### Minor Releases | ||
|
|
||
| - **ALPHA:** X.Y.0-alpha.W, W >= 0 (Branch : main) |
There was a problem hiding this comment.
Why W >= 0? The version 2.0.0-alpha.0 does not make sense to me so as 2.0.0-rc.0.
Should it be W > 0?
|
|
||
| ## Supported Releases | ||
|
|
||
| We expect to "support" n (current) and n-1 major.minor releases. "Support" means we expect users to be running that version in production. For example, when v1.3.0 comes out, v1.1.x will no longer be supported for patches and we encourage users to upgrade to a supported version as soon as possible. Support will be provided best effort by the maintainers via GitHub issues and pull requests. |
There was a problem hiding this comment.
What if v2.0.0 comes out?
|
|
||
| ## Governance | ||
|
|
||
| This ORAS project governance model is described [here][governance] |
There was a problem hiding this comment.
| This ORAS project governance model is described [here][governance] | |
| This ORAS project governance model is described [here][governance]. |
| [owner]: https://github.com/oras-project/community/blob/main/governance/GOVERNANCE.md#oras-org-owners | ||
| [sub-project-owner]: https://github.com/oras-project/community/blob/main/governance/GOVERNANCE.md#subproject-owners | ||
| [governance]: ./GOVERNANCE.md |
There was a problem hiding this comment.
Let's make those links consistent.
|
|
||
| ## Release process | ||
|
|
||
| Before cutting a release for a project, ORAS project maintainers need to open a Pull Request to update version. The release request PR could be merged after a majority of approval from the sub-project maintainers. |
There was a problem hiding this comment.
One-half is good enough since we only have 5 maintainers for oras.
One-half means 3 / 5 where two-thirds means 4 / 5.
|
|
||
| ## Release process | ||
|
|
||
| Before cutting a release for a project, ORAS project maintainers need to open a Pull Request to update version. The release request PR could be merged after a majority of approval from the sub-project maintainers. |
There was a problem hiding this comment.
Precisely,
| #Maintainers | One-half | Rate | Two-thirds | Rate |
|---|---|---|---|---|
| 1 | 1 | 100% | 1 | 100% |
| 2 | 2 | 100% | 2 | 100% |
| 3 | 2 | 66.7% | 2 | 66.7% |
| 4 | 3 | 75% | 3 | 75% |
| 5 | 3 | 60% | 4 | 80% |
| 6 | 4 | 66.7% | 4 | 66.7% |
| 7 | 4 | 57.1% | 5 | 71.4% |
| 8 | 5 | 62.5% | 6 | 75% |
| 9 | 5 | 55.6% | 6 | 66.7% |
| 10 | 6 | 60% | 7 | 70% |
| 11 | 6 | 54.5% | 8 | 72.7% |
| 12 | 7 | 58.3% | 8 | 66.7% |
|
|
||
| ## Release process | ||
|
|
||
| Before cutting a release for a project, ORAS project maintainers need to open a Pull Request to update version. The release request PR could be merged after a majority of approval from the sub-project maintainers. |
There was a problem hiding this comment.
The truth is that we don't have many maintainers for oras.
FeynmanZhou
changed the title
|
Can we revive this? |
fix #52