Update AGENTS.md and Makefile for improved build and test instructions
CI / Go Tests (push) Successful in 12s
CI / Build (push) Successful in 9s
Format / gofmt (push) Successful in 6s
Release Artifacts / Validate release tag (push) Successful in 2s
Release Artifacts / Build and release executables (push) Successful in 15s
Release Artifacts / Build and release Docker image (push) Successful in 26s
CI / Go Tests (push) Successful in 12s
CI / Build (push) Successful in 9s
Format / gofmt (push) Successful in 6s
Release Artifacts / Validate release tag (push) Successful in 2s
Release Artifacts / Build and release executables (push) Successful in 15s
Release Artifacts / Build and release Docker image (push) Successful in 26s
- Revised the build and test instructions in `AGENTS.md` to emphasize the importance of formatting, testing, and building before finalizing code changes. - Enhanced comments in the `Makefile` to clarify the purpose of each target, including `run`, `dev`, `build`, `docker`, `test`, `test-race`, and `fmt`.
This commit is contained in:
@@ -29,10 +29,7 @@ Key product constraints:
|
|||||||
## Build and test
|
## Build and test
|
||||||
|
|
||||||
Use `make help` as the source of truth for available build/test targets and descriptions.
|
Use `make help` as the source of truth for available build/test targets and descriptions.
|
||||||
Always build and test via make unless it doesn't include targets for that.
|
Format, Test, Build are the required steps before being done with any coding if there are more then one target for any of these then run them all before considering that step complete.
|
||||||
Also in the event there is a test without race checking and one with do both.
|
|
||||||
Otherwise just whats available.
|
|
||||||
To verify your changes you must run tests and do a build.
|
|
||||||
|
|
||||||
## Coding conventions
|
## Coding conventions
|
||||||
|
|
||||||
|
|||||||
@@ -18,26 +18,26 @@ help:
|
|||||||
@echo " make fmt - Format Go code"
|
@echo " make fmt - Format Go code"
|
||||||
@echo " make clean - Remove built artifacts"
|
@echo " make clean - Remove built artifacts"
|
||||||
|
|
||||||
run: dev
|
run: dev # Run the application alias for dev.
|
||||||
|
|
||||||
dev: build
|
dev: build # Run the application.
|
||||||
$(BIN) server --config $(CONFIG)
|
$(BIN) server --config $(CONFIG)
|
||||||
|
|
||||||
build: clean
|
build: clean # Build the application.
|
||||||
npm --prefix ./web/ui run build
|
npm --prefix ./web/ui run build
|
||||||
mkdir -p $(BIN_DIR)
|
mkdir -p $(BIN_DIR)
|
||||||
CGO_ENABLED=0 go build -o $(BIN) $(CMD_DIR)
|
CGO_ENABLED=0 go build -o $(BIN) $(CMD_DIR)
|
||||||
|
|
||||||
docker:
|
docker: # Build the Docker image.
|
||||||
docker build -t $(DOCKER_IMAGE) .
|
docker build -t $(DOCKER_IMAGE) .
|
||||||
|
|
||||||
test:
|
test: # Run the tests.
|
||||||
go test -timeout 30s -shuffle=on ./...
|
go test -timeout 30s -shuffle=on ./...
|
||||||
|
|
||||||
test-race:
|
test-race: # Run the tests with the race detector.
|
||||||
go test -race -timeout 30s -shuffle=on ./...
|
go test -race -timeout 30s -shuffle=on ./...
|
||||||
|
|
||||||
fmt:
|
fmt: # Format the code using gofmt.
|
||||||
go fmt ./...
|
go fmt ./...
|
||||||
|
|
||||||
clean:
|
clean:
|
||||||
|
|||||||
Reference in New Issue
Block a user