Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: refactor the release process and release management guideline #53

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
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
78 changes: 78 additions & 0 deletions governance/RELEASE-MANAGEMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Release Management

This document describes ORAS project release management, which includes release versioning, supported releases, and supported upgrades. This document is applicable to all ORAS sub-projects.

## Glossary of Terms

- **X.Y.Z** refers to the version (based on git tag) of ORAS sub-project that is released.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that vX.Y.Z or X.Y.Z?

- **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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to call out that breaking changes to experimental features are not considered as breaking changes.

- **Milestone** GitHub milestones are used by maintainers to manage each release. PRs and Issues for each release should be created as part of a corresponding milestone.
- **Patch releases** refer to applicable fixes, including security fixes, may be backported to support releases, depending on severity and feasibility.

## Release Versioning

ORAS follows the [Semantic Versioning 2.0.0](https://semver.org/) to define the release versioning. All releases will be of the form _vX.Y.Z_ where X is the major version, Y is the minor version and Z is the patch version. This project strictly follows semantic versioning.

The rest of the doc will cover the release process for the following kinds of releases:

### Major Releases

MAJOR version should be considered when there are incompatible API changes or breaking changes.

The ORAS CLI and ORAS-go project reached a stable version. Other sub-projects in Major version zero (0.y.z) is in initial development.

### Minor Releases

- **ALPHA:** X.Y.0-alpha.W, W >= 0 (Branch : main)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

- Alpha release, cut from main branch
- Unstable release which should only be used for early development purposes
- Released as needed before we cut a beta X.Y release
- Not supported
- **BETA:** X.Y.0-beta.W, W >= 0 (Branch : main)
- More stable than the alpha release to be used for testing purposes only
- Beta release, cut from main branch
- Released as needed before we cut a stable X.Y release
- Not supported
- **RC:** X.Y.0-rc.W, W >= 0 (Branch : main)
- Released as needed before we cut a stable X.Y release
- soak for ~ 2 weeks before cutting a stable release
- Bugfixes on new features only as reported through usage
- Release candidate release, cut from main branch
- Not supported
- **STABLE:** X.Y.0 (Branch: main)
- Stable release, cut from main when X.Y milestone is complete
- X.Y release branch cut for subsequent patch releases
- Supported as per the supported releases process defined below

### Patch Releases

- Patch Releases X.Y.Z, Z > 0 (Branch: release-X.Y, only cut when a patch is needed)
- No breaking changes
- Applicable fixes, including security fixes, may be cherry-picked from main into the latest supported minor release-X.Y branches.
- Patch release, cut from a release-X.Y branch

## 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What if v2.0.0 comes out?


We expect users to stay up-to-date with the versions of ORAS sub-projects they use in production, but understand that it may take time to upgrade. We expect users to be running approximately the latest patch release of a given minor release and encourage users to upgrade as soon as possible.

Applicable fixes, including security fixes, may be cherry-picked into the release branch, depending on severity and feasibility. Patch releases are cut from that branch as needed.

## 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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it a two-thirds supermajority or just more than one-half?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One-half is good enough since we only have 5 maintainers for oras.

One-half means 3 / 5 where two-thirds means 4 / 5.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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%

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The truth is that we don't have many maintainers for oras.


The detailed release process of the ORAS CLI project is listed in the [Release checklist](https://oras.land/docs/community/developer_guide#release-checklist).

## Governance

This ORAS project governance model is described [here][governance]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Comment on lines +72 to +74
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make those links consistent.


## Attribution

This document builds on the ideas and implementations of release processes from Notary Project, Kubernetes, Helm, and Gatekeeper.
38 changes: 0 additions & 38 deletions governance/RELEASE-PROCESS.md

This file was deleted.