You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

44 lines
2.8 KiB

  1. # Release Process
  2. The Kubespray Project is released on an as-needed basis. The process is as follows:
  3. 1. An issue is proposing a new release with a changelog since the last release
  4. 2. At least one of the [approvers](OWNERS_ALIASES) must approve this release
  5. 3. 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
  6. 4. An approver creates a release branch in the form `release-X.Y`
  7. 5. The corresponding version of [quay.io/kubespray/kubespray:vX.Y.Z](https://quay.io/repository/kubespray/kubespray) docker image is built and tagged
  8. 6. The `KUBESPRAY_VERSION` variable is updated in `.gitlab-ci.yml`
  9. 7. The release issue is closed
  10. 8. An announcement email is sent to `kubernetes-dev@googlegroups.com` with the subject `[ANNOUNCE] Kubespray $VERSION is released`
  11. 9. The topic of the #kubespray channel is updated with `vX.Y.Z is released! | ...`
  12. ## Major/minor releases, merge freezes and milestones
  13. * Kubespray maintains one branch for major releases (vX.Y). Minor releases are available only as tags.
  14. * Security patches and bugs might be backported.
  15. * Fixes for major releases (vX.x.0) and minor releases (vX.Y.x) are delivered
  16. via maintenance releases (vX.Y.Z) and assigned to the corresponding open
  17. milestone (vX.Y). That milestone remains open for the major/minor releases
  18. support lifetime, which ends once the milestone closed. Then only a next major
  19. or minor release can be done.
  20. * Kubespray major and minor releases are bound to the given ``kube_version`` major/minor
  21. version numbers and other components' arbitrary versions, like etcd or network plugins.
  22. Older or newer versions are not supported and not tested for the given release.
  23. * There is no unstable releases and no APIs, thus Kubespray doesn't follow
  24. [semver](http://semver.org/). Every version describes only a stable release.
  25. Breaking changes, if any introduced by changed defaults or non-contrib ansible roles'
  26. playbooks, shall be described in the release notes. Other breaking changes, if any in
  27. the contributed addons or bound versions of Kubernetes and other components, are
  28. considered out of Kubespray scope and are up to the components' teams to deal with and
  29. document.
  30. * Minor releases can change components' versions, but not the major ``kube_version``.
  31. Greater ``kube_version`` requires a new major or minor release. For example, if Kubespray v2.0.0
  32. is bound to ``kube_version: 1.4.x``, ``calico_version: 0.22.0``, ``etcd_version: v3.0.6``,
  33. then Kubespray v2.1.0 may be bound to only minor changes to ``kube_version``, like v1.5.1
  34. and *any* changes to other components, like etcd v4, or calico 1.2.3.
  35. And Kubespray v3.x.x shall be bound to ``kube_version: 2.x.x`` respectively.