Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Release][Doc] Add instructions to release Go modules. #1546

Merged
merged 2 commits into from
Oct 19, 2023
Merged

[Release][Doc] Add instructions to release Go modules. #1546

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85bc889
update
kevin85421 Oct 19, 2023
ef30a85
update
kevin85421 Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/development/release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,27 @@ You will prompted for a commit reference and an image tag. The commit reference
git push upstream v0.5.0-rc.0
```

* Tag the tip of the release branch as `ray-operator/vX.Y.Z-rc.0`. Without this tag, users won't be able to use `github.com/ray-project/kuberay/[email protected]` to install the Go module. KubeRay starts supporting Go modules from v0.6.0.
```sh
git tag ray-operator/v0.5.0-rc.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can just add it to the CI. https://github.com/ray-project/kuberay/blob/master/.github/workflows/image-release.yaml

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open an issue: #1549

git push upstream ray-operator/v0.5.0-rc.0

# Install the module. This step is highly possible to fail because the module is not available in the proxy server.
go install github.com/ray-project/kuberay/[email protected]

# Make the module available by running the go list command to prompt Go to update its index of modules with information about the module you’re publishing.
# See https://go.dev/doc/modules/publishing for more details.
GOPROXY=proxy.golang.org go list -m github.com/ray-project/kuberay/[email protected]
# [Expected output]: github.com/ray-project/kuberay/ray-operator v0.5.0-rc.0

# Wait for a while until the URL https://sum.golang.org/lookup/github.com/ray-project/kuberay/[email protected] no longer displays "not found". This may take 15 mins based on my experience.
go install github.com/ray-project/kuberay/[email protected]

# Check the module is installed successfully.
ls $GOPATH/pkg/mod/github.com/ray-project/kuberay/
# [Expected output]: [email protected]
```

* Release rc0 Helm charts following the [instructions](../release/helm-chart.md).

* Open a PR into the Ray repo updating the operator version used in the autoscaler integration test. Make any adjustments necessary for the test to pass ([example](https://github.com/ray-project/ray/pull/33987)). Make sure the test labelled [kubernetes-operator](https://buildkite.com/ray-project/oss-ci-build-pr/builds/17146#01873a69-5ccf-4c71-b06c-ae3a4dd9aecb) passes before merging.
Expand Down