Skip to content

Commit 6a81939

Browse files
nirsBenamarMk
authored andcommitted
Document Go 1.20 requirement
Explain why we need Go 1.20 and how to maintain multiple Go versions so ramen can be built and tested while using newer default Go version. Signed-off-by: Nir Soffer <[email protected]>
1 parent 01470b0 commit 6a81939

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/devel-quick-start.md

+16
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,22 @@ enough resources:
7272
link `venv` for activating the environment. To activate the
7373
environment use:
7474

75+
1. Install Go 1.20
76+
77+
Ramen requires now Go 1.20 due to backward incompatible changes in Go
78+
1.21 and later. If your system Go is newer and you don't want to
79+
downgrade it, you can install Go 1.20 according to
80+
[Managing Go installations](https://go.dev/doc/manage-install).
81+
82+
To use Go 1.20 from the ~/sdk, change the PATH in the shell used to
83+
build ramen:
84+
85+
```
86+
$ export PATH="/home/username/sdk/go1.20.14/bin:$PATH"
87+
$ go version
88+
go version go1.20.14 linux/amd64
89+
```
90+
7591
That's all! You are ready to submit your first pull request!
7692

7793
## Running the tests

0 commit comments

Comments
 (0)