Skip to content

Latest commit

 

History

History
65 lines (35 loc) · 2.33 KB

RELEASE-PROCESS.md

File metadata and controls

65 lines (35 loc) · 2.33 KB
Raw

Release Process

The release process of a new version of OpenYurt involves the following:

(Currently only the maintainers are eligible to release a new version)

0. Prerequisites

Look at the last release in the releases page:

  • For example, at the time of writing, it was v1.2.1
  • The next version will thus be v1.3.0

1. Changelog

Add a new section in CHANGELOG.md for the new version that is being released along with the new features, patches and deprecations it introduces.

It should not include every single change but solely what matters to our customers, for example issue template that has changed is not important.

2. Publish documentation for new version

Publish documentation for new version on https://openyurt.io.

Fork openyurtio/openyurt.io, create a version from current using yarn run docusaurus docs:version <VERSION>.

3. Create OpenYurt release on GitHub

Creating a new release in the releases page will trigger a GitHub workflow which will create a new image with the latest code and tagged with the next version (in this example v1.2.0).

4. Release template

Every release should use the template provided below to create the GitHub release.

Here's the template:

## v1.2.0

### What's New

### Other Notable changes

### Fixes

### Contributors

**Thank you to everyone who contributed to this release!** ❤

5. Prepare our Helm Chart

Before we can release our new Helm chart version, we need to prepare it:

  1. Create a new chart version with the updated version and appVersion in openyurt charts.
  2. Update the CRDs & Kubernetes resources based on the release artifact (YAML)

6. Prepare next release

As per our release governance, we need to create a new shipping cycle in our project settings with a target date in 2 to 3 months after the last cycle.

Lastly, a new milestone should be created to maintain the changes of next release.

7. Announcement

Announce the new release in Slack channel, DingTalk and WeChat groups.