argoyle
ba5169db69
vladopajic/go-test-coverage@v2 (v2.18.5+) switched composite-action
inputs from CLI args to env-var mapping, which Gitea act_runner does
not expand reliably. The literal string `${{ inputs.config }}` was
passed to the binary, breaking 'Check coverage' steps.
Replace the action with a direct go install + binary invocation
(matching Frostmoln pattern) and use the tool's --github-action-output
to drop manual go tool cover -func calculations.
1.8 KiB
1.8 KiB
CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
Project Overview
dbsetup is a Go helper module for database connection pool initialization with OpenTelemetry (OTEL) instrumentation. It wraps database connections with OTEL to automatically add SQL queries to tracing spans.
- Module path:
gitea.unbound.se/unboundsoftware/dbsetup - Primary dependencies: sqlx, goose (migrations), otelsqlx (OTEL wrapper)
Common Commands
# Download dependencies
go mod download
# Run tests with race detection and coverage
CGO_ENABLED=1 go test -race -coverprofile=coverage.txt ./...
# Generate coverage report
go tool cover -html=coverage.txt -o coverage.html
# Check for security vulnerabilities
go install golang.org/x/vuln/cmd/govulncheck@latest
govulncheck ./...
# Run pre-commit hooks (add all files first)
git add -A && pre-commit run --all-files
Architecture
Single-package module with one source file (database.go):
- DatabaseConfig: Configuration struct with connection URL, driver name, and pool settings. Uses struct tags compatible with kong CLI parser.
- Database: Main handler providing:
SetupDB()- Validates database connection and returns Database instanceConnect()- Creates OTEL-wrapped connection pool via otelsqlxRunMigrations()- Executes goose migrations from anfs.FSfilesystem
Code Quality
Pre-commit hooks enforce:
- gofumpt formatting (stricter than gofmt)
- golangci-lint
- go-imports with local path
gitea.unbound.se/unboundsoftware/ - Conventional commits format (feat:, fix:, chore:, etc.)
- Gitleaks for secret detection
CI/CD
Self-hosted Gitea Actions (.gitea/workflows/) run: dependency download → tests with race detector → coverage check → vulnerability scanning → coverage baseline upload/comparison.