Files
onepassword-operator/vendor/sigs.k8s.io/controller-runtime/RELEASE.md
Eduard Filip f72e5243b0 Upgrade the operator to use Operator SDK v1.33.0 (#182)
* Move controller package inside internal directory

Based on the go/v4 project structure, the following changed:
- Pakcage `controllers` is now named `controller`
- Package `controller` now lives inside new `internal` directory

* Move main.go in cmd directory

Based on the new go/v4 project structure, `main.go` now lives in the `cmd` directory.

* Change package import in main.go

* Update go mod dependencies

Update the dependencies based on the versions obtained by creating a new operator project using `kubebuilder init --domain onepassword.com --plugins=go/v4`.

This is based on the migration steps provided to go from go/v3 to go/v4 (https://book.kubebuilder.io/migration/migration_guide_gov3_to_gov4)

* Update vendor

* Adjust code for breaking changes from pkg update

sigs.k8s.io/controller-runtime package had breaking changes from v0.14.5 to v0.16.3. This commit brings the changes needed to achieve the same things using the new functionality avaialble.

* Adjust paths to connect yaml files

Since `main.go` is now in `cmd` directory, the paths to the files for deploying Connect have to be adjusted based on the new location `main.go` is executed from.

* Update files based on new structure and scaffolding

These changes are made based on the new project structure and scaffolding obtained when using the new go/v4 project structure.

These were done based on the migration steps mentioned when migrating to go/v4 (https://book.kubebuilder.io/migration/migration_guide_gov3_to_gov4).

* Update config files

These updates are made based on the Kustomize v4 syntax.

This is part of the upgrate to go/v4 (https://book.kubebuilder.io/migration/migration_guide_gov3_to_gov4)

* Update dependencies and GO version

* Update vendor

* Update Kubernetes tools versions

* Update operator version in Makefile

Now the version in the Makefile matches the version of the operator

* Update Operator SDK version in version.go

* Adjust generated deepcopy

It seems that the +build tag is no longer needed based on the latest generated scaffolding, therefore it's removed.

* Update copyright year

* Bring back missing changes from migration

Some customization in Makefile was lost during the migration process. Specifically, the namespace customization for `make deploy` command.

Also, we push changes to kustomization.yaml for making the deploy process smoother.

* Add RBAC perms for coordination.k8s.io

It seems that with the latest changes to Kubernetes and Kustomize, we need to add additional RBAC to the service account used so that it can properly access the `leases` resource.

* Optimize Dockerfile

Dockerfile had a step for caching dependencies (go mod download). However, this is already done by the vendor directory, which we include. Therefore, this step can be removed to make the image build time faster.
2024-01-25 14:21:31 +01:00

2.2 KiB

Release Process

The Kubernetes controller-runtime Project is released on an as-needed basis. The process is as follows:

Note: Releases are done from the release-MAJOR.MINOR branches. For PATCH releases is not required to create a new branch you will just need to ensure that all big fixes are cherry-picked into the respective release-MAJOR.MINOR branch. To know more about versioning check https://semver.org/.

How to do a release

Create the new branch and the release tag

  1. Create a new branch git checkout -b release-<MAJOR.MINOR> from main
  2. Push the new branch to the remote repository

Now, let's generate the changelog

  1. Create the changelog from the new branch release-<MAJOR.MINOR> (git checkout release-<MAJOR.MINOR>). You will need to use the [kubebuilder-release-tools][kubebuilder-release-tools] to generate the notes. See [here][release-notes-generation]

Note

  • You will need to have checkout locally from the remote repository the previous branch
  • Also, ensure that you fetch all tags from the remote git fetch --all --tags

Draft a new release from GitHub

  1. Create a new tag with the correct version from the new release-<MAJOR.MINOR> branch
  2. Add the changelog on it and publish. Now, the code source is released !

Add a new Prow test the for the new branch release

  1. Create a new prow test under github.com/kubernetes/test-infra/tree/master/config/jobs/kubernetes-sigs/controller-runtime for the new release-<MAJOR.MINOR> branch. (i.e. for the 0.11.0 release see the PR: https://github.com/kubernetes/test-infra/pull/25205)
  2. Ping the infra PR in the controller-runtime slack channel for reviews.

Announce the new release:

  1. Publish on the Slack channel the new release, i.e:
:announce: Controller-Runtime v0.12.0 has been released!
This release includes a Kubernetes dependency bump to v1.24.
For more info, see the release page: https://github.com/kubernetes-sigs/controller-runtime/releases.
 :tada:  Thanks to all our contributors!
  1. An announcement email is sent to kubebuilder@googlegroups.com with the subject [ANNOUNCE] Controller-Runtime $VERSION is released