From 3d3fffafea1631079e1d31dc37fa71e1d850b812 Mon Sep 17 00:00:00 2001 From: Pablo Baeyens Date: Fri, 20 Oct 2023 17:28:33 +0200 Subject: [PATCH] [cmd/builder] Specify limitations of `go install` on the README (#8712) Document `go install` limitations on `cmd/builder` README. Fixes #8691 --- cmd/builder/README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/cmd/builder/README.md b/cmd/builder/README.md index d89534565ad..0bd636dbd46 100644 --- a/cmd/builder/README.md +++ b/cmd/builder/README.md @@ -51,8 +51,21 @@ $ /tmp/dist/otelcol-custom --config=/tmp/otelcol.yaml ## Installation -Download the binary for your respective platform under the ["Releases"](https://github.com/open-telemetry/opentelemetry-collector/releases/latest) page. -If install an official release build, the binary is named `ocb`, but if you installed by using `go install`, it will be called `builder`. +There are two supported ways to install the builder: via the official releases (recommended) and through `go install`. + +### Official releases + +This is the recommended installation method. Download the binary for your respective platform under the ["Releases"](https://github.com/open-telemetry/opentelemetry-collector/releases/latest) page. + +### `go install` + +You need to have a `go` compiler in your PATH. Run the following command to install the latest version: + +``` +go install go.opentelemetry.io/collector/cmd/builder@latest +``` + +If installing through this method the binary will be called `builder`. Binaries installed through this method [will incorrectly show `dev` as their version](https://github.com/open-telemetry/opentelemetry-collector/issues/8691). ## Running