-
Notifications
You must be signed in to change notification settings - Fork 6.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adjust the releases process documentation. (#10727)
* markdown numbered lists: no need to manually maitain the numbers * add instructions to update the collection version roughly following Ansible collection maintenance guidelines (https://docs.ansible.com/ansible/latest/community/collection_contributors/collection_release_with_branches.html) * Distinguish major from minor releases in the release process * Bump current galaxy.yml version to the next release
- Loading branch information
Showing
1 changed file
with
13 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,17 +3,19 @@ | |
The Kubespray Project is released on an as-needed basis. The process is as follows: | ||
|
||
1. An issue is proposing a new release with a changelog since the last release. Please see [a good sample issue](https://github.com/kubernetes-sigs/kubespray/issues/8325) | ||
2. At least one of the [approvers](OWNERS_ALIASES) must approve this release | ||
3. The `kube_version_min_required` variable is set to `n-1` | ||
4. Remove hashes for [EOL versions](https://github.com/kubernetes/website/blob/main/content/en/releases/patch-releases.md) of kubernetes from `*_checksums` variables. | ||
5. Create the release note with [Kubernetes Release Notes Generator](https://github.com/kubernetes/release/blob/master/cmd/release-notes/README.md). See the following `Release note creation` section for the details. | ||
6. An approver creates [new release in GitHub](https://github.com/kubernetes-sigs/kubespray/releases/new) using a version and tag name like `vX.Y.Z` and attaching the release notes | ||
7. An approver creates a release branch in the form `release-X.Y` | ||
8. The corresponding version of [quay.io/kubespray/kubespray:vX.Y.Z](https://quay.io/repository/kubespray/kubespray) and [quay.io/kubespray/vagrant:vX.Y.Z](https://quay.io/repository/kubespray/vagrant) container images are built and tagged. See the following `Container image creation` section for the details. | ||
9. The `KUBESPRAY_VERSION` variable is updated in `.gitlab-ci.yml` | ||
10. The release issue is closed | ||
11. An announcement email is sent to `[email protected]` with the subject `[ANNOUNCE] Kubespray $VERSION is released` | ||
12. The topic of the #kubespray channel is updated with `vX.Y.Z is released! | ...` | ||
1. At least one of the [approvers](OWNERS_ALIASES) must approve this release | ||
1. (Only for major releases) The `kube_version_min_required` variable is set to `n-1` | ||
1. (Only for major releases) Remove hashes for [EOL versions](https://github.com/kubernetes/website/blob/main/content/en/releases/patch-releases.md) of kubernetes from `*_checksums` variables. | ||
1. Create the release note with [Kubernetes Release Notes Generator](https://github.com/kubernetes/release/blob/master/cmd/release-notes/README.md). See the following `Release note creation` section for the details. | ||
1. An approver creates [new release in GitHub](https://github.com/kubernetes-sigs/kubespray/releases/new) using a version and tag name like `vX.Y.Z` and attaching the release notes | ||
1. (Only for major releases) An approver creates a release branch in the form `release-X.Y` | ||
1. (For major releases) On the `master` branch: bump the version in `galaxy.yml` to the next expected major release (X.y.0 with y = Y + 1), make a Pull Request. | ||
1. (For minor releases) On the `release-X.Y` branch: bump the version in `galaxy.yml` to the next expected minor release (X.Y.z with z = Z + 1), make a Pull Request. | ||
1. The corresponding version of [quay.io/kubespray/kubespray:vX.Y.Z](https://quay.io/repository/kubespray/kubespray) and [quay.io/kubespray/vagrant:vX.Y.Z](https://quay.io/repository/kubespray/vagrant) container images are built and tagged. See the following `Container image creation` section for the details. | ||
1. (Only for major releases) The `KUBESPRAY_VERSION` in `.gitlab-ci.yml` is upgraded to the version we just released # TODO clarify this, this variable is for testing upgrades. | ||
1. The release issue is closed | ||
1. An announcement email is sent to `[email protected]` with the subject `[ANNOUNCE] Kubespray $VERSION is released` | ||
1. The topic of the #kubespray channel is updated with `vX.Y.Z is released! | ...` | ||
|
||
## Major/minor releases and milestones | ||
|
||
|