From ae71ec35d019f9e9711a6cce5d1f75f5930b0a49 Mon Sep 17 00:00:00 2001 From: Oliver Love Date: Tue, 26 Sep 2023 17:33:32 -0400 Subject: [PATCH] Adjust readme with steps to release and update dependencies --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index d6c94ece..4648f4ec 100644 --- a/README.md +++ b/README.md @@ -112,6 +112,26 @@ make uninstall 4. `go build .` 5. Now move the generated `kustomize` binary into the `bin` directory in this project (create it if it doesn't exist `mkdir bin`): `mv kustomize /bin/kustomize` +### Update Go and dependencies +1. Update Go version in + 1. [go.mod](./go.mod) + 2. [.github/workflows/release.yml](./.github/workflows/release.yml) + 3. [.github/workflows/test.yml](./.github/workflows/test.yml) + 4. [Dockerfile](./Dockerfile) +2. Update Go dependencies + ```shell + go get -u ./... + go mod tidy + go mod vendor + ``` +3. Run `make test` +4. Create and merge PR + +### Release +1. Create release manifest files by running `IMG_TAG=vX.Y.Z make release-manifests` +2. Create and merge PR +3. [Trigger the `release` GitHub action workflow](https://github.com/digitalocean/do-operator/actions/workflows/release.yml) + ## Contributing At DigitalOcean we value and love our community!