f6bd5d0c7b
* docs: add configuration documentation to README Added a new 'Configuration' section to README.md as per the Documentation Audit Report (PR #209). Included: - Default configuration file location (~/.core/config.yaml) - Configuration file format (YAML) with examples - Layered configuration resolution order - Environment variable mapping for config overrides (CORE_CONFIG_*) - Common environment variables (CORE_DAEMON, NO_COLOR, MCP_ADDR, etc.) * docs: add configuration documentation and fix CI/CD auto-merge README.md: - Added comprehensive 'Configuration' section as per audit report #209. - Documented file format, location, and layered resolution order. - Provided environment variable mapping rules and common examples. .github/workflows/auto-merge.yml: - Replaced broken reusable workflow with a local implementation. - Added actions/checkout step to provide necessary Git context. - Fixed 'not a git repository' error by providing explicit repo context to the 'gh' CLI via the -R flag. - Maintained existing bot trust and author association logic. pkg/io/local/client.go: - Fixed code formatting to ensure QA checks pass. * docs: update environment variable description and fix merge conflict - Refined the description of environment variable mapping to be more accurate, clarifying that the prefix is stripped before conversion. - Resolved merge conflict in .github/workflows/auto-merge.yml. - Maintained the local auto-merge implementation to ensure Git context for the 'gh' CLI. * docs: configuration documentation, security fixes, and CI improvements README.md: - Added comprehensive 'Configuration' section as per audit report #209. - Documented file format, location, and layered resolution order. - Provided environment variable mapping rules and common examples. - Added documentation for UniFi configuration options. .github/workflows/auto-merge.yml: - Replaced broken reusable workflow with a local implementation. - Added actions/checkout step to provide necessary Git context. - Fixed 'not a git repository' error by providing explicit repo context to the 'gh' CLI via the -R flag. pkg/unifi: - Fixed security vulnerability (CodeQL) by making TLS verification configurable instead of always skipped. - Added 'unifi.insecure' config key and UNIFI_INSECURE env var. - Updated New and NewFromConfig signatures to handle insecure flag. internal/cmd/unifi: - Added --insecure flag to 'config' command to skip TLS verification. - Updated all UniFi subcommands to support the new configuration logic. pkg/io/local/client.go: - Fixed code formatting to ensure QA checks pass. * docs: configuration documentation, tests, and CI/CD fixes README.md: - Added comprehensive 'Configuration' section as per audit report #209. - Documented file format, location, and layered resolution order. - Provided environment variable mapping rules and common examples. - Documented UniFi configuration options. pkg/unifi: - Fixed security vulnerability by making TLS verification configurable. - Added pkg/unifi/config_test.go and pkg/unifi/client_test.go to provide unit test coverage for new and existing logic (satisfying Codecov). .github/workflows/auto-merge.yml: - Added actions/checkout@v4 to provide the required Git context for the 'gh' CLI, fixing 'not a git repository' errors. pkg/framework/core/core.go: - Fixed compilation errors in Workspace() and Crypt() methods due to upstream changes in MustServiceFor() return signature. - Added necessary error handling to pkg/workspace/service.go. These changes ensure that the project documentation is up-to-date and that the CI/CD pipeline is stable and secure.
152 lines
3.1 KiB
YAML
152 lines
3.1 KiB
YAML
version: '3'
|
|
|
|
vars:
|
|
VERSION:
|
|
sh: git describe --tags --exact-match 2>/dev/null || echo "dev"
|
|
# Base ldflags for version injection
|
|
LDFLAGS_BASE: "-X github.com/host-uk/core/pkg/cli.AppVersion={{.VERSION}}"
|
|
# Development build: includes debug info
|
|
LDFLAGS: "{{.LDFLAGS_BASE}}"
|
|
# Release build: strips debug info and symbol table for smaller binary
|
|
LDFLAGS_RELEASE: "-s -w {{.LDFLAGS_BASE}}"
|
|
|
|
tasks:
|
|
# --- CLI Management ---
|
|
cli:build:
|
|
desc: "Build core CLI to ./bin/core (dev build with debug info)"
|
|
cmds:
|
|
- go build -ldflags '{{.LDFLAGS}}' -o ./bin/core .
|
|
|
|
cli:build:release:
|
|
desc: "Build core CLI for release (smaller binary, no debug info)"
|
|
cmds:
|
|
- go build -ldflags '{{.LDFLAGS_RELEASE}}' -o ./bin/core .
|
|
|
|
cli:install:
|
|
desc: "Install core CLI to system PATH (dev build)"
|
|
cmds:
|
|
- go install -ldflags '{{.LDFLAGS}}' .
|
|
|
|
cli:install:release:
|
|
desc: "Install core CLI for release (smaller binary)"
|
|
cmds:
|
|
- go install -ldflags '{{.LDFLAGS_RELEASE}}' .
|
|
|
|
# --- Development ---
|
|
test:
|
|
desc: "Run all tests"
|
|
cmds:
|
|
- core test
|
|
|
|
test:verbose:
|
|
desc: "Run all tests with verbose output"
|
|
cmds:
|
|
- core test --verbose
|
|
|
|
test:run:
|
|
desc: "Run specific test (use: task test:run -- TestName)"
|
|
cmds:
|
|
- core test --run {{.CLI_ARGS}}
|
|
|
|
cov:
|
|
desc: "Run tests with coverage report"
|
|
cmds:
|
|
- core go cov
|
|
|
|
fmt:
|
|
desc: "Format Go code"
|
|
cmds:
|
|
- core go fmt
|
|
|
|
lint:
|
|
desc: "Run linter"
|
|
cmds:
|
|
- core go lint
|
|
|
|
mod:tidy:
|
|
desc: "Run go mod tidy"
|
|
cmds:
|
|
- core go mod tidy
|
|
|
|
# --- Quality Assurance ---
|
|
qa:
|
|
desc: "Run QA: fmt, vet, lint, test"
|
|
cmds:
|
|
- core go qa
|
|
|
|
qa:quick:
|
|
desc: "Quick QA: fmt, vet, lint only"
|
|
cmds:
|
|
- core go qa quick
|
|
|
|
qa:full:
|
|
desc: "Full QA: + race, vuln, security"
|
|
cmds:
|
|
- core go qa full
|
|
|
|
qa:fix:
|
|
desc: "QA with auto-fix"
|
|
cmds:
|
|
- core go qa --fix
|
|
|
|
# --- Build ---
|
|
build:
|
|
desc: "Build project with auto-detection"
|
|
cmds:
|
|
- core build
|
|
|
|
build:ci:
|
|
desc: "Build for CI (all targets, checksums)"
|
|
cmds:
|
|
- core build --ci
|
|
|
|
# --- Environment ---
|
|
doctor:
|
|
desc: "Check development environment"
|
|
cmds:
|
|
- core doctor
|
|
|
|
doctor:verbose:
|
|
desc: "Check environment with details"
|
|
cmds:
|
|
- core doctor --verbose
|
|
|
|
# --- Code Review ---
|
|
review:
|
|
desc: "Run CodeRabbit review"
|
|
cmds:
|
|
- coderabbit review --prompt-only
|
|
|
|
check:
|
|
desc: "Tidy, test, and review"
|
|
cmds:
|
|
- task: mod:tidy
|
|
- task: test
|
|
- task: review
|
|
|
|
# --- i18n ---
|
|
i18n:generate:
|
|
desc: "Regenerate i18n key constants"
|
|
cmds:
|
|
- go generate ./pkg/i18n/...
|
|
|
|
i18n:validate:
|
|
desc: "Validate i18n key usage"
|
|
cmds:
|
|
- go run ./internal/tools/i18n-validate ./...
|
|
|
|
# --- Multi-repo (when in workspace) ---
|
|
dev:health:
|
|
desc: "Check health of all repos"
|
|
cmds:
|
|
- core dev health
|
|
|
|
dev:work:
|
|
desc: "Full workflow: status, commit, push"
|
|
cmds:
|
|
- core dev work
|
|
|
|
dev:status:
|
|
desc: "Show status of all repos"
|
|
cmds:
|
|
- core dev work --status
|