Files
archie/Taskfile.yml

439 lines
16 KiB
YAML

version: "3"
vars:
BIN_DIR: "bin"
# The version a build reports: the nearest tag with the distance and commit,
# or a bare commit when the checkout has no tags (a shallow clone). A build
# should not answer "dev" only because the caller did not name a version.
VERSION:
sh: git describe --tags --always --dirty 2>/dev/null | sed 's/^v//' || echo dev
tasks:
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
pages:generate:
desc: Write the dashboard's page catalogue to ui/pages/pages.json
dir: ui
cmds:
- node --experimental-strip-types scripts/pages.ts
pages:check:
desc: Regenerate the page catalogue and reject uncommitted differences
cmds:
- task: pages:generate
- git diff --exit-code -- ui/pages/pages.json
openapi:generate:
desc: Write the API's OpenAPI document to api/openapi.yaml
cmds:
- mkdir -p api
- go run ./cmd/archie openapi > api/openapi.yaml
openapi:check:
desc: Regenerate the OpenAPI document and reject uncommitted differences
cmds:
- task: openapi:generate
- git diff --exit-code -- api/openapi.yaml
proto:check:
desc: Regenerate contracts and reject uncommitted generated differences
cmds:
- bash tools/proto.sh check
vet:
desc: Run go vet
cmds:
- go vet ./...
lint:
desc: Run golangci-lint
cmds:
- golangci-lint run ./...
ui:deps:
desc: Install dashboard dependencies
internal: true
# Parallel UI checks must share one dependency install.
run: once
dir: ui
cmds:
- pnpm install --frozen-lockfile
ui:
desc: Build the dashboard into ui/dist, which the Go build embeds
# check builds the dashboard and then build depends on it again; a second
# build empties ui/dist under the Go steps that embed it.
run: once
dir: ui
deps: [ui:deps]
cmds:
- pnpm run build
test:ui:
desc: Test and type-check the dashboard
dir: ui
deps: [ui:deps]
cmds:
- pnpm test
- pnpm run typecheck
bench:prreview:
desc: Run the PR review benchmark on the configured models and write docs/benchmarks/pr-review-*.md (-- -model ALIAS -judge-model REF; --help for flags)
cmds:
- go run ./cmd/archied prbench {{.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:tls:
desc: Issue the development CA and service certificates deployments/dev.toml names
status:
- test -f tmp/dev-tls/archie-ui.pem
cmds:
- |
# Task containers reach the State Store over the Docker bridge, which
# services may only do over TLS.
set -eu
d=tmp/dev-tls
mkdir -p "$d"
openssl req -x509 -newkey ec -pkeyopt ec_paramgen_curve:prime256v1 -nodes -days 3650 \
-subj /CN=archie-dev-ca -keyout "$d/ca-key.pem" -out "$d/ca.pem" 2>/dev/null
for s in archied archie-gateway archie-messaging archie-state-store archie-ui; do
openssl req -x509 -newkey ec -pkeyopt ec_paramgen_curve:prime256v1 -nodes -days 3650 \
-subj "/CN=$s" -addext "subjectAltName=DNS:$s" -addext extendedKeyUsage=serverAuth,clientAuth \
-CA "$d/ca.pem" -CAkey "$d/ca-key.pem" -keyout "$d/$s-key.pem" -out "$d/$s.pem" 2>/dev/null
done
dev:postgres:
desc: Start PostgreSQL, wait for readiness, provision the database roles
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
- |
# docker-compose.yml creates the dev database with a superuser named
# archie; provision the least-privilege roles deployments/dev.toml
# points at. Idempotent, so this also upgrades a volume created before
# the role split.
go run ./cmd/archie-state-store provision \
-admin-url "postgres://archie:archie@127.0.0.1:5432/archie?sslmode=disable" \
-runtime-url "postgres://archie_runtime:archie@127.0.0.1:5432/archie?sslmode=disable" \
-migration-url "postgres://archie_migrator:archie@127.0.0.1:5432/archie?sslmode=disable"
dev:wait-state:
internal: true
cmds:
- |
# Services read their settings from the State Store at boot and exit
# if it is not up yet, so wait for its port ([services.state] in
# deployments/dev.toml).
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
dev:daemon:
desc: Run archied with live reload
cmds:
- task: dev:wait-state
- 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, dev:tls]
cmds:
- go run ./cmd/archie-state-store -config-overlay deployments/dev.toml
dev:gateway:
desc: Run the development Gateway
cmds:
- task: dev:wait-state
- go run ./cmd/archie-gateway -config-overlay deployments/dev.toml
dev:messaging:
desc: Run the development Messaging Service
cmds:
- task: dev:wait-state
- go run ./cmd/archie-messaging -config-overlay deployments/dev.toml
dev:archie:
desc: Run the single archie binary against the development PostgreSQL (admin token "dev")
deps: [dev:postgres]
vars:
DIR: tmp/dev-archie
cmds:
- |
set -eu
mkdir -p {{.DIR}}
# Generated once: the age identity seals the dev credentials, so keep
# it across runs. Roles come from dev:postgres.
if [ ! -f {{.DIR}}/config.toml ]; then
umask 077
{
echo 'listen = "127.0.0.1:8080"'
echo "admin_token_sha256 = \"$(printf dev | sha256sum | cut -d' ' -f1)\""
echo "age_identity = \"$(go run ./cmd/archie -new-age-identity)\""
echo '[database]'
echo 'url = "postgres://archie_runtime:archie@127.0.0.1:5432/archie?sslmode=disable"'
echo 'owner_url = "postgres://archie_migrator:archie@127.0.0.1:5432/archie?sslmode=disable"'
} > {{.DIR}}/config.toml
fi
- go run ./cmd/archie -config {{.DIR}}/config.toml
dev:ui:
desc: Run Vite (requires the dashboard backend)
dir: ui
cmds:
- pnpm install
- pnpm run dev
e2e:up:
desc: Start the local stack without Docker (PostgreSQL 18, services, Vite) and seed it
cmds:
- bash e2e/stack.sh start
- bash e2e/seed.sh
e2e:down:
desc: Stop the local e2e stack
cmds:
- bash e2e/stack.sh stop
e2e:check:
desc: List browser checks; use -- all or -- CHECK to run, add --headed to watch
cmds:
- node e2e/run.cjs {{.CLI_ARGS}}
build:
desc: Build archie services and agent binaries
deps: [ui]
# Static, like the binaries a release ships, so `dist` reuses these
# compiled packages and only links again.
env:
CGO_ENABLED: "0"
vars:
GATEWAY_VERSION: '{{.GATEWAY_VERSION | default .VERSION}}'
RUNTIME_VERSION: '{{.RUNTIME_VERSION | default .VERSION}}'
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:
- Taskfile.yml
- "**/*.go"
# Files the binaries embed.
- "internal/**/*.sql"
- "internal/**/*.yaml"
- "internal/**/*.json"
- "internal/**/*.tpl"
- "internal/**/*.md"
- 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"
- "{{.BIN_DIR}}/archie"
cmds:
# One flag set for every service, matching the release workflow, so each
# binary reports the same version.
- for: [archie, archied, archie-gateway, archie-state-store, archie-ui, archie-messaging]
cmd: go build -trimpath -ldflags "{{.SERVICE_LDFLAGS}}" -o {{.BIN_DIR}}/{{.ITEM}} ./cmd/{{.ITEM}}
- go build -trimpath -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
dist:
desc: Build the linux/amd64 binaries a release ships into dist/ (VERSION=1.2.3; needs jq)
deps: [ui]
env:
GOOS: linux
GOARCH: amd64
CGO_ENABLED: "0"
vars:
DIST_LDFLAGS: >-
-X github.com/samcharles93/archie-core/internal/installtype.buildType=binary
-X github.com/samcharles93/archie-core/internal/buildinfo.Version={{.VERSION}}
-X github.com/samcharles93/archie-core/internal/buildinfo.Runtime={{.VERSION}}
-X github.com/samcharles93/archie-core/internal/app/agentworker.version={{.VERSION}}
cmds:
# release.json names what a release ships, so the zip and this build
# cannot disagree. The compiler flags match `build`, so after the gate
# has built bin/ this only links.
- |
set -eu
mkdir -p dist
for cmd in $(jq -r '.required_topology.units[], .required_topology.binaries[]?' release.json); do
go build -trimpath -ldflags "{{.DIST_LDFLAGS}}" -o "dist/$cmd" "./cmd/$cmd"
done
test:
desc: Run Go tests; the release gate passes TEST_FLAGS=-count=1
cmds:
- go test {{.TEST_FLAGS | default "-short"}} ./...
image:agent:
desc: Build the agent image stamped with this checkout's version
# Compose owns the image build; this only supplies the version, which a
# plain `docker build` has no way to learn from a context that excludes .git.
cmds:
- RUNTIME_VERSION={{.VERSION}} docker compose build agent
check:
desc: Run the full quality gate
# Finish mutations before starting parallel checks.
cmds:
# Node packages land under ui/, which `go test ./...` walks: installing
# them while the parallel checks scan the tree makes a lockfile update
# delete Go sources mid-walk. Install first, then fan out. Every Go step
# embeds ui/dist, so the dashboard is built before any of them.
- task: ui
- task: pages:check
- task: fmt
- task: proto:check
- task: db:check
- task: openapi:check
- task: check:readonly
wt:check:
desc: "Fix, format and check a worktree's Go packages, and the dashboard if ui/ changed (-- ./pkg/... to name packages; default: those changed since main)"
# A worktree has no ui/dist, so the Go steps build with no_ui. The full
# gate still runs once, on the merged tree.
cmds:
- |
set -eu
base="$(git merge-base HEAD main)"
changed="$( { git diff --name-only "$base"; git ls-files --others --exclude-standard; } | sort -u)"
pkgs="{{.CLI_ARGS}}"
if [ -z "$pkgs" ]; then
pkgs="$(printf '%s\n' "$changed" | grep '\.go$' | grep -v '^ui/' | xargs -r -n1 dirname | sort -u | while read -r d; do [ -d "$d" ] && echo "./$d"; done | tr '\n' ' ')"
fi
if [ -n "$pkgs" ]; then
echo "packages: $pkgs"
# The same fixes and formatters as task fmt, applied to these
# packages only; see fmt for why go fix runs until it converges.
converged=false
for pass in 1 2 3 4 5 6 7 8 9 10; do
go fix -tags no_ui $pkgs
if go fix -tags no_ui -diff $pkgs >/dev/null; then
converged=true
break
fi
done
if [ "$converged" != true ]; then
echo "go fix still rewrites these packages after 10 passes" >&2
exit 1
fi
golangci-lint fmt $pkgs
go vet -tags no_ui $pkgs
go test -short -tags no_ui $pkgs
golangci-lint run --build-tags no_ui $pkgs
fi
if printf '%s\n' "$changed" | grep -q '^ui/'; then
"{{.TASK_EXE}}" test:ui
fi
if [ -z "$pkgs" ] && ! printf '%s\n' "$changed" | grep -q '^ui/'; then
echo "nothing changed since main"
fi
check:readonly:
internal: true
deps:
- task: proto:lint
- task: vet
- task: lint
- task: build
- task: test
- task: test:ui
release:
desc: "Tag main as a release (RELEASE=major|minor|patch|1.2.3)"
requires:
vars: [RELEASE]
cmds:
- |
set -euo pipefail
die() { echo "release: $*" >&2; exit 1; }
[ "$(git rev-parse --abbrev-ref HEAD)" = main ] || die "releases are cut from main"
[ -z "$(git status --porcelain)" ] || die "the working tree is dirty"
last="$(git tag --list 'v*' --sort=-v:refname | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' | head -1 || true)"
IFS=. read -r major minor patch <<<"${last#v}"
case "{{.RELEASE}}" in
major) version="$((major + 1)).0.0" ;;
minor) version="$major.$((minor + 1)).0" ;;
patch) version="$major.$minor.$((patch + 1))" ;;
*) version="$(echo "{{.RELEASE}}" | sed 's/^v//')" ;;
esac
echo "$version" | grep -Eq '^[0-9]+\.[0-9]+\.[0-9]+(-[0-9A-Za-z.]+)?$' || die "$version is not a version"
! git rev-parse -q --verify "refs/tags/v$version" >/dev/null || die "v$version already exists"
git tag -a "v$version" -m "v$version"
echo "tagged v$version"