f5bf542697## Motivation and Context <!-- Why is this change needed? What problem does it solve? --> The following PR: * Adds a Makefile with the most common project-related commands * Updates the CI workflow to leverage that (people testing locally will use the same commands as the CI) * Switches to using the official Golangci-lint action instead of downloading it via curl * Bumps the golangci version (supersedes #144) * Fixes any formatting/linting issues found * Updates the README to reference the new make targets * Runs the schema validation scripts as part of the CI **Next:** * If you are okay I can file a follow up PR afterwards where I can tidy up the CI workflows a bit, it feels there's some overlap. ## How Has This Been Tested? <!-- Have you tested this in a real application? Which scenarios were tested? --> Locally by running the make targets ## Breaking Changes <!-- Will users need to update their code or configurations? --> ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [x] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update ## Checklist <!-- Go over all the following points, and put an `x` in all the boxes that apply. --> - [x] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [x] My code follows the repository's style guidelines - [x] New and existing tests pass locally - [ ] I have added appropriate error handling - [ ] I have added or updated documentation as needed ## Additional context <!-- Add any other context, implementation notes, or design decisions --> --------- Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com> Co-authored-by: Adam Jones <adamj+git@anthropic.com>
70 lines
2.2 KiB
Makefile
70 lines
2.2 KiB
Makefile
.PHONY: help build test test-unit test-integration test-endpoints test-publish test-all lint lint-fix validate validate-schemas validate-examples check dev-local dev-compose clean publisher
|
|
|
|
# Default target
|
|
help: ## Show this help message
|
|
@echo "Available targets:"
|
|
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf " %-20s %s\n", $$1, $$2}'
|
|
|
|
# Build targets
|
|
build: ## Build the registry application
|
|
go build ./cmd/registry
|
|
|
|
publisher: ## Build the publisher tool
|
|
cd tools/publisher && ./build.sh
|
|
|
|
# Test targets
|
|
test-unit: ## Run unit tests with coverage
|
|
go test -v -race -coverprofile=coverage.out -covermode=atomic ./internal/...
|
|
go tool cover -html=coverage.out -o coverage.html
|
|
@echo "Coverage report generated: coverage.html"
|
|
|
|
test: ## Run unit tests (use 'make test-all' to run all tests)
|
|
@echo "⚠️ Running unit tests only. Use 'make test-all' to run both unit and integration tests."
|
|
@$(MAKE) test-unit
|
|
|
|
test-integration: ## Run integration tests
|
|
./tests/integration/run.sh
|
|
|
|
test-endpoints: ## Test API endpoints (requires running server)
|
|
./scripts/test_endpoints.sh
|
|
|
|
test-publish: ## Test publish endpoint (requires BEARER_TOKEN env var)
|
|
./scripts/test_publish.sh
|
|
|
|
test-all: test-unit test-integration ## Run all tests (unit and integration)
|
|
|
|
# Validation targets
|
|
validate-schemas: ## Validate JSON schemas
|
|
./tools/validate-schemas.sh
|
|
|
|
validate-examples: ## Validate examples against schemas
|
|
./tools/validate-examples.sh
|
|
|
|
validate: validate-schemas validate-examples ## Run all validation checks
|
|
|
|
# Lint targets
|
|
lint: ## Run linter (includes formatting)
|
|
golangci-lint run --timeout=5m
|
|
|
|
lint-fix: ## Run linter with auto-fix (includes formatting)
|
|
golangci-lint run --fix --timeout=5m
|
|
|
|
# Combined targets
|
|
check: lint validate test-all ## Run all checks (lint, validate, unit tests)
|
|
@echo "All checks passed!"
|
|
|
|
# Development targets
|
|
dev-compose: ## Start development environment with Docker Compose (builds image automatically)
|
|
docker compose up --build
|
|
|
|
dev-local: ## Run registry locally (requires MongoDB)
|
|
go run cmd/registry/main.go
|
|
|
|
# Cleanup
|
|
clean: ## Clean build artifacts and coverage files
|
|
rm -f registry
|
|
rm -f coverage.out coverage.html
|
|
cd tools/publisher && rm -f publisher
|
|
|
|
|
|
.DEFAULT_GOAL := help
|