Files
simplegit/Makefile
T
2026-07-15 11:06:48 -04:00

119 lines
4.7 KiB
Makefile

# simplegit build rules.
#
# pkgs/simplegit is a standalone Go module (the minimal git hosting server, plus
# its web console and the OpenAPI-driven mgmt API the console talks to). This
# Makefile is the module's self-contained entry point for building, testing, and
# regenerating its OpenAPI-driven mgmt API. Run from here as `make <target>`.
GOFLAGS := -trimpath
# oapi-codegen runs via `go run` at a pinned version. The spec lives in cmd/openapi,
# alongside the generated Go server (openapi.gen.go) and TypeScript types (api-types.ts).
SPEC := cmd/openapi.yaml
OAPIGEN := cmd/openapi.gen.go
TSTYPES := cmd/api-types.ts
WEB := ../../web/apps/simplegit
WEBDIST := $(WEB)/dist
.PHONY: build gitctl test web clean openapi openapi-check proto proto-tools proto-check
# build the simplegit server into ./build.
build:
@mkdir -p build
go build $(GOFLAGS) -o build/simplegit ./cmd/daemon
# build the ManageService TUI client into ./build.
gitctl:
@mkdir -p build
go build $(GOFLAGS) -o build/gitctl ./cmd/gitctl
# dev runs simplegit as the git host: JSON-RPC + smart-HTTP on :8093, SSH on
# :2222. It verifies console-issued JWTs and authorizes via the simpleconsole
# RBAC center at -auth, so start simpleconsole (`make dev` in ../simpleconsole)
# FIRST -- simplegit fetches console's JWKS at startup. The bare-repo root is
# shared with console (console -root's repos/ subdir == this -root). For a
# zero-config single-service run with no console: `go run . -skip-auth`.
ROOT := $(abspath ../..)
DATA := $(ROOT)/.simplegit-data
dev:
go run ./cmd -rpc 127.0.1.1:8093 -ssh 127.0.1.1:2222 -root $(DATA)/repos -auth http://127.0.1.1:8080
dev0:
go run ./cmd -rpc 127.0.1.1:8093 -ssh 127.0.1.1:2222 -root $(DATA)/repos -skip-auth
# run all tests.
test:
go test ./...
# web builds the git console (vite) into web/dist.
web: $(WEBDIST)/index.html
$(WEBDIST)/index.html:
cd $(WEB) && bun run build
clean:
rm -rf build $(WEBDIST)
# openapi regenerates the mgmt Go server ($(OAPIGEN)) and the TS types
# ($(TSTYPES)) from the spec ($(SPEC)), the single source of truth. Both
# generated files live in cmd/; the web imports the TS types via the
# @openapi alias (see web/vite.config.ts). Generated files are committed, so
# a normal build does not run this.
openapi:
cd cmd && go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@v2.7.1 -config oapi-codegen.yaml openapi.yaml
cd $(WEB) && bunx openapi-typescript $(CURDIR)/cmd/openapi.yaml -o $(CURDIR)/cmd/api-types.ts
# openapi-check regenerates in place and fails if a generated file drifts from
# the spec (for CI).
openapi-check: openapi
@git diff --exit-code -- $(OAPIGEN) $(TSTYPES) && echo "openapi: generated files up to date"
# ---- Connect (crpc) contract for gitrpc ----
# gitrpc/gitrpc.proto is the single source of truth for the gitrpc method set
# -- a typed replacement for the hand-written JSON-RPC handlers in
# gitrpc/handlers.go. `make proto` regenerates the Go server/client stubs
# (connect-go) and TS client (protoc-gen-es). Generated files live under
# gitrpc/v1/ and are committed; a normal build does not run this.
# Requires `protoc` on PATH (brew install protobuf).
PROTO := gitrpc/gitrpc.proto
PROTOV1 := gitrpc/v1
GOPATHBIN := $(shell go env GOPATH)/bin
WEBROOT := ../../web
# proto-tools installs the protoc plugins once: Go (protoc-gen-go +
# protoc-gen-connect-go via `go install`) and TS (protoc-gen-es via web's bun),
# plus the Go runtime deps the generated code imports. Run before the first
# `make proto`. Pin the @versions for reproducible CI.
.PHONY: proto-tools
proto-tools:
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install connectrpc.com/connect/cmd/protoc-gen-connect-go@latest
go get connectrpc.com/connect@latest google.golang.org/protobuf@latest
cd $(WEBROOT) && bun add -d @bufbuild/protoc-gen-es @bufbuild/protobuf @connectrpc/connect
# proto regenerates Go (gitrpc/v1/gitrpc.pb.go messages + gitrpc/v1/v1connect/
# gitrpc.connect.go service client) and TS (gitrpc/v1/ts/gitrpc_pb.ts) from
# $(PROTO). module=simplegit strips the module prefix from go_package so Go
# output lands in gitrpc/v1/ (not simplegit/gitrpc/v1).
.PHONY: proto
proto-go:
protoc -I . \
--go_out=. --go_opt=module=simplegit \
--connect-go_out=. --connect-go_opt=module=simplegit \
--plugin=protoc-gen-go=$(GOPATHBIN)/protoc-gen-go \
--plugin=protoc-gen-connect-go=$(GOPATHBIN)/protoc-gen-connect-go \
$(PROTO)
proto-ts:
mkdir -p $(PROTOV1)/ts
PATH="$(WEBROOT)/node_modules/.bin:$$PATH" protoc -I . \
--es_out=$(PROTOV1)/ts \
--es_opt=target=ts $(PROTO)
proto: proto-go proto-ts
# proto-check regenerates in place and fails if a generated file drifted (CI).
.PHONY: proto-check
proto-check: proto
@git diff --exit-code -- $(PROTOV1) && echo "proto: generated files up to date"