doc: note that go generate scripts are deprecated (sourcegraph#35270)

ravi3222 · May 11, 2022 · 9f23d2f · 9f23d2f
1 parent 5a43d3e
commit 9f23d2f
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 7 deletions.
diff --git a/dev/check/go-generate.sh b/dev/check/go-generate.sh
@@ -1,5 +1,11 @@
 #!/usr/bin/env bash
 
+echo "!!!!!!!!!!!!!!!!!!"
+echo "!!! DEPRECATED !!!"
+echo "!!!!!!!!!!!!!!!!!!"
+echo "This script is deprecated!"
+echo "Add your checks to 'dev/sg/internal/lint/linters' instead."
+
 echo "--- go generate"
 
 trap "echo ^^^ +++" ERR

diff --git a/dev/generate.sh b/dev/generate.sh
@@ -3,23 +3,29 @@
 set -e
 cd "$(dirname "${BASH_SOURCE[0]}")/.." # cd to repo root dir
 
+echo "!!!!!!!!!!!!!!!!!!"
+echo "!!! DEPRECATED !!!"
+echo "!!!!!!!!!!!!!!!!!!"
+echo "This script is deprecated!"
+echo "Add your codegen tasks to 'sg generate' instead."
+
 # We'll exclude generating the CLI reference documentation by default due to the
 # relatively high cost of fetching and building src-cli.
 go list ./... | grep -v 'doc/cli/references' | xargs go generate -x
 
 FIND="find"
 if [ "$(uname)" = "Darwin" ]; then
-    FIND="gfind"
+  FIND="gfind"
 fi
 # Ignore the submodules in docker-images syntax-highlighter.
 #
 # Disable shellcheck for this line because we actually want them to be space separated
 # (goimports doesn't accept passing args by stdin)
 #
 # shellcheck disable=SC2046
-GOBIN="$PWD/.bin" go install golang.org/x/tools/cmd/goimports && \
-    ./.bin/goimports -w $(
-        comm -12 <(git ls-files | sort) <("$FIND" . -type f -name '*.go' -printf "%P\n" | sort)
-    )
+GOBIN="$PWD/.bin" go install golang.org/x/tools/cmd/goimports &&
+  ./.bin/goimports -w $(
+    comm -12 <(git ls-files | sort) <("$FIND" . -type f -name '*.go' -printf "%P\n" | sort)
+  )
 
 go mod tidy
diff --git a/doc/dev/background-information/dependencies_and_codegen.md b/doc/dev/background-information/dependencies_and_codegen.md
@@ -15,7 +15,7 @@ The Sourcegraph repository relies on code generation triggered by `go generate`.
 To generate everything, just run:
 
 ```bash
-./dev/generate.sh
+sg generate
 ```
 
 Note: Sometimes, there are erroneous diffs. This occurs for a few

diff --git a/enterprise/dev/generate.sh b/enterprise/dev/generate.sh
@@ -3,6 +3,12 @@
 set -e
 cd "$(dirname "${BASH_SOURCE[0]}")/.." # cd to enterprise/
 
+echo "!!!!!!!!!!!!!!!!!!"
+echo "!!! DEPRECATED !!!"
+echo "!!!!!!!!!!!!!!!!!!"
+echo "This script is deprecated!"
+echo "Add your codegen tasks to 'sg generate' instead."
+
 ../dev/generate.sh
 
 go list ./... | xargs go generate -x
diff --git a/migrations/README.md b/migrations/README.md
@@ -30,7 +30,7 @@ Migration files created
  Metadata file: ~/migrations/codeintel/1644260831/metadata.yaml
 ```
 
-This will create an _up_ and _down_ pair of migration files (whose path is printed by the following command). Add SQL statements to these files that will perform the desired migration. After adding SQL statements to those files, update the schema doc via `go generate ./internal/database/` (or regenerate everything via `./dev/generate.sh`).
+This will create an _up_ and _down_ pair of migration files (whose path is printed by the following command). Add SQL statements to these files that will perform the desired migration. After adding SQL statements to those files, update the schema doc via `go generate ./internal/database/` (or regenerate everything via `sg generate`).
 
 To pass CI, you'll additionally need to: