Skip to content

Latest commit

 

History

History
134 lines (74 loc) · 5.31 KB

RELEASE-PROCESS.md

File metadata and controls

134 lines (74 loc) · 5.31 KB
Raw

Release Process

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

0. Prerequisites

Look at the last release in the releases page:

  • For example, at the time of writing, it was 2.3.0
  • The next version will thus be 2.4.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. Add the new version to GitHub Bug report template

Add the new released version to the list in KEDA Version dropdown in 3_bug_report.yml.

3. Create KEDA release on GitHub

Creating a new release in the releases page (https://github.com/kedacore/keda/releases) will trigger a GitHub workflow which will create a new image with the latest code (read note 2 below) and tagged with the next version (in this example 2.4.0).

KEDA Deployment YAML file (eg. keda-2.4.0.yaml) is also automatically created and attached to the Release as part of the workflow.

Note: The container registry repo with all the different images can be seen here

Note 2: Depending on the release type (minor version or hotfix), the tag should be created from main (for minor version releases) or from version branch (for hotfix releases)

Release template

Every release should use the template provided below to create the GitHub release and ensure that a new GitHub Discussion is created.

💡 IMPORTANT

Remember to make the following changes to the template:

  • Replace INSERT-CORRECT-VERSION (there are two occurrences in the template) with the new-release ID
  • Update the list of new contributors

Here's the template:

We are happy to release KEDA INSERT-CORRECT-VERSION 🎉

Here are some highlights:

- <list highlights>

Here are the new deprecation(s) as of this release:
- <list deprecations>

Learn how to deploy KEDA by reading [our documentation](https://keda.sh/docs/INSERT-CORRECT-VERSION/deploy/).

🗓️ The next KEDA release is currently being estimated for <date>, learn more in our [roadmap](https://github.com/kedacore/keda/blob/main/ROADMAP.md#upcoming-release-cycles).

### New

- <list items>

### Improvements

- <list items>

### Breaking Changes

- <list items>

### Other

- <list items>

### New Contributors

<generated new contributors info>

Generating new contributor's info

In order to generate a list of new contributors, use the Auto-generate release notes GitHub feature of the release.

Screenshot

image

4. Publish documentation for new version

Publish documentation for new version on https://keda.sh. For details, see Publishing a new version.

Note: During hotfix releases, this step isn't required as we don't introduce new features

5. Setup continous container scanning with Snyk

In order to continuously scan our new container image, they must be imported in our Snyk project for all newly introduced tags.

Prune old versions of images. Keep only one version for a 3 last minor releases (eg. keep only 2.10.1, 2.11.1 and 2.12.0).

Learn more on how to do this through the Snyk documentation.

Note: Remember to enable the check Without issues in order to get the new version listed since probably it hasn't got any issue.

6. Prepare our Helm Chart

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

  • Update the version and appVersion in our chart definition.
  • Update the CRDs & Kubernetes resources based on the release artifact (YAML)

7. Ship new Helm chart

Guidance on how to release it can be found in our contribution guide.

8. 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 3 months after the last cycle.

We need to make sure that the current sprint's items are changed from status Ready to ship to Done.

Lastly, the Upcoming Release Cycles overview in ROADMAP.md should be updated with the new cycle.

In case of minor releases, we need to create the version branch (release/v2.x) from the release tag which will be used to include any required hotfix in the future.

9. Tweet! 🐦

Prepare a tweet with some highlights and send it out on @kedaorg!

If you don't have access, ask a maintainer who has access to the account (see 1Password).