Skip to content

Commit

Permalink
reorder release process in notes (#1829)
Browse files Browse the repository at this point in the history
Signed-off-by: Zbynek Roubalik <[email protected]>
  • Loading branch information
zroubalik authored May 27, 2021
1 parent b7318e8 commit 29febff
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions RELEASE-PROCESS.MD
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,29 @@ The release process of a new version of KEDA involves the following:
## 0. Prerequisites

Look at the last released version in the releases page: https://github.com/kedacore/keda/releases
For example: currently it is 2.0.0
The next version will thus be 2.1.0
For example: currently it is 2.3.0
The next version will thus be 2.4.0

## 1. Changelog

Provide 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
## 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](https://github.com/kedacore/keda/blob/main/.github/ISSUE_TEMPLATE/3_bug_report.yml).

## 3. Publish documentation for new version

Publish documentation for new version on https://keda.sh.

See [docs](https://github.com/kedacore/keda-docs#publishing-a-new-version).

## 3. Create KEDA release on GitHub
## 4. 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 and tagged with the next version (in this example 2.1.0).
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 and tagged with the next version (in this example 2.4.0).

KEDA Deployment YAML file (eg. keda-2.1.0.yaml) is also automatically created and attached to the Release as part of the workflow.
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 Docker Hub repo with all the different images can be seen here: https://hub.docker.com/r/kedacore/keda/tags
Expand Down Expand Up @@ -62,9 +65,6 @@ Learn how to deploy KEDA by reading [our documentation](https://keda.sh/docs/INS
- <list items>
```

## 4. 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](https://github.com/kedacore/keda/blob/main/.github/ISSUE_TEMPLATE/3_bug_report.yml).

## 5. Update Helm Charts

Update the `version` and `appVersion` in our [chart definition](https://github.com/kedacore/charts/blob/master/keda/Chart.yaml).
Expand Down

0 comments on commit 29febff

Please sign in to comment.