cmd/getgo: create a module in preparation for deprecation

And add deprecation notice. Updates golang/go#60951 Change-Id: I9d4ffffc03201b038db5cc11563ea1cc5330e668 Reviewed-on: https://go-review.googlesource.com/c/tools/+/563398 Reviewed-by: Alan Donovan <[email protected]> LUCI-TryBot-Result: Go LUCI <[email protected]> Reviewed-by: Dmitri Shuralyov <[email protected]>
golang · Feb 16, 2024 · c61f99f · c61f99f
1 parent 451218f
commit c61f99f
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 1 deletion.
diff --git a/cmd/getgo/README.md b/cmd/getgo/README.md
@@ -1,3 +1,5 @@
+**Deprecated** - See https://go.dev/issues/60951
+
 # getgo
 
 A proof-of-concept command-line installer for Go.

diff --git a/cmd/getgo/go.mod b/cmd/getgo/go.mod
@@ -0,0 +1,4 @@
+// Deprecated: follow the installation instructions at go.dev/doc/install.
+module golang.org/x/tools/cmd/getgo
+
+go 1.18
diff --git a/cmd/getgo/main.go b/cmd/getgo/main.go
@@ -5,7 +5,25 @@
 //go:build !plan9
 // +build !plan9
 
-// The getgo command installs Go to the user's system.
+/*
+The getgo command is deprecated.
+
+Deprecated: See https://go.dev/issues/60951.
+
+Follow the instructions at https://go.dev/doc/install to install Go instead.
+
+Tips:
+
+To find the latest available go version, run:
+
+	go list -m -f '{{.Version}}' go@latest
+
+If you want to use the latest go by default, you can use "go env -w" to override "GOTOOLCHAIN":
+
+	go env -w GOTOOLCHAIN=go$(go list -m -f '{{.Version}}' go@latest)+auto
+
+See https://go.dev/blog/toolchain for more information about toolchain management.
+*/
 package main
 
 import (
@@ -32,6 +50,8 @@ var errExitCleanly error = errors.New("exit cleanly sentinel value")
 
 func main() {
 	flag.Parse()
+	fmt.Fprintln(os.Stderr, "getgo is deprecated. See https://pkg.go.dev/golang.org/x/tools/cmd/getgo.")
+
 	if *goVersion != "" && !strings.HasPrefix(*goVersion, "go") {
 		*goVersion = "go" + *goVersion
 	}