The site's sidebar held the landing page and one guide next to seventeen architecture records, the migration register, the review procedure and five PRDs. Nothing there is secret -- every development page may be read by anyone -- but a reader who wants to know what Archie is and how to point an event at it was meeting contributor material with no signal that it was not for them. One source tree now yields two sets: public (index, guides/) under /docs/, and development (architecture/, prds/) under /dev/, each with its own artifact and its own derived sidebar. archive/, inspiration/, news/ and the credential notes stay out of both, unchanged. Selective PRD publication is gone rather than carried over. It existed only because settled architecture cites PRDs and a link to a held-back target fails the generator, so five PRDs published to keep those citations alive; with both halves of every such citation in the development set, the exception has no work left to do. Both sets are generated in one pass over one url map, so a citation that crosses between them resolves to the base its target is served under, and the refusal now fires only for a target genuinely in neither set. Widening the set exposed a scanner bug worth its own note: the link regex matched `Resolve[T](i, src, exportPath)` inside a code span and refused the page for a link to `i,`. Code spans and fenced blocks are now skipped, because what a renderer draws as a link is the only thing this tool may rewrite or refuse a page for. docs/prds/public-and-dev-docs.md records the decision. Draft: the three choices in it are the maintainer's, the write-up is not yet reviewed.
586 lines
25 KiB
YAML
586 lines
25 KiB
YAML
version: "3"
|
|
|
|
vars:
|
|
BIN_DIR: "bin"
|
|
|
|
tasks:
|
|
default:
|
|
desc: List available tasks
|
|
cmds:
|
|
- task --list
|
|
|
|
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
|
|
|
|
proto:check:
|
|
desc: Regenerate contracts and reject uncommitted generated differences
|
|
cmds:
|
|
- bash tools/proto.sh check
|
|
|
|
docs:generate:
|
|
desc: Regenerate the committed contract reference from Archie-owned types
|
|
summary: |
|
|
Writes docs/data/generated/contracts.json. The output is committed, so
|
|
this dirties the tree deliberately: review the diff and commit it with
|
|
the code change that shifted the contract surface. Never hand-edit the
|
|
artifact.
|
|
|
|
-mod=readonly is mandatory on every `go -C tools` command; see
|
|
task test:tools for why.
|
|
cmds:
|
|
- go -C tools run -mod=readonly ./docsgen --repo-root ..
|
|
|
|
docs:check:
|
|
desc: Verify the committed contract reference matches Archie-owned types
|
|
summary: |
|
|
Implements Step 6 of docs/architecture/generated-documentation.md:
|
|
generates into a temporary directory, compares it with the committed
|
|
output, names the authoritative Go definition behind each mismatch, and
|
|
exits non-zero without modifying the working tree.
|
|
|
|
Fix a failure with `task docs:generate`, then commit the result in the
|
|
same commit as the code change that shifted the contract surface. This
|
|
checks rather than regenerates on purpose: a gate that silently rewrote
|
|
the artifact would bless an unintended contract change with no reviewer
|
|
ever seeing it, which Step 9 explicitly forbids.
|
|
cmds:
|
|
- go -C tools run -mod=readonly ./docsgen check --repo-root ..
|
|
|
|
docs:prds:
|
|
desc: Reject session-bound writing in docs/prds
|
|
summary: |
|
|
A PRD states a decision, a requirement, a constraint or evidence. Those
|
|
survive the code moving underneath them. A line number, a progress
|
|
report or a dated status claim does not: it is true on the day it is
|
|
written and silently wrong a month later, while still reading as
|
|
authoritative. The tracker records progress; the PRD records the design.
|
|
|
|
Each finding names the file, the line, the rule and the fix. There is no
|
|
--fix: the replacement is a judgement about what the sentence was for.
|
|
cmds:
|
|
- go -C tools run -mod=readonly ./prdlint --repo-root ..
|
|
|
|
news:
|
|
desc: Regenerate the news page and per-version release notes from the changelogs
|
|
summary: |
|
|
Writes docs/news/releases.json and docs/news/. The JSON is the
|
|
canonical, host-neutral fact set every renderer reads; the markdown is
|
|
the MkDocs adapter. Both come from CHANGELOG.archied.md and
|
|
CHANGELOG.archie.md, so cutting a release adds no writing here.
|
|
|
|
The files are committed, so this dirties the tree deliberately: review
|
|
the diff and commit it with the changelog that produced it. Never
|
|
hand-edit a generated release page.
|
|
|
|
tools/release.sh --tag runs this before the release commit, and it skips
|
|
any file whose bytes already match, so a re-run leaves the tree clean.
|
|
cmds:
|
|
- go -C tools run -mod=readonly ./newsgen --repo-root ..
|
|
|
|
news:check:
|
|
desc: Verify the committed release notes match the changelogs
|
|
summary: |
|
|
Derives the release notes in memory and fails when the committed files
|
|
differ, without modifying the working tree. Runs in `task check`, so a
|
|
changelog edit cannot land without its regeneration.
|
|
|
|
A file inside docs/news/<component>/ that the generator does not produce
|
|
is a finding too: that directory is generated, and a hand-written page
|
|
belongs at the docs/news root instead.
|
|
cmds:
|
|
- go -C tools run -mod=readonly ./newsgen check --repo-root ..
|
|
|
|
docs:artifact:
|
|
desc: Regenerate the canonical docs artifacts from the Markdown sources
|
|
summary: |
|
|
Writes docs/data/generated/docs.json and dev-docs.json: every published
|
|
page's url, title, section and raw Markdown body, plus the sidebar tree
|
|
derived from the layout, one file per set. The JSON is the canonical,
|
|
host-neutral fact set a renderer reads; the Markdown stays the source.
|
|
MkDocs was the first renderer and the Astro app is the second, so the
|
|
artifact is the product.
|
|
|
|
Two sets, split by audience: the public set (served under /docs/) is what a
|
|
reader of the product needs, the development set (/dev/) is architecture/
|
|
and prds/. The split and the reasons for what is held back entirely --
|
|
archive/, inspiration/, news/ and the credential notes -- live in
|
|
tools/docsite/main.go, because a renderer reading an artifact cannot see
|
|
why a page is absent from it.
|
|
|
|
The files are committed, so this dirties the tree deliberately: review the
|
|
diff and commit it with the page that produced it.
|
|
|
|
The artifact's keys are a frozen contract: an application is built against
|
|
them, so renaming one breaks a consumer this repository does not compile.
|
|
cmds:
|
|
- go -C tools run -mod=readonly ./docsite --repo-root ..
|
|
|
|
docs:artifact:check:
|
|
desc: Verify the committed docs artifacts match the Markdown sources
|
|
summary: |
|
|
Reproduces both artifacts in memory and fails when a committed file
|
|
differs, without modifying the working tree. Runs in `task check`, so a
|
|
page edit cannot land without its regeneration.
|
|
|
|
The generated directory is accounted for by docsgen's generatedArtifacts,
|
|
which names both files alongside contracts.json: one registry for the
|
|
directory rather than one per writer.
|
|
cmds:
|
|
- go -C tools run -mod=readonly ./docsite check --repo-root ..
|
|
|
|
vet:
|
|
desc: Run go vet
|
|
cmds:
|
|
- go vet ./...
|
|
|
|
lint:
|
|
desc: Run golangci-lint
|
|
summary: |
|
|
Both modules. ./... from the root stops at the root module, so the tools
|
|
module was never linted and drifted unseen -- the same hole task check
|
|
already closes for tests with test:tools.
|
|
cmds:
|
|
- golangci-lint run ./...
|
|
- task: lint:tools
|
|
|
|
lint:tools:
|
|
desc: Run golangci-lint over the tools module
|
|
summary: |
|
|
./... from the root stops at the root module, so the tools module was
|
|
never linted and drifted unseen -- the same hole task check already
|
|
closes for tests with test:tools.
|
|
dir: tools
|
|
cmds:
|
|
- golangci-lint run ./...
|
|
|
|
lint:playbooks:
|
|
desc: "Lint playbook binding dirs for collisions (standalone tool, cmd/archie-playbooks)"
|
|
summary: |
|
|
Runs the standalone playbook linter (archie-playbooks lint) against
|
|
./playbooks by default. It validates playbook YAML binding files
|
|
against the same loaders the daemon uses at startup, so a pre-merge
|
|
check can never disagree with runtime validation. Exit non-zero on
|
|
any collision / malformed file / invalid binding.
|
|
|
|
Lint a different set of directories directly:
|
|
go run ./cmd/archie-playbooks lint -dir ./a -dir ./b
|
|
cmds:
|
|
- go run ./cmd/archie-playbooks lint -dir ./playbooks
|
|
|
|
vuln:
|
|
desc: "Scan for known stdlib/dependency CVEs (govulncheck). Not part of task check: it needs network access to the vuln DB and is not build/test-blocking; run it explicitly or in CI."
|
|
cmds:
|
|
- govulncheck ./...
|
|
|
|
deadcode:
|
|
desc: "Report functions no shipped binary can reach (whole-program RTA from ./cmd/...). Not part of task check: it reports a standing backlog, so gating on it would fail every run until that backlog is zero."
|
|
summary: |
|
|
Answers "is this reachable in production", which no linter does:
|
|
golangci-lint's unused check is package-scoped, so anything exported
|
|
and called from a sibling package looks live even when no binary
|
|
reaches it.
|
|
|
|
Run via `go run ...@latest` deliberately. A locally installed deadcode
|
|
built against an older Go than this module exits non-zero and prints
|
|
NOTHING, which reads as "no dead code" instead of "analysis failed".
|
|
Building it against the repo toolchain makes that failure impossible.
|
|
|
|
-test=false is the point of the report: a function reached only by its
|
|
own tests is not reachable in production.
|
|
|
|
Read the output in one direction only. RTA over-approximates what is
|
|
reachable, so "unreachable func" is sound and worth acting on, while
|
|
silence proves nothing: interface dispatch and any address-taken
|
|
function (every reflect.ValueOf entry in the *extract tables) is
|
|
assumed reachable whether or not it is ever called.
|
|
cmds:
|
|
- go run golang.org/x/tools/cmd/deadcode@latest -test=false ./cmd/...
|
|
|
|
reachaudit:
|
|
desc: "Classify unreachable code as tracked / untracked / dynamic (tools/reachaudit). Wraps task deadcode with provenance and tracker status."
|
|
summary: |
|
|
deadcode says a function is unreachable. reachaudit says whether that
|
|
is a known gap, a forgotten one, or an artifact of runtime loading
|
|
(yaegi, reflection) that must never be deleted.
|
|
|
|
Two report sections, because a dead whole package and a dead symbol
|
|
inside a live one are different failure modes: "unreachable-*" is a
|
|
package no shipped binary imports at all; "in-package-*" is a symbol
|
|
dead inside a package that IS shipped -- the ChatCourier/Dispatch
|
|
shape, where the feature is wired everywhere except its own call site.
|
|
Both carry the same tracked/untracked/dynamic classification.
|
|
|
|
--refresh re-runs the analysis. Without it the tool reuses
|
|
/tmp/reachaudit-deadcode-<sha>.txt with no staleness check beyond HEAD
|
|
and a dirty-tree check, which will happily report last week's tree
|
|
against today's code if HEAD hasn't moved.
|
|
|
|
--json PATH and --md PATH write the same findings as structured data or
|
|
a Markdown report, in addition to the terminal summary.
|
|
cmds:
|
|
- python3 tools/reachaudit/reachaudit.py --repo . {{.CLI_ARGS}}
|
|
docs:site:
|
|
desc: "Build the documentation site into ./site (MkDocs). --strict, so a dead internal link fails the build."
|
|
summary: |
|
|
Publishes docs/ minus the subtrees held back in mkdocs.yml's
|
|
exclude_docs. Requires mkdocs-material:
|
|
|
|
pip install --user mkdocs-material
|
|
|
|
Distinct from docs:check, which verifies the generated contract data
|
|
rather than the site.
|
|
cmds:
|
|
- mkdocs build --strict
|
|
|
|
docs:serve:
|
|
desc: "Serve the documentation site locally with live reload on :8000."
|
|
cmds:
|
|
- mkdocs serve
|
|
|
|
ui:deps:
|
|
desc: Install the dashboard's node dependencies (ui/node_modules is gitignored)
|
|
internal: true
|
|
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
|
|
summary: |
|
|
ui/dist is committed because the Go build embeds it, so it is a generated
|
|
source file. Nothing else in the gate reads it and `task ui` rewrites it
|
|
in place, so before this a change to ui/src that landed without the
|
|
rebuilt bundle was invisible -- and two agents in two worktrees could each
|
|
"pass" while producing different dashboards.
|
|
|
|
Builds somewhere temporary and compares, never rewriting the committed
|
|
artifact, which is the rule docs:check already follows for the contract
|
|
reference. A gate that rebuilt ui/dist in place would bless an unintended
|
|
UI change with no reviewer ever seeing it.
|
|
|
|
Fix a failure with `task ui`, then commit the rebuilt bundle in the same
|
|
commit as the source change that caused it.
|
|
|
|
Declares ui:deps like `ui` and `test:ui` do, so a fresh clone works; that
|
|
means the gate runs `npm install` once for each dependent. Task's
|
|
sources/generates up-to-date check does not apply to a node_modules
|
|
directory, so the guard against that is a follow-up, not a claim here.
|
|
deps: [ui:deps]
|
|
cmds:
|
|
- bash tools/uidist.sh check
|
|
|
|
test:ui:
|
|
desc: Test and type-check the dashboard
|
|
dir: ui
|
|
# ui:deps so a fresh clone fails on a real error rather than on a missing
|
|
# node_modules, which is gitignored and installed by nothing else.
|
|
deps: [ui:deps]
|
|
cmds:
|
|
- npm test
|
|
- npm run typecheck
|
|
|
|
# A test event for the capture intake, so the Events surfaces can be driven by
|
|
# hand without a real webhook source. See tools/webhook-send.sh --list.
|
|
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: "Develop: archied live-reload + archie-gateway + archie-state-store + archie-ui + Vite HMR together. Open http://localhost:5173"
|
|
summary: |
|
|
Runs the dev loop in one terminal:
|
|
|
|
* air rebuilds and restarts archied on Go changes
|
|
* archie-gateway serves ChatContract on 127.0.0.1:8585 (archied
|
|
and archie-ui dial it; neither embeds a gateway)
|
|
* archie-state-store owns archie.db on 127.0.0.1:9091, loopback,
|
|
no token (deployments/dev.toml); archied,
|
|
archie-gateway and archie-ui dial it -- none owns
|
|
the DB in-process
|
|
(docs/prds/state-store-contract.md §12 step 7)
|
|
* archie-ui serves the dashboard on 127.0.0.1:8484 from the
|
|
embedded dist (deployments/dev.toml). After the
|
|
UI cutover (archie-core-8cda.5.4) archied runs no
|
|
dashboard listener: this is what :8484 is.
|
|
* vite serves the dashboard with hot reload on :5173,
|
|
proxying /api and /events through to archie-ui
|
|
on :8484
|
|
|
|
The gRPC ports come from [services.state].listen and [services.gateway].listen in
|
|
deployments/dev.toml, each paired with the target that dials it. Move a pair there
|
|
together when a port is already taken on the host.
|
|
|
|
Open http://localhost:5173 -- not :8484. The Vite server is the one with
|
|
hot reload; :8484 serves the last built dist/ and will look stale.
|
|
|
|
Ctrl-C stops all five.
|
|
deps: [dev:daemon, dev:gateway, dev:state-store, dev:dashboard, dev:ui]
|
|
|
|
dev:daemon:
|
|
desc: archied only, live-reloading via air (prefer `task dev`)
|
|
cmds:
|
|
- air -build.args_bin="-config-overlay,deployments/dev.toml"
|
|
|
|
dev:dashboard:
|
|
desc: archie-ui only, no live-reload (prefer `task dev`)
|
|
cmds:
|
|
- go run ./cmd/archie-ui -config-overlay deployments/dev.toml
|
|
|
|
dev:state-store:
|
|
desc: archie-state-store only, no live-reload (prefer `task dev`)
|
|
cmds:
|
|
- go run ./cmd/archie-state-store -config-overlay deployments/dev.toml
|
|
|
|
dev:gateway:
|
|
desc: archie-gateway only, no live-reload (prefer `task dev`)
|
|
# The overlay carries [services.state].target, which archie-gateway
|
|
# requires (openStateStoreAdapter fails closed on an empty target).
|
|
# Without it `task dev` leaves the gateway dialling whatever the
|
|
# developer's installed config names, or unable to start at all, while
|
|
# archied, archie-ui and the state store all dial 127.0.0.1:9091.
|
|
cmds:
|
|
- go run ./cmd/archie-gateway -config-overlay deployments/dev.toml
|
|
|
|
dev:ui:
|
|
desc: Vite dev server only, expects archie-ui already running (prefer `task dev`)
|
|
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
|
|
summary: |
|
|
Starts archie-ui with a LAN-reachable [web] bind and a minted dashboard
|
|
token, printing the URL (LAN IP + token) and a QR code to scan. After
|
|
the UI cutover the dashboard is archie-ui's process: this task starts
|
|
archie-ui only. Run the daemon separately (task dev, or archied) for
|
|
actual archie operation -- two daemons sharing the bot identity would
|
|
double-poll the forge.
|
|
|
|
The frontend served is the embedded dist, so run `task ui` if you
|
|
changed the frontend. The token file is the path archied used to mint
|
|
before the cutover, so an existing phone setup keeps its token.
|
|
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
|
|
# Version stamping used to live only in Dockerfile.archied, so any build
|
|
# from source -- including a host deployment -- reported "dev" for
|
|
# both components and /version was useless there. Derive the same
|
|
# -X values from the release tags so a source build is stamped too.
|
|
# git describe (without --abbrev=0) yields 1.7.0-2-gbb54786 when HEAD is
|
|
# past the tag, which is the honest answer for a mid-cycle build.
|
|
vars:
|
|
GATEWAY_VERSION:
|
|
sh: git describe --tags --match 'archied/v*' 2>/dev/null | sed 's|^archied/v||' || echo dev
|
|
RUNTIME_VERSION:
|
|
sh: git describe --tags --match 'archie/v*' 2>/dev/null | sed 's|^archie/v||' || echo dev
|
|
sources:
|
|
- "**/*.go"
|
|
- go.mod
|
|
- go.sum
|
|
# ui/dist is committed and embedded by ui/embed.go (//go:embed all:dist),
|
|
# so it is a build input even though no .go file names it.
|
|
- "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:
|
|
- go build -ldflags "-X github.com/samcharles93/archie-core/internal/app/archied.gatewayVersion={{.GATEWAY_VERSION}} -X github.com/samcharles93/archie-core/internal/app/archied.runtimeVersion={{.RUNTIME_VERSION}} -X github.com/samcharles93/archie-core/internal/installtype.buildType=binary" -o {{.BIN_DIR}}/archied ./cmd/archied
|
|
- go build -ldflags "-X github.com/samcharles93/archie-core/internal/app/archied.gatewayVersion={{.GATEWAY_VERSION}} -X github.com/samcharles93/archie-core/internal/installtype.buildType=binary" -o {{.BIN_DIR}}/archie-gateway ./cmd/archie-gateway
|
|
- go build -ldflags "-X github.com/samcharles93/archie-core/internal/installtype.buildType=binary" -o {{.BIN_DIR}}/archie-state-store ./cmd/archie-state-store
|
|
- go build -ldflags "-X github.com/samcharles93/archie-core/internal/installtype.buildType=binary" -o {{.BIN_DIR}}/archie-ui ./cmd/archie-ui
|
|
- go build -ldflags "-X github.com/samcharles93/archie-core/internal/installtype.buildType=binary" -o {{.BIN_DIR}}/archie-messaging ./cmd/archie-messaging
|
|
- 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 the Go test suite
|
|
cmds:
|
|
- go test ./... -count=1
|
|
|
|
test:tools:
|
|
desc: Run the nested tools module suite, refusing to rewrite its go.mod
|
|
summary: |
|
|
tools/go.mod replaces the root module, so its build list must satisfy
|
|
the root module's requirements. When the root moves on, the tools module
|
|
goes stale and any plain go command there rewrites tools/go.mod and
|
|
tools/go.sum to catch up, leaving an unrelated dirty diff.
|
|
|
|
-mod=readonly is explicit because a developer's global GOFLAGS=-mod=mod
|
|
overrides the toolchain default and re-enables the silent rewrite.
|
|
Fix a failure here with: go -C tools mod tidy
|
|
cmds:
|
|
- go -C tools test -mod=readonly ./... -count=1
|
|
|
|
check:
|
|
desc: "Full quality gate: fmt, proto, docs, vet, lint, build, test, tools tests, ui tests and bundle"
|
|
cmds:
|
|
- task: fmt
|
|
- task: proto:lint
|
|
- task: proto:check
|
|
- task: docs:check
|
|
- task: docs:prds
|
|
# Release notes are generated from the changelogs the release process
|
|
# already freezes. Left out of the gate, a changelog edit would land
|
|
# while the published notes silently lag behind it.
|
|
- task: news:check
|
|
# The public-docs artifact is what the site renders, so a page edit that
|
|
# does not reach it publishes a site that disagrees with the repository.
|
|
- task: docs:artifact:check
|
|
- task: vet
|
|
- task: lint
|
|
- task: build
|
|
- task: test
|
|
# The tools module is not covered by ./... from the root; without this
|
|
# its dependency drift is only ever discovered by a command that
|
|
# silently repairs it.
|
|
- task: test:tools
|
|
# The dashboard's suite runs here too. Left out of the gate it rots
|
|
# silently: nothing else executes it, so a broken DOM primitive ships.
|
|
- task: test:ui
|
|
# ...and so is the bundle that suite is built from. ui/dist is committed
|
|
# and embedded; nothing else checks it against ui/src, and `task ui`
|
|
# rewrites it in place, so a forgotten rebuild used to leave no trace in
|
|
# the gate at all.
|
|
- task: ui:check
|
|
|
|
contract:
|
|
desc: "Report contract conformance: declared surfaces, their consumers, and the drift between them"
|
|
summary: |
|
|
Walks every declared contract surface -- the two gRPC services, the
|
|
dashboard HTTP API -- and classifies each subject as consumed,
|
|
declared-unconsumed, undeclared, or a stale declaration.
|
|
|
|
ADVISORY, and deliberately NOT part of `task check`, matching
|
|
tools/reachaudit. The surfaces are discovered by scanning source text:
|
|
the .proto files, the adapter bodies that call the generated client, the
|
|
route registrations in internal/webui, and the path literals under
|
|
ui/src. That makes it useful for a periodic survey and unsafe as a gate
|
|
-- a rename or a reformat elsewhere in the tree can change its output
|
|
without anything being wrong, and it has already produced a batch of
|
|
false "unconsumed" readings once when the dashboard's request helper was
|
|
renamed.
|
|
|
|
Read the findings as a prompt to go and check, not as a verdict. To make
|
|
it fail on an undeclared or stale entry, pass --strict by hand:
|
|
|
|
go -C tools run ./contractaudit --repo-root .. --strict
|
|
|
|
See docs/prds/contract-conformance-audit.md.
|
|
cmds:
|
|
- go -C tools run ./contractaudit --repo-root ..
|
|
|
|
release:preview:
|
|
desc: "Show the release notes that would be generated (VERSION=1.2.0, or GATEWAY=/RUNTIME= to version the two components separately)"
|
|
cmds:
|
|
- tools/release.sh --gateway {{.GATEWAY | default .VERSION}} --runtime {{.RUNTIME | default .VERSION}} --dry-run
|
|
requires:
|
|
vars: [VERSION]
|
|
|
|
release:prepare:
|
|
desc: "Write the generated notes into the changelogs, uncommitted, for editing (VERSION=1.2.0)"
|
|
cmds:
|
|
- tools/release.sh --gateway {{.GATEWAY | default .VERSION}} --runtime {{.RUNTIME | default .VERSION}} --prepare
|
|
requires:
|
|
vars: [VERSION]
|
|
|
|
release:
|
|
desc: "Freeze the edited changelogs into a release commit and tags (VERSION=1.2.0). Run release:prepare first."
|
|
cmds:
|
|
- tools/release.sh --gateway {{.GATEWAY | default .VERSION}} --runtime {{.RUNTIME | default .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
|