diff --git a/.gitignore b/.gitignore index 215353e..abb896f 100644 --- a/.gitignore +++ b/.gitignore @@ -34,8 +34,8 @@ clients/python/.pytest_cache/ clients/python/*.egg-info/ clients/lisp/**/*.fasl -# manual testing -run/ +# local development data +srv/ .env /cmd/mciasctl/mciasctl /cmd/mciasdb/mciasdb diff --git a/ARCHITECTURE.md b/ARCHITECTURE.md index 4c73904..201d7dc 100644 --- a/ARCHITECTURE.md +++ b/ARCHITECTURE.md @@ -1290,7 +1290,7 @@ The Makefile `docker` target automates the build step with the version tag. | `build` | Compile all binaries to `bin/` using current GOOS/GOARCH | | `test` | `go test -race ./...` | | `lint` | `golangci-lint run ./...` | -| `generate` | `go generate ./...` (re-generates proto stubs) | +| `proto` | `go generate ./...` (re-generates proto stubs) | | `man` | Build man pages; compress to `.gz` in `man/` | | `install` | Run `dist/install.sh` | | `docker` | `docker build -t mcias:$(VERSION) -t mcias:latest .` | diff --git a/Makefile b/Makefile index 07331c6..e9d3cb5 100644 --- a/Makefile +++ b/Makefile @@ -6,11 +6,11 @@ # make vet — run go vet # make lint — run golangci-lint # make all — vet → lint → test → build (CI pipeline) -# make generate — regenerate protobuf stubs (requires protoc) +# make proto — regenerate protobuf stubs (requires protoc) # make proto-lint — lint proto files with buf # make man — build compressed man pages # make install — run deploy/scripts/install.sh (requires root) -# make devserver — build and run mciassrv against run/ config +# make devserver — build and run mciassrv against srv/ config # make clean — remove bin/ and generated artifacts # make dist — build release tarballs for linux/amd64 and linux/arm64 # make docker — build Docker image tagged mcias:$(VERSION) and mcias:latest @@ -95,19 +95,19 @@ proto-lint: buf breaking --against '.git#branch=master,subdir=proto' # --------------------------------------------------------------------------- -# generate — regenerate protobuf stubs from proto/ definitions +# proto — regenerate protobuf stubs from proto/ definitions # Requires: protoc, protoc-gen-go, protoc-gen-go-grpc # --------------------------------------------------------------------------- -.PHONY: generate -generate: +.PHONY: proto +proto: $(GO) generate ./... # --------------------------------------------------------------------------- -# devserver — build and run mciassrv against the local run/ config +# devserver — build and run mciassrv against the local srv/ config # --------------------------------------------------------------------------- .PHONY: devserver devserver: build - $(BIN_DIR)/mciassrv -config run/mcias.conf + $(BIN_DIR)/mciassrv -config srv/mcias.conf # --------------------------------------------------------------------------- # man — build compressed man pages @@ -195,8 +195,8 @@ help: @echo " vet Run go vet" @echo " lint Run golangci-lint" @echo " proto-lint Lint proto files with buf" - @echo " generate Regenerate protobuf stubs" - @echo " devserver Build and run mciassrv against run/ config" + @echo " proto Regenerate protobuf stubs" + @echo " devserver Build and run mciassrv against srv/ config" @echo " man Build compressed man pages" @echo " install Install to /usr/local/bin (requires root)" @echo " clean Remove build artifacts" diff --git a/PROGRESS.md b/PROGRESS.md index e1be3a2..b704cb0 100644 --- a/PROGRESS.md +++ b/PROGRESS.md @@ -823,7 +823,7 @@ ARCHITECTURE.md for future implementation. --- **Makefile** -- Targets: build, test, lint, generate, man, install, clean, dist, docker +- Targets: build, test, lint, proto, man, install, clean, dist, docker - build: compiles all four binaries to bin/ with CGO_ENABLED=1 and -trimpath -ldflags="-s -w" - dist: cross-compiled tarballs for linux/amd64 and linux/arm64 diff --git a/PROJECT_PLAN.md b/PROJECT_PLAN.md index 6038c12..c8ebb35 100644 --- a/PROJECT_PLAN.md +++ b/PROJECT_PLAN.md @@ -472,7 +472,7 @@ See ARCHITECTURE.md §18 for full design rationale and artifact inventory. - `build` — compile all binaries to `bin/` - `test` — `go test -race ./...` - `lint` — `golangci-lint run ./...` - - `generate` — `go generate ./...` (proto stubs from Phase 7) + - `proto` — `go generate ./...` (proto stubs from Phase 7) - `man` — build compressed man pages - `install` — run `dist/install.sh` - `docker` — `docker build -t mcias:$(VERSION) -t mcias:latest .` diff --git a/README.md b/README.md index 86ab52a..7966d46 100644 --- a/README.md +++ b/README.md @@ -161,7 +161,7 @@ curl -k https://mcias.metacircular.net:8443/v1/health make build # compile all binaries to bin/ make test # go test -race ./... make lint # golangci-lint run ./... -make generate # regenerate protobuf stubs (requires protoc) +make proto # regenerate protobuf stubs (requires protoc) make man # build compressed man pages make clean # remove bin/ and generated artifacts make dist # cross-compiled tarballs for linux/amd64 and linux/arm64