|
| 1 | +# ============================================================================= |
| 2 | +# GitVigil Makefile |
| 3 | +# ============================================================================= |
| 4 | + |
| 5 | +.PHONY: all build run test fmt vet clean dev \ |
| 6 | + docker-build docker-up docker-down docker-logs docker-clean \ |
| 7 | + help |
| 8 | + |
| 9 | +# Go parameters |
| 10 | +BINARY_NAME := gitvigil |
| 11 | +MAIN_PATH := ./cmd/main.go |
| 12 | +GO := go |
| 13 | + |
| 14 | +# Docker parameters |
| 15 | +DOCKER_IMAGE := gitvigil |
| 16 | +DOCKER_TAG := latest |
| 17 | + |
| 18 | +# ============================================================================= |
| 19 | +# Development |
| 20 | +# ============================================================================= |
| 21 | + |
| 22 | +## build: Build the binary |
| 23 | +build: |
| 24 | + @echo "Building $(BINARY_NAME)..." |
| 25 | + @$(GO) build -o $(BINARY_NAME) $(MAIN_PATH) |
| 26 | + @echo "Done!" |
| 27 | + |
| 28 | +## run: Run the application locally |
| 29 | +run: |
| 30 | + @$(GO) run $(MAIN_PATH) |
| 31 | + |
| 32 | +## test: Run all tests |
| 33 | +test: |
| 34 | + @echo "Running tests..." |
| 35 | + @$(GO) test -v ./... |
| 36 | + |
| 37 | +## test-coverage: Run tests with coverage |
| 38 | +test-coverage: |
| 39 | + @echo "Running tests with coverage..." |
| 40 | + @$(GO) test -coverprofile=coverage.out ./... |
| 41 | + @$(GO) tool cover -html=coverage.out -o coverage.html |
| 42 | + @echo "Coverage report: coverage.html" |
| 43 | + |
| 44 | +## fmt: Format code |
| 45 | +fmt: |
| 46 | + @echo "Formatting code..." |
| 47 | + @$(GO) fmt ./... |
| 48 | + |
| 49 | +## vet: Run go vet |
| 50 | +vet: |
| 51 | + @echo "Running go vet..." |
| 52 | + @$(GO) vet ./... |
| 53 | + |
| 54 | +## lint: Run linter (requires golangci-lint) |
| 55 | +lint: |
| 56 | + @echo "Running linter..." |
| 57 | + @golangci-lint run ./... |
| 58 | + |
| 59 | +## clean: Clean build artifacts |
| 60 | +clean: |
| 61 | + @echo "Cleaning..." |
| 62 | + @rm -f $(BINARY_NAME) |
| 63 | + @rm -f coverage.out coverage.html |
| 64 | + @$(GO) clean |
| 65 | + @echo "Done!" |
| 66 | + |
| 67 | +## dev: Format, vet, and build |
| 68 | +dev: fmt vet build |
| 69 | + |
| 70 | +## tidy: Tidy go modules |
| 71 | +tidy: |
| 72 | + @$(GO) mod tidy |
| 73 | + |
| 74 | +# ============================================================================= |
| 75 | +# Docker |
| 76 | +# ============================================================================= |
| 77 | + |
| 78 | +## docker-build: Build Docker image |
| 79 | +docker-build: |
| 80 | + @echo "Building Docker image..." |
| 81 | + @docker build -t $(DOCKER_IMAGE):$(DOCKER_TAG) . |
| 82 | + @echo "Done!" |
| 83 | + |
| 84 | +## docker-up: Start services with Docker Compose |
| 85 | +docker-up: |
| 86 | + @echo "Starting services..." |
| 87 | + @docker compose up -d |
| 88 | + @echo "Services started. Access at http://localhost:8080" |
| 89 | + |
| 90 | +## docker-down: Stop Docker Compose services |
| 91 | +docker-down: |
| 92 | + @echo "Stopping services..." |
| 93 | + @docker compose down |
| 94 | + |
| 95 | +## docker-logs: View application logs |
| 96 | +docker-logs: |
| 97 | + @docker compose logs -f app |
| 98 | + |
| 99 | +## docker-logs-db: View database logs |
| 100 | +docker-logs-db: |
| 101 | + @docker compose logs -f db |
| 102 | + |
| 103 | +## docker-restart: Restart the application |
| 104 | +docker-restart: |
| 105 | + @docker compose restart app |
| 106 | + |
| 107 | +## docker-clean: Stop services and remove volumes |
| 108 | +docker-clean: |
| 109 | + @echo "Stopping services and removing volumes..." |
| 110 | + @docker compose down -v |
| 111 | + @echo "Done!" |
| 112 | + |
| 113 | +## docker-shell: Open shell in app container |
| 114 | +docker-shell: |
| 115 | + @docker compose exec app sh |
| 116 | + |
| 117 | +## docker-db-shell: Open psql in database container |
| 118 | +docker-db-shell: |
| 119 | + @docker compose exec db psql -U gitvigil -d gitvigil |
| 120 | + |
| 121 | +# ============================================================================= |
| 122 | +# Database |
| 123 | +# ============================================================================= |
| 124 | + |
| 125 | +## db-migrate: Run database migrations (local) |
| 126 | +db-migrate: |
| 127 | + @echo "Running migrations..." |
| 128 | + @$(GO) run $(MAIN_PATH) migrate |
| 129 | + |
| 130 | +# ============================================================================= |
| 131 | +# Help |
| 132 | +# ============================================================================= |
| 133 | + |
| 134 | +## help: Show this help message |
| 135 | +help: |
| 136 | + @echo "GitVigil - Hackathon Monitoring Service" |
| 137 | + @echo "" |
| 138 | + @echo "Usage: make [target]" |
| 139 | + @echo "" |
| 140 | + @echo "Development:" |
| 141 | + @sed -n 's/^## //p' $(MAKEFILE_LIST) | grep -E '^[a-z]' | grep -v 'docker-' | column -t -s ':' |
| 142 | + @echo "" |
| 143 | + @echo "Docker:" |
| 144 | + @sed -n 's/^## //p' $(MAKEFILE_LIST) | grep -E '^docker-' | column -t -s ':' |
| 145 | + |
| 146 | +# Default target |
| 147 | +all: dev |
0 commit comments