From 55dc75d92d0ad590457db4138ca3e32e9ce431ce Mon Sep 17 00:00:00 2001 From: Ryotaro Banno Date: Thu, 27 Jun 2024 05:21:14 +0000 Subject: [PATCH] update docs/maintenance.md Signed-off-by: Ryotaro Banno --- docs/maintenance.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/maintenance.md b/docs/maintenance.md index d455152..b542186 100644 --- a/docs/maintenance.md +++ b/docs/maintenance.md @@ -30,7 +30,7 @@ We should also update go.mod by the following commands. Please note that Kuberne ```bash $ VERSION= -$ go get k8s.io/api@v${VERSION} k8s.io/apimachinery@v${VERSION} k8s.io/client-go@v${VERSION} +$ go get k8s.io/api@v${VERSION} k8s.io/apimachinery@v${VERSION} k8s.io/client-go@v${VERSION} k8s.io/component-helpers@v${VERSION} ``` Read the [`controller-runtime`'s release note](https://github.com/kubernetes-sigs/controller-runtime/releases), and update to the newest version that is compatible with all supported kubernetes versions. If there are breaking changes, we should decide how to manage these changes. @@ -57,18 +57,27 @@ Edit the following files. The following tools do not depend on other software, use latest versions. To change their versions, edit `versions.mk`. - [kind](https://github.com/kubernetes-sigs/kind/releases) + - Update `KIND_NODE_VERSION` in `versions.mk`, too. - [helm](https://github.com/helm/helm/releases) - [kustomize](https://github.com/kubernetes-sigs/kustomize/releases) +- [chart-testing](https://github.com/helm/chart-testing/releases) #### Depending modules -Read `kubernetes' go.mod`(https://github.com/kubernetes/kubernetes/blob/\/go.mod), and update the `prometheus/*` modules. Here is the example to update `prometheus/client_golang`. +Read `kubernetes' go.mod`(https://github.com/kubernetes/kubernetes/blob//go.mod), and update the `prometheus/*` modules. Here is the example to update `prometheus/client_golang`. ``` $ VERSION= $ go get github.com/prometheus/client_golang@v${VERSION} ``` +The following modules don't depend on other softwares, so use their latest versions: +- [github.com/onsi/ginkgo/v2](https://github.com/onsi/ginkgo/releases) +- [github.com/onsi/gomega](https://github.com/onsi/gomega/releases) +- [github.com/spf13/cobra](https://github.com/spf13/cobra/releases) +- [k8s.io/klog/v2](https://github.com/kubernetes/klog/releases) +- [sigs.k8s.io/yaml](https://github.com/kubernetes-sigs/yaml/releases) + Then, please tidy up the dependencies. ```bash