task setup installs the golangci-lint CI pins, the protobuf generators and the dashboard dependencies, and warns by name about the tools it cannot install (Go, Task, Node, Docker). The linter version now lives in one file read by both the setup task and both workflows, so a local checkout and the gate cannot run different linters.
370 lines
11 KiB
YAML
370 lines
11 KiB
YAML
version: "3"
|
|
|
|
vars:
|
|
BIN_DIR: "bin"
|
|
|
|
tasks:
|
|
default:
|
|
desc: List available tasks
|
|
cmds:
|
|
- task --list
|
|
|
|
setup:
|
|
desc: Install the pinned tooling and dependencies a checkout needs
|
|
cmds:
|
|
# Report what this task cannot install for you, so a missing Go, Node or
|
|
# Docker fails here by name rather than somewhere inside the gate.
|
|
- |
|
|
set -eu
|
|
missing=
|
|
for tool in go task node npm docker; do
|
|
command -v "$tool" >/dev/null 2>&1 || missing="$missing $tool"
|
|
done
|
|
if [ -n "$missing" ]; then
|
|
echo "warning: not installed (AGENTS.md, Build and gate):$missing" >&2
|
|
fi
|
|
# The pin is one file, read here and by .github/workflows, so the linter
|
|
# running locally and the one running the gate cannot drift apart.
|
|
- |
|
|
set -eu
|
|
want=$(cat {{.ROOT_DIR}}/.golangci-version)
|
|
have=$(golangci-lint --version 2>/dev/null | grep -oE '[0-9]+\.[0-9]+\.[0-9]+' | head -1 || true)
|
|
if [ "$have" = "${want#v}" ]; then
|
|
echo "golangci-lint $want already installed"
|
|
else
|
|
echo "installing golangci-lint $want (have: ${have:-none})"
|
|
GOBIN="$(go env GOPATH)/bin" go install "github.com/golangci/golangci-lint/v2/cmd/golangci-lint@$want"
|
|
fi
|
|
- task: proto:install
|
|
- task: ui:deps
|
|
|
|
fmt:
|
|
desc: Fix and format Go source with the gate's configured formatters
|
|
cmds:
|
|
# One go fix pass is not a fixpoint: it applies each fixer once, to the
|
|
# parse it started with, so a rewrite made by one fixer is only fixed up
|
|
# by the next pass. stditerators turns `for i := range t.NumField()` into
|
|
# a field iterator that copies its loop variable, and forvar deletes that
|
|
# copy on the following pass -- leaving the copy behind for copyloopvar
|
|
# to reject. Apply passes until a dry run reports nothing left to fix,
|
|
# and fail rather than hand the lint step a tree it must reject.
|
|
- |
|
|
set -eu
|
|
converged=false
|
|
for pass in 1 2 3 4 5 6 7 8 9 10; do
|
|
go fix ./...
|
|
if go fix -diff ./... >/dev/null; then
|
|
converged=true
|
|
break
|
|
fi
|
|
done
|
|
if [ "$converged" != true ]; then
|
|
echo "go fix still rewrites the tree after 10 passes" >&2
|
|
exit 1
|
|
fi
|
|
# This must use the same engine and configuration as task lint. Running
|
|
# standalone gofumpt cannot reproduce gci's custom import grouping, so it
|
|
# can leave a tree that the gate rejects.
|
|
- golangci-lint fmt
|
|
|
|
proto:install:
|
|
desc: Install the pinned Buf and protobuf Go generators
|
|
cmds:
|
|
- bash tools/proto.sh install
|
|
|
|
proto:generate:
|
|
desc: Generate and format committed grpc-go service contracts
|
|
cmds:
|
|
- bash tools/proto.sh generate
|
|
|
|
proto:lint:
|
|
desc: Lint protobuf contracts and check compatibility with main
|
|
cmds:
|
|
- bash tools/proto.sh lint
|
|
|
|
db:generate:
|
|
desc: "Regenerate the sqlc query code from the schema and query files"
|
|
cmds:
|
|
- go -C tools tool sqlc generate -f {{.ROOT_DIR}}/internal/infrastructure/postgres/sqlc.yaml
|
|
|
|
db:check:
|
|
desc: "Regenerate the sqlc code and reject uncommitted generated differences"
|
|
cmds:
|
|
- task: db:generate
|
|
- git diff --exit-code -- internal/infrastructure/postgres/postgresdb
|
|
|
|
proto:check:
|
|
desc: Regenerate contracts and reject uncommitted generated differences
|
|
cmds:
|
|
- bash tools/proto.sh check
|
|
|
|
news:
|
|
desc: Regenerate the release data artifacts from the changelog
|
|
cmds:
|
|
- go -C tools run -mod=readonly ./newsgen --repo-root ..
|
|
|
|
news:check:
|
|
desc: Verify the committed release notes match the changelog
|
|
cmds:
|
|
- go -C tools run -mod=readonly ./newsgen check --repo-root ..
|
|
|
|
vet:
|
|
desc: Run go vet
|
|
cmds:
|
|
- go vet ./...
|
|
|
|
lint:
|
|
desc: Run golangci-lint
|
|
cmds:
|
|
- golangci-lint run ./...
|
|
- task: lint:tools
|
|
|
|
lint:tools:
|
|
desc: Run golangci-lint over the tools module
|
|
dir: tools
|
|
cmds:
|
|
- golangci-lint run ./...
|
|
|
|
lint:playbooks:
|
|
desc: Validate playbook bindings
|
|
cmds:
|
|
- go run ./cmd/archied playbooks lint -dir ./playbooks
|
|
|
|
vuln:
|
|
desc: Scan for known vulnerabilities (requires network access)
|
|
cmds:
|
|
- govulncheck ./...
|
|
|
|
deadcode:
|
|
desc: Report unreachable production functions (advisory)
|
|
cmds:
|
|
- go run golang.org/x/tools/cmd/deadcode@latest -test=false ./cmd/...
|
|
|
|
ui:deps:
|
|
desc: Install dashboard dependencies
|
|
internal: true
|
|
# Parallel UI checks must share one dependency install.
|
|
run: once
|
|
dir: ui
|
|
cmds:
|
|
- npm install --no-audit --no-fund
|
|
|
|
ui:
|
|
desc: Build the dashboard into ui/dist (committed; the Go build embeds it)
|
|
dir: ui
|
|
deps: [ui:deps]
|
|
cmds:
|
|
- npm run build
|
|
|
|
ui:check:
|
|
desc: Rebuild the dashboard into a temporary directory and reject a stale ui/dist
|
|
deps: [ui:deps]
|
|
cmds:
|
|
- bash tools/uidist.sh check
|
|
|
|
test:ui:
|
|
desc: Test and type-check the dashboard
|
|
dir: ui
|
|
deps: [ui:deps]
|
|
cmds:
|
|
- npm test
|
|
- npm run typecheck
|
|
|
|
webhook:send:
|
|
desc: Send a test event to the dashboard's capture intake (--help for kinds)
|
|
cmds:
|
|
- bash tools/webhook-send.sh {{.CLI_ARGS}}
|
|
|
|
dev:
|
|
desc: Run development services and Vite at http://localhost:5173
|
|
deps: [dev:daemon, dev:gateway, dev:messaging, dev:state-store, dev:dashboard, dev:ui]
|
|
|
|
dev:postgres:
|
|
desc: Start PostgreSQL and wait for readiness
|
|
cmds:
|
|
- docker compose up -d postgres
|
|
- |
|
|
set -eu
|
|
for _ in $(seq 1 60); do
|
|
status=$(docker inspect --format '{{`{{.State.Health.Status}}`}}' "$(docker compose ps -q postgres)" 2>/dev/null || true)
|
|
if [ "$status" = "healthy" ]; then
|
|
exit 0
|
|
fi
|
|
sleep 1
|
|
done
|
|
echo "postgres did not become healthy within 60s" >&2
|
|
exit 1
|
|
|
|
dev:daemon:
|
|
desc: Run archied with live reload
|
|
cmds:
|
|
- |
|
|
# The daemon and Gateway read their settings from the State Store at
|
|
# boot and exit if it is not up yet; it starts only once PostgreSQL
|
|
# is healthy, so wait for its port ([services.state] in
|
|
# deployments/dev.toml) first.
|
|
for _ in $(seq 1 120); do nc -z 127.0.0.1 9091 && exit 0; sleep 1; done
|
|
echo "state store did not come up on 127.0.0.1:9091 within 120s" >&2
|
|
exit 1
|
|
- air -build.args_bin="-config-overlay,deployments/dev.toml"
|
|
|
|
dev:dashboard:
|
|
desc: Run the dashboard backend
|
|
cmds:
|
|
- go run ./cmd/archie-ui -config-overlay deployments/dev.toml
|
|
|
|
dev:state-store:
|
|
desc: Run the State Store with development PostgreSQL
|
|
deps: [dev:postgres]
|
|
cmds:
|
|
- go run ./cmd/archie-state-store -config-overlay deployments/dev.toml
|
|
|
|
dev:gateway:
|
|
desc: Run the development Gateway
|
|
cmds:
|
|
- |
|
|
# The daemon and Gateway read their settings from the State Store at
|
|
# boot and exit if it is not up yet; it starts only once PostgreSQL
|
|
# is healthy, so wait for its port ([services.state] in
|
|
# deployments/dev.toml) first.
|
|
for _ in $(seq 1 120); do nc -z 127.0.0.1 9091 && exit 0; sleep 1; done
|
|
echo "state store did not come up on 127.0.0.1:9091 within 120s" >&2
|
|
exit 1
|
|
- go run ./cmd/archie-gateway -config-overlay deployments/dev.toml
|
|
|
|
dev:messaging:
|
|
desc: Run the development Messaging Service
|
|
cmds:
|
|
- for _ in $(seq 1 120); do nc -z 127.0.0.1 9091 && exit 0; sleep 1; done; echo "state store did not come up on 127.0.0.1:9091 within 120s" >&2; exit 1
|
|
- go run ./cmd/archie-messaging -config-overlay deployments/dev.toml
|
|
|
|
dev:ui:
|
|
desc: Run Vite (requires the dashboard backend)
|
|
dir: ui
|
|
cmds:
|
|
- npm install --no-audit --no-fund
|
|
- npm run dev
|
|
|
|
dev:mobile:
|
|
desc: Serve the dashboard on your LAN (token-protected) for phone viewing
|
|
deps:
|
|
- ui
|
|
cmds:
|
|
- cmd: |
|
|
IP=$(hostname -I | awk '{print $1}')
|
|
TOKEN_FILE="${XDG_DATA_HOME:-$HOME/.local/share}/archie/web-token"
|
|
go run ./cmd/archie-ui -listen 0.0.0.0:8484 -token-file "$TOKEN_FILE" &
|
|
UI_PID=$!
|
|
sleep 2
|
|
TOKEN=$(cat "$TOKEN_FILE" 2>/dev/null)
|
|
URL="http://$IP:8484/?t=$TOKEN"
|
|
echo "Phone URL: $URL"
|
|
echo "$URL" | qrencode -t ANSIUTF8
|
|
trap "kill $UI_PID 2>/dev/null" EXIT
|
|
wait $UI_PID
|
|
|
|
build:
|
|
desc: Build archie services and agent binaries
|
|
vars:
|
|
GATEWAY_VERSION: '{{.GATEWAY_VERSION | default "dev"}}'
|
|
RUNTIME_VERSION: '{{.RUNTIME_VERSION | default "dev"}}'
|
|
SERVICE_LDFLAGS: >-
|
|
-X github.com/samcharles93/archie-core/internal/installtype.buildType=binary
|
|
-X github.com/samcharles93/archie-core/internal/buildinfo.Version={{.GATEWAY_VERSION}}
|
|
-X github.com/samcharles93/archie-core/internal/buildinfo.Runtime={{.RUNTIME_VERSION}}
|
|
sources:
|
|
- "**/*.go"
|
|
- go.mod
|
|
- go.sum
|
|
- "ui/dist/**"
|
|
generates:
|
|
- "{{.BIN_DIR}}/archied"
|
|
- "{{.BIN_DIR}}/archie-gateway"
|
|
- "{{.BIN_DIR}}/archie-state-store"
|
|
- "{{.BIN_DIR}}/archie-ui"
|
|
- "{{.BIN_DIR}}/archie-messaging"
|
|
- "{{.BIN_DIR}}/archie-agent"
|
|
cmds:
|
|
# One flag set for every service, matching scripts/archie-update-install
|
|
# and the release workflow, so each binary reports the same version.
|
|
- for: [archied, archie-gateway, archie-state-store, archie-ui, archie-messaging]
|
|
cmd: go build -ldflags "{{.SERVICE_LDFLAGS}}" -o {{.BIN_DIR}}/{{.ITEM}} ./cmd/{{.ITEM}}
|
|
- go build -ldflags "-X github.com/samcharles93/archie-core/internal/app/agentworker.version={{.RUNTIME_VERSION}} -X github.com/samcharles93/archie-core/internal/installtype.buildType=binary" -o {{.BIN_DIR}}/archie-agent ./cmd/archie-agent
|
|
|
|
test:
|
|
desc: Run short Go tests with caching
|
|
cmds:
|
|
- go test -short ./...
|
|
|
|
test:full:
|
|
desc: Run the whole Go test suite uncached, including the wall-clock-bound tests
|
|
cmds:
|
|
- go test ./... -count=1
|
|
|
|
check:
|
|
desc: Run the full quality gate
|
|
# Finish mutations before starting parallel checks.
|
|
cmds:
|
|
- task: fmt
|
|
- task: proto:check
|
|
- task: db:check
|
|
- task: check:readonly
|
|
|
|
check:readonly:
|
|
internal: true
|
|
deps:
|
|
- task: proto:lint
|
|
- task: news:check
|
|
- task: vet
|
|
- task: lint
|
|
- task: build
|
|
- task: test
|
|
- task: test:ui
|
|
- task: ui:check
|
|
|
|
release:preview:
|
|
desc: "Show the release notes that would be generated (VERSION=1.2.0)"
|
|
cmds:
|
|
- tools/release.sh --version {{.VERSION}} --dry-run
|
|
requires:
|
|
vars: [VERSION]
|
|
|
|
release:prepare:
|
|
desc: Prepare changelog notes for editing (VERSION=1.2.0)
|
|
cmds:
|
|
- tools/release.sh --version {{.VERSION}} --prepare
|
|
requires:
|
|
vars: [VERSION]
|
|
|
|
release:
|
|
desc: Commit and tag the prepared release (VERSION=1.2.0)
|
|
cmds:
|
|
- tools/release.sh --version {{.VERSION}} --tag
|
|
requires:
|
|
vars: [VERSION]
|
|
|
|
clean:
|
|
desc: Remove build artifacts
|
|
cmds:
|
|
- rm -rf {{.BIN_DIR}}
|
|
|
|
docker-build:
|
|
desc: Build the archie-agent sandbox image
|
|
cmds:
|
|
- docker compose build agent
|
|
|
|
docker-up:
|
|
desc: Start the optional external NATS service via docker compose
|
|
cmds:
|
|
- docker compose up -d nats
|
|
|
|
docker-down:
|
|
desc: Stop the docker compose stack
|
|
cmds:
|
|
- docker compose down
|
|
|
|
docker-logs:
|
|
desc: Follow the NATS container logs
|
|
cmds:
|
|
- docker compose logs -f nats
|