Guide to Setting Up a Go Development Environment and Build Workflow

This article explains how a Java developer with no Go background can quickly set up a usable Go development environment and avoid common pitfalls.

Installing Homebrew /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" After installation, verify with brew --version .

Installing Go and Delve (debugger) Use Homebrew to install the latest Go version: brew install go or a specific version: brew install [email protected] Check the installation with go version . Install the Go debugger Delve: brew install delve Verify with dlv version . If Delve fails, install GDB as a fallback: brew install gdb and check gdb --version .

Environment Configuration Add the following lines to your shell profile ( .bash_profile or .zshrc ) to enable debug symbols and proxy settings: export GOFLAGS="-ldflags=-compressdwarf=false" export GOPROXY=https://goproxy.io,direct For private repositories, set: export GOPRIVATE="your.private.gitlab.com/*,another.private.gitlab.com/*" And configure the Go module proxy for private code: export GOPROXY=https://goproxy.io,direct

IDE Recommendations Paid option: Goland (best experience). Free options: IntelliJ IDEA Ultimate with Go plugin, or VS Code with the official Go extension from Microsoft.

Project Structure

For a standalone executable (contains main ):

your_app_name/
├── cmd/
│   └── your_app_name/
│       └── main.go
├── internal/   # internal packages
├── config/      # configuration files
├── scripts/     # build/deploy scripts
├── tests/       # unit/integration tests
├── README.md
├── go.mod
├── go.sum
└── .gitignore

For a library intended for others:

your_library_name/
├── internal/   # non‑public packages
├── pkg/
│   └── your_library_name/
│       ├── your_library.go
│       └── ...
├── tests/
├── README.md
├── go.mod
├── go.sum
└── .gitignore

Dependency Management Go uses go.mod (similar to Maven's pom.xml ) to declare module dependencies. Example snippet:

module github.com/dapr/dapr

go 1.21

require (
    contrib.go.opencensus.io/exporter/prometheus v0.4.2
    github.com/PaesslerAG/jsonpath v0.1.1
    github.com/PuerkitoBio/purell v1.2.1
)

replace (
    github.com/toolkits/concurrent => github.com/niean/gotools v0.0.0-201512
)

When dependencies conflict, manually edit go.mod and run go mod tidy to clean up unused entries and resolve indirect dependencies.

Building with Make A sample Makefile automates cleaning, tidying, and compiling:

# Define constants
APPNAME := your_application_name
BINDIR := /build/bin
GOBIN := $(shell go env GOPATH)/bin
export GO111MODULE := on

clean:
	@rm -rf $(BINDIR)/*
	@echo "Cleanup completed."

build: go_mod_tidy compile

go_mod_tidy:
	@go mod tidy
	@echo "go mod tidy completed."

compile:
	@mkdir -p $(BINDIR)
	@go build -o $(BINDIR)/${APPNAME}
	@echo "Build completed."

help:
	@echo "Usage:"
	@echo "  make build   - tidy modules and compile"
	@echo "  make clean   - clean build artifacts"

.PHONY: clean build go_mod_tidy compile help

Debugging Use VS Code launch configuration ( .vscode/launch.json ) or the command‑line debugger Delve. Example Delve commands: dlv exec ./your_binary -- args or dlv debug main.go . Common Delve commands: b (breakpoint), c (continue), n (step over), s (step in), p (print variable).

Packaging After building, the binary can be packaged as an RPM (or DEB) for distribution. The article references an external RPM packaging guide.

Summary By following these steps—installing Homebrew, Go, and Delve; configuring environment variables; adopting a clear project layout; managing dependencies with go.mod ; automating builds with Make; and using VS Code or Delve for debugging—developers can efficiently transition from Java to Go and maintain reliable, reproducible builds.