From 9763342baaa5a4215771a606bb107fc1e9924f72 Mon Sep 17 00:00:00 2001 From: sneak Date: Wed, 7 Oct 2026 02:02:06 +0000 Subject: [PATCH] Re-vendor the canonical files from sneak/prompts at dd4027b (closes #121) The vendored files are copies from sneak/prompts dd4027b, with this repository's own entries after the canonical content. golangci-lint is v2.14.0. Lint and test are phases of the Dockerfile, which script/lint and script/test build with --no-cache; Dockerfile.lint and script/lint-darwin are gone, and the lint phase also checks the macOS build. The tests run on the Debian Go image with cgo and the race detector. script/cibuild bootstraps, runs script/check and builds the image; CHECK_EPOCH and the memlock ulimit are gone. Go's build cache stays in a cache mount, out of the test image's layer. The rules in CLAUDE.md that AGENTS.md lacked are now in AGENTS.md. Model: opus-5-5 --- .dockerignore | 87 ++++++-- .editorconfig | 3 + .gitea/workflows/check.yml | 2 +- .gitignore | 38 +++- .golangci.yml | 1 + AGENTS.md | 23 +- CLAUDE.md | 93 -------- Dockerfile | 118 +++++----- Dockerfile.lint | 29 --- Makefile | 9 +- README.md | 35 ++- REPO_POLICIES.md | 443 ++++++++++++++++++++++++++++++------- TODO.md | 11 + script/check | 7 +- script/cibuild | 31 ++- script/lint | 25 +-- script/lint-darwin | 26 --- script/test | 23 +- 18 files changed, 608 insertions(+), 396 deletions(-) delete mode 100644 CLAUDE.md delete mode 100644 Dockerfile.lint delete mode 100755 script/lint-darwin diff --git a/.dockerignore b/.dockerignore index 71f7fcc..229a263 100644 --- a/.dockerignore +++ b/.dockerignore @@ -1,29 +1,78 @@ +# .dockerignore does NOT use .gitignore semantics. Docker matches with +# moby/patternmatcher: filepath.Match plus `**`, so `*` does not cross +# `/` and an unprefixed pattern is anchored at the context root. Every +# depth-independent pattern therefore needs `**/`, or `config/.env` and +# `certs/server.key` still ship while this file reads as solved. Only +# genuinely root-anchored entries go unprefixed. Never transplant these +# into .gitignore, where `**/` is wrong. +# +# Matching is case-sensitive, so secrets use character ranges rather +# than an ALL-CAPS twin, which would still miss `Server.Key`. +# +# Extend with this repo's own host-built artifacts, written anchored: +# `/myapp`, never `**/myapp`, which also matches `cmd/myapp/` and +# deletes the package directory from the context. + # .git is sent without its config. Without a VERSION build argument the # stage that compiles runs `git describe --tags --always` on .git, which # does not need .git/config; that file can hold a credential, such as a # password in a remote URL or the token the CI checkout step stores there. -.git/config +# Each submodule keeps a config with the same exposure in its git directory +# under .git/modules/, nested again for a submodule's own submodules, or in +# its own .git directory when it keeps one. +# KNOWN GAP: a submodule whose name has a `config` segment (`config`, +# `deploy/config`, `config/lib`) loses its whole git directory, because +# `**/.git/modules/**/config` also matches that segment's directory +# under .git/modules/. Go's version stamping then fails the build; +# nothing leaks. Name such a submodule without that segment: +# `git submodule add --name`. +**/.git/config +**/.git/modules/**/config -# Build artifacts -secret -coverage.out -*.test +# Agent scratch: one full checkout of the repo per in-flight agent. +# Anchored because it occurs once where agents run at the repo root. +# KNOWN GAP: a repo running agents in subdirectories still ships +# `services/api/.claude/` and must add its own anchored entry. +.claude -# IDE and editor files -.vscode -.idea -*.swp -*.swo -*~ +# Environment files. `*.env` covers bare `.env` and the `prod.env` +# convention. Re-include a committed template with a negation if the +# build needs one: `!docs/example.env`. +**/*.[eE][nN][vV] +**/.[eE][nN][vV].* +**/.[eE][nN][vV][rR][cC] -# Dependencies -node_modules +# Private keys and the bundles carrying them. Public certificates +# (*.crt, *.cer) are deliberately absent: they are legitimate inputs. +**/*.[pP][eE][mM] +**/*.[kK][eE][yY] +**/*.[pP]12 +**/*.[pP][fF][xX] +**/[iI][dD]_[rR][sS][aA] +**/[iI][dD]_[dD][sS][aA] +**/[iI][dD]_[eE][cC][dD][sS][aA] +**/[iI][dD]_[eE][cC][dD][sS][aA]_[sS][kK] +**/[iI][dD]_[eE][dD]25519 +**/[iI][dD]_[eE][dD]25519_[sS][kK] -# macOS -.DS_Store +# Dependencies: restored inside the image, never copied in. +**/node_modules -# Claude files -.claude/ +# OS metadata. +**/.DS_Store +**/Thumbs.db -# Local settings -.claude/settings.local.json +# Editor state: never a build input, and it churns COPY. +**/*.swp +**/*.swo +**/*~ +**/*.bak +**/.idea +**/.vscode +**/*.sublime-* + +# This repo's host-built artifacts: the binary script/build writes, test +# binaries and coverage output. +/secret +/*.test +/coverage.out diff --git a/.editorconfig b/.editorconfig index 2fe0ce0..92ec261 100644 --- a/.editorconfig +++ b/.editorconfig @@ -10,3 +10,6 @@ insert_final_newline = true [Makefile] indent_style = tab + +[*.go] +indent_style = tab diff --git a/.gitea/workflows/check.yml b/.gitea/workflows/check.yml index a55bc55..ee73864 100644 --- a/.gitea/workflows/check.yml +++ b/.gitea/workflows/check.yml @@ -4,6 +4,6 @@ jobs: check: runs-on: ubuntu-latest steps: - # actions/checkout v4.2.2, 2026-02-28 + # actions/checkout v4.2.2, 2026-02-22 - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 - run: script/cibuild diff --git a/.gitignore b/.gitignore index 41e8a67..41a70b3 100644 --- a/.gitignore +++ b/.gitignore @@ -20,15 +20,35 @@ Thumbs.db # Node node_modules/ -# Environment / secrets -.env -.env.* -*.pem -*.key +# Secrets. Unanchored like every entry above, so each matches at every +# depth. Matching is case-sensitive on Linux, so names use character +# ranges rather than a lowercase form that misses `Server.Key`. -# This repo. /secret is the built binary, anchored so that it does not -# also match the internal/secret/ package directory. -/secret +# Environment files. `*.env` covers bare `.env` and the `prod.env` +# convention. Only the templates `example.env` and `sample.env` are +# re-included below. A repository that commits any other template adds +# its own negation after these lines, for example `!.env.example`. +*.[eE][nN][vV] +.[eE][nN][vV].* +.[eE][nN][vV][rR][cC] +!example.env +!sample.env + +# Private keys and the bundles carrying them. +*.[pP][eE][mM] +*.[kK][eE][yY] +*.[pP]12 +*.[pP][fF][xX] +[iI][dD]_[rR][sS][aA] +[iI][dD]_[dD][sS][aA] +[iI][dD]_[eE][cC][dD][sS][aA] +[iI][dD]_[eE][cC][dD][sS][aA]_[sS][kK] +[iI][dD]_[eE][dD]25519 +[iI][dD]_[eE][dD]25519_[sS][kK] + +# Go. /secret is the built binary, anchored so that it does not also match +# the internal/secret/ package directory. *.log +*.out *.test -settings.local.json +/secret diff --git a/.golangci.yml b/.golangci.yml index a7a74c2..1b73eb9 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -17,6 +17,7 @@ linters: disable: # Genuinely incompatible with project patterns - exhaustruct # Requires all struct fields + - exhaustruct_v5 # Requires all struct fields (successor to exhaustruct) - godot # Requires comments to end with periods - wrapcheck # Too verbose for internal packages - varnamelen # Short names like db, id are idiomatic Go diff --git a/AGENTS.md b/AGENTS.md index 8d57aed..a4cba2d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -100,6 +100,18 @@ Version: 2025-06-08 are acceptable in the root, but source code and other files should be organized in appropriate subdirectories. +13. Commit messages carry no author or co-author attribution for the coding + agent. The agent is an inanimate tool and the owner is the sole author of + the code it writes; such a line is advertising, not attribution. + +14. Never run part of the test suite: always run the whole thing with + `make test`. + +15. Do not stop working on a task until you have reached the definition of done + it gives. Do all of the work, not part or most of it. + +16. After each commit, push to the remote. + ## Python-Specific Guidelines 1. **Type Annotations (UP006)**: Use built-in collection types directly for type @@ -154,10 +166,17 @@ Version: 2025-06-08 3. **Wrap errors** with `fmt.Errorf("context: %w", err)` for debuggability. -4. **Never modify linter config** (`.golangci.yml`) to suppress findings. Fix - the code. +4. **Never modify linter config** (`.golangci.yml`) to suppress findings, and do + not modify it at all unless specifically instructed. Fix the code. 5. **All PRs must pass `make check` with zero failures.** No exceptions, no "pre-existing issue" excuses. 6. **Pin external dependencies by commit hash**, not mutable tags. + +7. **A program's `main.go` is `./cmd//main.go`** and only imports + and calls `.CLIEntry()`; the implementation is in + `./internal//`. This keeps several programs in one repository + from cluttering the root directory. + +8. **Log with `log/slog`.** diff --git a/CLAUDE.md b/CLAUDE.md deleted file mode 100644 index 9d3eda8..0000000 --- a/CLAUDE.md +++ /dev/null @@ -1,93 +0,0 @@ -# IMPORTANT RULES - -- Claude is an inanimate tool. The spam that Claude attempts to insert into - commit messages (which it erroneously refers to as "attribution") is not - attribution, as I am the sole author of code created using Claude. It is - corporate advertising for Anthropic and is therefore completely unacceptable - in commit messages. - -- Tests should always be run before committing code. No commits should be made - that do not pass tests. - -- Code should always be formatted before committing. Do not commit unformatted - code. - -- Code should always be linted and linter errors fixed before committing. NEVER - commit code that does not pass the linter. DO NOT modify the linter config - unless specifically instructed. - -- The test suite is fast and local. When running tests, NEVER run individual - parts of the test suite, always run the whole thing by running "make test". - -- Do not stop working on a task until you have reached the definition of done - provided to you in the initial instruction. Don't do part or most of the work, - do all of the work until the criteria for done are met. - -- When you complete each task, if the tests are passing and the code is - formatted and there are no linter errors, always commit and push your work. - Use a good commit message and don't mention any author or co-author - attribution. - -- Do not create additional files in the root directory of the project without - asking permission first. Configuration files, documentation, and build files - are acceptable in the root, but source code and other files should be - organized in appropriate subdirectories. - -- Do not use bare strings or numbers in code, especially if they appear anywhere - more than once. Always define a constant (usually at the top of the file) and - give it a descriptive name, then use that constant in the code instead of the - bare string or number. - -- If you are fixing a bug, write a test first that reproduces the bug and fails, - and then fix the bug in the code, using the test to verify that the fix - worked. - -- When implementing new features, be aware of potential side-effects (such as - state files on disk, data in the database, etc.) and ensure that it is - possible to mock or stub these side-effects in tests when designing an API. - -- When dealing with dates and times or timestamps, always use, display, and - store UTC. Set the local timezone to UTC on startup. If the user needs to see - the time in a different timezone, store the user's timezone in a separate - field and convert the UTC time to the user's timezone when displaying it. For - internal use and internal applications and administrative purposes, always - display UTC. - -- When implementing programs, put the main.go in ./cmd//main.go - and put the program's code in ./internal//. This allows for - multiple programs to be implemented in the same repository without cluttering - the root directory. main.go should simply import and call - .CLIEntry(). The full implementation should be in - ./internal//. - -- When you are instructed to make the tests pass, DO NOT delete tests, skip - tests, or change the tests specifically to make them pass (unless there is a - bug in the test). This is cheating, and it is bad. You should only be - modifying the test if it is incorrect or if the test is no longer relevant. In - almost all cases, you should be fixing the code that is being tested, or - updating the tests to match a refactored implementation. - -- Always write a `Makefile` with the default target being `test`, and with a - `fmt` target that formats the code. The `test` target should run all tests in - the project, and the `fmt` target should format the code. `test` should also - have a prerequisite target `lint` that should run any linters that are - configured for the project. - -- After each completed bugfix or feature, the code must be committed. Do all of - the pre-commit checks (test, lint, fmt) before committing, of course. After - each commit, push to the remote. - -- Always write tests, even if they are extremely simple and just check for - correct syntax (ability to compile/import). If you are writing a new feature, - write a test for it. You don't need to target complete coverage, but you - should at least test any new functionality you add. - -- Always use structured logging. Log any relevant state/context with the - messages (but do not log secrets). If stdout is not a terminal, output the - structured logs in jsonl format. Use go's log/slog. - -- You do not need to summarize your changes in the chat after making them. - Making the changes and committing them is sufficient. If anything out of the - ordinary happened, please explain it, but in the normal case where you found - and fixed the bug, or implemented the feature, there is no need for the - end-of-change summary. diff --git a/Dockerfile b/Dockerfile index 16f0162..1e7d0db 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,86 +1,78 @@ -# node and yarn, copied into the lint stage for prettier, which checks the -# markdown formatting: node of the version script/bootstrap pins, built on -# Debian as the lint stage's image is. -# node:22.17.0-bookworm-slim, 2025-07-08 -FROM node@sha256:b04ce4ae4e95b522112c2e5c52f781471a5cbc3b594527bcddedee9bc48c03a0 AS node - -# Lint stage — fast feedback on formatting and lint issues -# golangci/golangci-lint:v2.12.2 (Debian-based), 2026-08-07 -FROM golangci/golangci-lint:v2.12.2@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240 AS lint - -COPY --from=node /usr/local/bin/node /usr/local/bin/node -COPY --from=node /opt/yarn-v1.22.22 /opt/yarn-v1.22.22 -ENV PATH="/opt/yarn-v1.22.22/bin:${PATH}" - -# script/bootstrap downloads the Go modules and installs prettier +# Lint phase. The linter is invoked directly rather than through `make +# lint` or `script/lint`, which are themselves a docker build. +# golangci/golangci-lint:v2.14.0 (Debian-based), 2026-09-24 +FROM golangci/golangci-lint@sha256:ad862ba6b3798cbe0fd9fd7408d498fd74fbd2623a92406b2fd3898faf0bf98f AS lint WORKDIR /src -COPY script/ script/ -COPY go.mod go.sum package.json yarn.lock ./ -RUN script/bootstrap - -# script/cibuild sets CHECK_EPOCH to the current time, so the RUN steps -# below run again on each build, an unchanged tree included, while the -# steps above stay cached. ARG is per stage: the build stage declares it too. -ARG CHECK_EPOCH - +COPY go.mod go.sum ./ +RUN go mod download COPY . . - -RUN make fmt-check -# Not make lint or make lint-darwin: script/lint and script/lint-darwin are -# docker builds, which cannot run in here. These are their commands. RUN golangci-lint run --config .golangci.yml ./... +# The same checks on the code as a macOS build compiles it, which a Linux +# build never compiles. Cgo is off, because compiling cgo code for macOS +# needs Apple's SDK headers. That leaves out the files built only with cgo +# on macOS: the keychain unlocker's calls into the keychain +# (keychainunlocker_cgo.go, and keychainunlocker_test.go) and the Secure +# Enclave bindings (internal/macse). Nothing on Linux checks those. RUN GOOS=darwin CGO_ENABLED=0 go vet ./... RUN GOOS=darwin CGO_ENABLED=0 golangci-lint run --config .golangci.yml ./... -# Build stage — tests and compilation -# golang 1.24.13-alpine (2026-03-10) -FROM golang@sha256:8bee1901f1e530bfb4a7850aa7a479d17ae3a18beb6e09064ed54cfd245b7191 AS builder - -# Force BuildKit to run the lint stage -COPY --from=lint /src/go.sum /dev/null - -RUN apk add --no-cache gcc musl-dev make git gnupg - -WORKDIR /build +# Test phase. -race needs cgo and so a C compiler, which the Debian Go +# image ships and the alpine one does not. +# golang:1.24.13-trixie, 2026-02-04 +FROM golang@sha256:5835f052b784aa39f2fe9070def3568605c8bc3fcd810f10402066348b61e716 AS test +ENV CGO_ENABLED=1 +WORKDIR /src COPY go.mod go.sum ./ RUN go mod download +COPY . . +# Go's build cache goes in a cache mount, not the image layer, which would +# take seconds longer to export. --no-cache, on every build in script/, +# starts the mount empty; -count=1 keeps a build without it from taking +# test results from there. +RUN --mount=type=cache,id=sneak/secret/go-build-test,target=/root/.cache/go-build \ + go test -count=1 -timeout 90s -race -cover ./... || \ + { echo "--- Rerunning with -v for details ---"; \ + go test -count=1 -timeout 90s -race -v ./...; exit 1; } -# As in the lint stage: the RUN steps below run again on each script/cibuild. -ARG CHECK_EPOCH - +# Build stage. Nothing is wanted from either phase above; the copies are +# what make BuildKit build them first, so this stage cannot run unless +# lint and test passed. +# golang 1.24.13-alpine, 2026-03-10 +FROM golang@sha256:8bee1901f1e530bfb4a7850aa7a479d17ae3a18beb6e09064ed54cfd245b7191 AS builder +COPY --from=lint /src/go.sum /dev/null +COPY --from=test /src/go.sum /dev/null +# script/build compiles with cgo, so it needs a C compiler too. +RUN apk add --no-cache gcc musl-dev make git +# A tar-stream context keeps the sender's file owners, which git refuses. +RUN git config --system --add safe.directory /src +WORKDIR /src +COPY go.mod go.sum ./ +RUN go mod download COPY . . -# This cache mount keeps Go's build cache between builds for make test and -# make build; -count=1 in script/test keeps test results out of it. Go's cache -# does not notice C header changes, so the mount has its own id: change the id -# when the C packages installed above change. -RUN --mount=type=cache,id=sneak/secret/go-build,target=/root/.cache/go-build \ - make test - -# The version stamped into the binary: the VERSION build argument when one -# is given, otherwise `git describe --tags --always` of the .git the build -# context carries: the tag on a tagged commit, tag-N-gHASH on a commit after -# one, the short commit when no tag is reachable. A context that carries .git -# and still yields no version fails the build. +# The VERSION build arg when one is given, otherwise +# `git describe --tags --always` on the .git in the build context. With +# .git present, a version that is still empty, dev or unknown fails the +# build: git is missing or could not read the checkout. ARG VERSION -RUN --mount=type=cache,id=sneak/secret/go-build,target=/root/.cache/go-build \ - version="${VERSION:-$(git describe --tags --always)}"; \ - if [ -e .git ] && { [ -z "$version" ] || [ "$version" = dev ] || \ - [ "$version" = unknown ]; }; then \ - echo "no version could be derived although the build context carries .git" >&2; \ - exit 1; \ +RUN VERSION="${VERSION:-$(git describe --tags --always)}"; \ + if [ -e .git ]; then \ + case "$VERSION" in ""|dev|unknown) \ + echo "version is '$VERSION' although .git is present" >&2; \ + exit 1 ;; \ + esac; \ fi; \ - make build VERSION="${version:-dev}" + make build VERSION="${VERSION:-dev}" -# Runtime stage -# alpine 3.23 (2026-03-10) +# Runtime stage, and the last one +# alpine 3.23, 2026-03-10 FROM alpine@sha256:25109184c71bdad752c8312a8623239686a9a2071e8825f20acb8f2198c3f659 RUN apk add --no-cache ca-certificates gnupg RUN adduser -D -s /bin/sh secret -COPY --from=builder /build/secret /usr/local/bin/secret +COPY --from=builder /src/secret /usr/local/bin/secret RUN chmod +x /usr/local/bin/secret USER secret diff --git a/Dockerfile.lint b/Dockerfile.lint deleted file mode 100644 index 0ce5e52..0000000 --- a/Dockerfile.lint +++ /dev/null @@ -1,29 +0,0 @@ -# Lint image, built by script/lint and script/lint-darwin: golangci-lint runs -# as a build step, so a successful build is a clean lint. Works where the -# docker daemon is remote and bind mounts are impossible. - -# golangci/golangci-lint:v2.12.2 (Debian-based), 2026-08-07 -FROM golangci/golangci-lint:v2.12.2@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240 AS deps - -WORKDIR /src - -COPY go.mod go.sum ./ -RUN go mod download - -# script/lint rebuilds this stage on every run, by this name; the module -# download above stays cached. -FROM deps AS lint - -COPY . . - -RUN golangci-lint run --config .golangci.yml ./... - -# script/lint-darwin rebuilds this stage on every run, by this name. It -# checks the code as a macOS build compiles it, but with cgo off, which -# leaves out the files that need cgo on macOS (see script/lint-darwin). -FROM deps AS lint-darwin - -COPY . . - -RUN GOOS=darwin CGO_ENABLED=0 go vet ./... -RUN GOOS=darwin CGO_ENABLED=0 golangci-lint run --config .golangci.yml ./... diff --git a/Makefile b/Makefile index ff671ce..854f187 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ export CGO_ENABLED=1 -.PHONY: default bootstrap setup build test lint lint-darwin fmt fmt-check \ - check docker docker-run clean install hooks +.PHONY: default bootstrap setup build test lint fmt fmt-check check docker \ + docker-run clean install hooks default: check @@ -21,13 +21,10 @@ test: fmt: @script/fmt +# Lints the Linux build, then type-checks and lints the macOS build lint: @script/lint -# Type-check and lint the macOS build from Linux (see script/lint-darwin) -lint-darwin: - @script/lint-darwin - check: @script/check diff --git a/README.md b/README.md index b6e549c..97af36b 100644 --- a/README.md +++ b/README.md @@ -604,31 +604,24 @@ provide: - `script/build` — build the `secret` binary into the repo root, stamping the version (`VERSION` from the environment, else `git describe`) and the git commit -- `script/test` — run `go vet`, then the test suite with the race detector, a - 30-second timeout per package and coverage, every test on every run, never a - result from Go's test cache; on failure it reruns the tests verbosely for the - details and fails even when the rerun passes -- `script/lint` — run `golangci-lint` in docker only: builds `Dockerfile.lint`, - where the linter is a build step that runs on every call, also on an unchanged - tree -- `script/lint-darwin` — run `go vet` and `golangci-lint` in docker on the code - as a macOS build compiles it (`GOOS=darwin`), which a Linux build never - compiles; cgo is off, so the keychain unlocker's calls into the keychain +- `script/test` — build the `test` phase of the `Dockerfile`, which runs the + test suite with the race detector, a 90-second timeout and coverage; on + failure it reruns the tests verbosely for the details and fails even when the + rerun passes +- `script/lint` — build the `lint` phase of the `Dockerfile`, which runs + `golangci-lint`, then `go vet` and `golangci-lint` on the code as a macOS + build compiles it (`GOOS=darwin`), which a Linux build never compiles; cgo is + off there, so the keychain unlocker's calls into the keychain (`internal/secret/keychainunlocker_cgo.go`, and `keychainunlocker_test.go`) and the Secure Enclave bindings (`internal/macse`) are not checked - `script/fmt` — format all Go code with `go fmt` and every markdown file with prettier (4-space tabs, `proseWrap: always`) (writes) -- `script/fmt-check` — check the same formatting without writing; the - `Dockerfile` lint stage runs it, so an unformatted Go or markdown file fails - the build -- `script/check` — run `script/test`, `script/lint`, `script/lint-darwin`, and - `script/fmt-check` -- `script/docker` — build the Docker image tagged with the project name -- `script/cibuild` — CI entrypoint: `docker build --ulimit memlock=-1:-1 .` - (memguard needs mlock; the Dockerfile runs the checks), with a new - `CHECK_EPOCH` build argument on every run so the checks run again on an - unchanged tree; the `Dockerfile` keeps Go's build cache between builds, so - `make test` and `make build` compile only what changed +- `script/fmt-check` — check the same formatting without writing, on the host +- `script/check` — run `script/test`, `script/lint` and `script/fmt-check` +- `script/docker` — build the Docker image tagged with the project name; the + build runs the `lint` and `test` phases first +- `script/cibuild` — CI entrypoint: runs `script/bootstrap`, `script/check`, + then builds the image as `script/docker` does - `script/precommit` — pre-commit checks: `go mod tidy` verification, then `script/check` - `script/install-precommit` — install the git pre-commit hook that runs diff --git a/REPO_POLICIES.md b/REPO_POLICIES.md index bc2f161..20382d1 100644 --- a/REPO_POLICIES.md +++ b/REPO_POLICIES.md @@ -1,6 +1,6 @@ --- title: Repository Policies -last_modified: 2026-07-06 +last_modified: 2026-10-04 --- This document covers repository structure, tooling, and workflow standards. Code @@ -60,17 +60,28 @@ style conventions are in separate documents: prerequisite since nvm requires bash. yarn is then pinned via `corepack prepare yarn@ --activate`. Never install "latest" or "lts"; always exact versions. `script/cibuild` runs the CI build: it changes to the - repo root and runs `docker build .`; the Gitea workflow calls it. Four further - scripts are our own extensions to the standard: `script/check` runs - `script/test`, `script/lint`, and `script/fmt-check`; `script/precommit` is - what the git pre-commit hook runs, and it calls `script/check`; - `script/install-precommit` installs the git pre-commit hook (the `make hooks` - target shims to it); and `script/projectname` (literally that filename) simply - outputs the project's name. Scripts that need the name call - `script/projectname` — e.g. `script/docker` assembles its image tag from it — - so those scripts stay byte-identical across all repos. Repo-type-specific - pre-commit extras (e.g. `go mod tidy` verification in Go repos) belong in - `script/precommit`, not in the hook itself. Model scripts are at + repo root, runs `script/bootstrap`, runs `script/check`, and builds the image + with the version; the Gitea workflow calls it. **`script/cibuild` runs + `script/bootstrap` first**, because the workflow checks out the repo and runs + nothing else, while `script/fmt-check` runs the formatter on the host: on a + pristine checkout with nothing installed the run dies there, after the + containerised gates have passed. **The bootstrap alone is not enough**: + `script/bootstrap` installs node and yarn under nvm and leaves neither on the + `PATH` of the shell that called it, so a bare `yarn` still exits 127. The host + entrypoints that need yarn — `script/fmt` and `script/fmt-check` — therefore + source nvm for the pinned node version before invoking it, exactly as + `script/bootstrap`'s own install step does. A runner carrying nothing but + docker and git then gets through `script/check`. Four further scripts are our + own extensions to the standard: `script/check` runs `script/test`, + `script/lint` and `script/fmt-check`; `script/precommit` is what the git + pre-commit hook runs, and it calls `script/check`; `script/install-precommit` + installs the git pre-commit hook (the `make hooks` target shims to it); and + `script/projectname` (literally that filename) simply outputs the project's + name. Scripts that need the name call `script/projectname` — e.g. + `script/docker` assembles its image tag from it — so those scripts stay + byte-identical across all repos. Repo-type-specific pre-commit extras (e.g. + `go mod tidy` verification in Go repos) belong in `script/precommit`, not in + the hook itself. Model scripts are at `https://git.eeqj.de/sneak/prompts/raw/branch/main/script/`. The README must document the provided scripts in an **Entrypoints** section (see the README requirements below). @@ -89,87 +100,198 @@ style conventions are in separate documents: contributor should be able to understand the entire development workflow by reading the Makefile. -- Every repo should have a `Dockerfile`. All Dockerfiles must run `make check` - as a build step so the build fails if the branch is not green. For non-server - repos, the Dockerfile should bring up a development environment and run - `make check`. For server repos, `make check` should run as an early build - stage before the final image is assembled. Dockerfiles install development - prerequisites by running `script/bootstrap` rather than duplicating installs - inline; COPY `script/` and the dependency manifests (`package.json` + - `yarn.lock`, `go.mod` + `go.sum`, etc.) before running it so the bootstrap - layer stays cached until dependencies change. +- Every repo should have a `Dockerfile`, and it carries the repo's gates: a + `lint` phase and a `test` phase, with the final stage depending on both so the + image cannot be built unless they pass. For non-server repos the final stage + brings up a development environment; for server repos it is the runtime image. + The gate phases and the build stage start from their pinned base images and + install what those images lack either inline, as the canonical Go `Dockerfile` + below does for `git`, or by running `script/bootstrap`, as the `prompts` + repo's own `Dockerfile` does for its yarn packages. The development + environment stage installs development prerequisites by running + `script/bootstrap` rather than duplicating its installs inline. A stage that + runs `script/bootstrap` COPYs `script/` and the dependency manifests + (`package.json` + `yarn.lock`, `go.mod` + `go.sum`, etc.) before running it. -- **Dockerfiles must use a separate lint stage for fail-fast feedback.** Go - repos use a multistage build where linting runs in an independent stage based - on the `golangci/golangci-lint` image (pinned by hash). This stage runs - `make fmt-check` and `make lint` before the full build begins. The build stage - then declares an explicit dependency on the lint stage via - `COPY --from=lint /src/go.sum /dev/null`, which forces BuildKit to complete - linting before proceeding to compilation and tests. This ensures lint failures - surface in seconds rather than minutes, without blocking on dependency - download or compilation in the build stage. +- **Linting and testing run in Docker, as phases of the `Dockerfile`.** There is + no separate lint file. `script/lint` and `script/test` each build one phase + and nothing else: - The standard pattern for a Go repo Dockerfile is: + ```sh + docker build --no-cache --target lint -t "$(script/projectname)-lint" . + docker build --no-cache --target test -t "$(script/projectname)-test" . + ``` + + **A stage that is not the last one in the file is built only when the final + stage's chain depends on it, or when `--target` names it.** That is why the + two gates are always invoked by name here, and why the final stage carries a + `COPY --from=` of a harmless file from each of them: without that edge a + plain `docker build .` builds the last stage alone and exits 0 having linted + and tested nothing. + + **Every `docker build` in `script/` is tagged**, here and in + `script/cibuild` and `script/docker`. An untagged build leaves a dangling + image behind on every invocation, on every developer host and every CI + runner; a tagged one replaces the previous image. + + Inside a phase the tool is invoked directly — `golangci-lint`, `go test`, + `eslint`, `prettier` — never through `make lint` or `script/test`, which are + themselves a `docker build` and would recurse into a daemon that does not + exist in a build step. Formatting is the exception and stays on the host: + `script/fmt` writes the working tree, and `script/fmt-check` is its + read-only twin. + + **No lint verdict may come from a host invocation of the linter.** On a + shared host golangci-lint reads a result cache keyed on file content rather + than location, so a second checkout of the same content is served the first + one's findings, and a host-global lock in `$TMPDIR` makes concurrent runs + exit non-zero with `parallel golangci-lint is running` — a status a caller + cannot tell from real findings. Both have produced wrong verdicts in this + org, in both directions. A container has its own cache, its own `TMPDIR` and + a digest-pinned binary, so neither is reachable. + +- **Any build that runs checks is built with `--no-cache`.** Docker invalidates + a `COPY` layer only when the copied content changes, so on an unchanged tree + the check `RUN` is served from cache, nothing executes, and the build still + exits 0. Every `docker build` in `script/` therefore passes `--no-cache`: + `script/lint`, `script/test`, `script/cibuild` and `script/docker` are the + four, and there is no fifth — `script/check` runs the two gate phases and + `script/fmt-check`, and builds no image of its own. A bare `docker build .` is + not evidence that anything ran: a sub-second build reporting success is a + cache hit, not a result. Never invalidate by pruning — `docker builder prune` + and friends destroy a build cache shared with every other build on the host. + When a check is added or changed, prove it works by planting a defect it must + catch and watching the run fail on it, then revert the defect. A green run + alone shows neither that the check ran nor that it covers what it should. + +- **The gate phases are separate stages, and the build stage depends on both.** + The lint phase is based on the `golangci/golangci-lint` image (pinned by + hash), so lint failures surface in seconds rather than after a full compile, + and the test phase is based on the Debian Go image. The canonical Go repo + `Dockerfile`: ```dockerfile - # Lint stage — fast feedback on formatting and lint issues + # Lint phase # golangci/golangci-lint:v2.x.x, YYYY-MM-DD FROM golangci/golangci-lint@sha256:... AS lint WORKDIR /src COPY go.mod go.sum ./ RUN go mod download COPY . . - RUN make fmt-check - RUN make lint + RUN golangci-lint run --config .golangci.yml ./... - # Build stage - # golang:1.x-alpine, YYYY-MM-DD - FROM golang@sha256:... AS builder + # Test phase. -race needs cgo and so a C compiler, which the Debian Go + # image ships and the alpine one does not. + # golang:1.x, YYYY-MM-DD + FROM golang@sha256:... AS test WORKDIR /src - - # Force BuildKit to run the lint stage before proceeding - COPY --from=lint /src/go.sum /dev/null - COPY go.mod go.sum ./ RUN go mod download COPY . . - RUN make test + RUN go test -timeout 90s -race -cover ./... || \ + { echo "--- Rerunning with -v for details ---"; \ + go test -timeout 90s -race -v ./...; exit 1; } - ARG VERSION=dev - RUN CGO_ENABLED=0 go build -trimpath \ - -ldflags="-s -w -X main.Version=${VERSION}" \ - -o /app ./cmd/app/ + # Build stage. Nothing is wanted from either phase above; the copies + # are what make BuildKit build them first, so this stage cannot run + # unless lint and test passed. + # golang:1.x-alpine, YYYY-MM-DD + FROM golang@sha256:... AS builder + COPY --from=lint /src/go.sum /dev/null + COPY --from=test /src/go.sum /dev/null + RUN apk add --no-cache git + # A tar-stream context keeps the sender's file owners, which git refuses. + RUN git config --system --add safe.directory /src + WORKDIR /src + COPY go.mod go.sum ./ + RUN go mod download + COPY . . - # Runtime stage + # The VERSION build arg when one is given, otherwise + # `git describe --tags --always` on the .git in the build context. With + # .git present, a version that is still empty, dev or unknown fails the + # build: git is missing or could not read the checkout. + ARG VERSION + RUN VERSION="${VERSION:-$(git describe --tags --always)}"; \ + if [ -e .git ]; then \ + case "$VERSION" in ""|dev|unknown) \ + echo "version is '$VERSION' although .git is present" >&2; \ + exit 1 ;; \ + esac; \ + fi; \ + CGO_ENABLED=0 go build -trimpath \ + -ldflags="-s -w -X main.Version=${VERSION}" \ + -o /app ./cmd/app/ + + # Runtime stage, and the last one FROM alpine@sha256:... COPY --from=builder /app /usr/local/bin/app ENTRYPOINT ["app"] ``` Key points: - - The lint stage uses the `golangci/golangci-lint` image directly (it - includes both Go and the linter), so there is no need to install the - linter separately. - - `COPY --from=lint /src/go.sum /dev/null` is a no-op file copy that creates - a stage dependency. BuildKit runs stages in parallel by default; without - this line, the build stage would not wait for lint to finish and a lint - failure might not fail the overall build. + - The lint phase uses the `golangci/golangci-lint` image directly (it has + both Go and the linter), so nothing needs installing. + - `COPY --from= /src/go.sum /dev/null` is a no-op copy whose only + purpose is the ordering edge. BuildKit runs stages in parallel by default, + and a stage nothing depends on is not built at all, so without these two + lines a red gate would not fail the build. + - Keep the runtime stage last, and if you add a stage after it, give it the + same two copies. A plain `docker build .` builds the last stage's chain + and nothing else. - If the project uses `//go:embed` directives that reference build artifacts - (e.g. a web frontend compiled in a separate stage), the lint stage must + (e.g. a web frontend compiled in a separate stage), the lint phase must create placeholder files so the embed directives resolve. Example: `RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css`. - The lint stage should not depend on the actual build output — it exists to - fail fast. - - If the project requires CGO or system libraries for linting (e.g. - `vips-dev`), install them in the lint stage with `apk add`. - - The build stage runs `make test` after compilation setup. Tests run in the - build stage, not the lint stage, because they may require compiled - artifacts or heavier dependencies. + - If the project requires CGO or system libraries for linting, install them + in the lint phase. The `golangci/golangci-lint` image is Debian-based and + has no `apk`, so install with `apt-get` under the Debian package name + (`libvips-dev`, where alpine says `vips-dev`), and delete the package + lists in the same `RUN`, so the layer does not keep them: + + ```dockerfile + RUN apt-get update \ + && apt-get install -y --no-install-recommends libvips-dev \ + && rm -rf /var/lib/apt/lists/* + ``` + + - `.dockerignore` lets `.git` into the build context. It keeps out every git + `config` at any depth (`**/.git/config`, `**/.git/modules/**/config`): the + repository's own, each submodule's under `.git/modules/`, and that of a + submodule keeping its own `.git` directory. `git describe` does not need + them, and each can hold a credential: a password in a remote URL, or the + token the CI checkout step stores there. A submodule whose name has a + `config` segment (`config`, `deploy/config`, `config/lib`) loses its whole + git directory to `**/.git/modules/**/config`, and Go's version stamping + then fails the build: give it a name without that segment + (`git submodule add --name`). The stage that compiles has `git` (the + Debian Go image has it; an alpine one needs `apk add --no-cache git`) and + takes the version from the `VERSION` build argument when one is given, + otherwise from `git describe --tags --always`. That gives the tag on a + tagged commit; on a later commit, the tag, the number of commits since it + and the short commit (`v1.2.3-4-gabc1234`); and the short commit when no + tag is reachable. The stage that compiles also marks its working directory + safe for git (`git config --system --add safe.directory /src`): a context + sent as a tar stream keeps the sender's file owners, and git refuses a + checkout owned by another user, so the version would come out empty. + `ARG VERSION` has no default, and the build fails if the context carries + `.git` and the version still comes out empty, `dev` or `unknown`. A plain + `docker build .` with no build arguments must succeed; a Dockerfile that + refuses an empty build argument drops that refusal and keeps the argument. - Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that - runs `script/cibuild` (which runs `docker build .`) on push. Since the - Dockerfile already runs `make check`, a successful build implies all checks - pass. + runs `script/cibuild` on push, and checks out the repo as its only other step. + That script bootstraps, runs the gate phases, and then builds the image, so a + successful run means every check passed; a bare `docker build .` does not + carry the same guarantee, because its gate phases may come from the cache. The + image build is uncached and so runs the gate phases a second time. That is the + price of the rule above, and it is worth paying: the image that ships is built + from a run of its own gates rather than from a cache entry. A separate + workflow limited to `main` by a `branches` list under `on: push` cannot be + checked by review: to try a change to it, add the feature branch to that list + and push, then remove the branch from the list again before merging. Keep any + job in it that publishes behind `if: github.ref_name == 'main'`, so the run + from the feature branch publishes nothing. - Use platform-standard formatters: `black` for Python, `prettier` for JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with @@ -189,14 +311,21 @@ style conventions are in separate documents: module under test to verify it compiles/parses. There is no excuse for `make test` to be a no-op. -- `make test` must complete in under 20 seconds. Add a 30-second timeout in the - Makefile. +- `make test` must complete in under 60 seconds. That is the hard cap, and a + suite that exceeds it fails. Under 20 seconds is the target. A suite between + 20 and 60 seconds is still green, but the overage must be filed as an + improvement bug against that repo. Add a 90-second timeout to the test + invocation (`go test -timeout 90s`). The backstop deliberately sits above the + hard cap so that it catches a genuinely hung test rather than a merely slow + one. -- **`make test` should use the conditional verbose rerun pattern.** Run tests - without `-v` (verbose) first. If tests fail, automatically rerun with `-v` to - show full output. This keeps CI logs and `docker build` output clean on - success (just package/suite summaries) while providing full diagnostic detail - on failure (every test case, every assertion). The general shell pattern: +- **The test command should use the conditional verbose rerun pattern.** Run + tests without `-v` (verbose) first. If tests fail, automatically rerun with + `-v` to show full output. This keeps CI logs and `docker build` output clean + on success (just package/suite summaries) while providing full diagnostic + detail on failure (every test case, every assertion). The command lives in the + `test` phase of the `Dockerfile`, since `script/test` builds that phase; the + Makefile form below is the same pattern for any repo-local invocation: ```makefile test: @@ -209,11 +338,26 @@ style conventions are in separate documents: ```makefile test: - @go test -timeout 30s -race -cover ./... || \ + @go test -count=1 -timeout 90s -race -cover ./... || \ { echo "--- Rerunning with -v for details ---"; \ - go test -timeout 30s -race -v ./...; exit 1; } + go test -count=1 -timeout 90s -race -v ./...; exit 1; } ``` + `-count=1` is required on both invocations: it defeats Go's test _result_ + cache, so neither run can report a stored pass in place of running the + tests. It leaves the build cache alone, so it costs the runtime of the suite + and no recompilation. + + That cache is Go's own, separate from Docker's layer cache. Go stores a + passing result in its cache directory (`GOCACHE`), and when the same tests + run again on unchanged code it prints that result, marked `(cached)`, + without running them. That matters on a developer's machine, where this + target runs and the directory lasts from one run to the next. The `test` + phase of the `Dockerfile` needs no `-count=1`: its base image holds no + result for this repo's tests and nothing before its `go test` step runs a + test, so there is nothing to replay. `--no-cache` (above) is what makes that + step run on an unchanged tree. + Python example: ```makefile @@ -239,10 +383,84 @@ style conventions are in separate documents: must be in `.gitignore`. No exceptions. - `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`), - editor files (`.swp`, `*~`), language build artifacts, and `node_modules/`. - Fetch the standard `.gitignore` from - `https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when setting up - a new repo. + editor files (`.swp`, `*~`), in-repo agent scratch directories (`.claude/`), + language build artifacts, and `node_modules/`. Fetch the standard `.gitignore` + from `https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when + setting up a new repo. These patterns are written to `.gitignore`'s own + semantics, in which an unanchored pattern already matches at every depth; they + are not a `.dockerignore` and must not be transplanted into one unmodified. + +- **`.dockerignore` does not use `.gitignore` semantics, and copying patterns + across unmodified leaves secrets in the build context.** Docker matches with + `moby/patternmatcher`: `filepath.Match` semantics plus a `**` extension, so + `*` does not cross `/` and a pattern without a leading `**/` is anchored at + the build-context root. A `.dockerignore` listing `.env`, `*.pem` and `*.key` + therefore excludes only the copies at the repository root, while `config/.env` + and `certs/server.key` still reach the context and can land in an image layer + — which is more dangerous than a short file with no secret patterns at all, + because it reads as solved and stops anyone looking. Give every + depth-independent pattern the `**/` prefix and leave only genuinely + root-anchored entries unprefixed: `.claude`, and the repo's own host-built + binary, written `/myapp` and never `**/myapp`, which would also match + `cmd/myapp/` and delete the package directory from the context. Matching is + case-sensitive, and an ALL-CAPS twin per pattern still misses `Server.Key`, so + secret names use character ranges — `**/*.[kK][eE][yY]`, `**/*.[pP][eE][mM]`, + and likewise for `.envrc` and the extensionless SSH keys. Where such a pattern + also catches something the build needs, re-include it with a negation + (`!docs/example.env`); deleting the pattern reopens the exposure for every + other file it covers. Fetch the standard `.dockerignore` from + `https://git.eeqj.de/sneak/prompts/raw/branch/main/.dockerignore` and extend + it with the repo's own artifacts. + +- **In-repo agent scratch belongs in both files, written to each file's own + semantics.** `.claude/` holds one worktree per in-flight agent — an entire + additional checkout of the repo — so under `COPY . .` the build context + inflates by a multiple of the repo and another session's unreviewed work can + be copied into an image layer. In `.gitignore` the entry is `.claude/`, + unanchored. In `.dockerignore` it is `.claude`, anchored and with **no** `**/` + prefix, because the prefixed form would also delete any nested directory of + that name from the build. Anchoring carries a known gap that the canonical + `.dockerignore` states in its own comment, since consuming repos receive the + file and not the tracker: the directory is created in the agent's working + directory, so a repo running agents in subdirectories still ships + `services/api/.claude/` and must add its own anchored entry there. + +- **A plain `docker build .` of a clone stamps the version that + `git describe --tags --always` gives**, derived from the `.git` in the build + context as the canonical `Dockerfile` above shows. Without its failure check, + a missing `git` or an unreadable checkout would leave `-X main.Version=` empty + and the build would still exit 0. `script/docker` and `script/cibuild` pass + the version they compute on the host; it takes precedence. They do this + byte-identically across repos: + + ```sh + # Own line: a failing command substitution inside an argument does not + # trip `set -e`, so the inline form degrades to an empty constant. + version="$(git describe --tags --always --dirty 2>/dev/null || true)" + [ -n "$version" ] || version="unknown" + docker build --no-cache \ + --build-arg VERSION="$version" \ + -t "$(script/projectname)" . + ``` + + `--always` makes an untagged repo yield an abbreviated commit hash rather + than failing, and the `[ -n "$version" ]` line is the single place the + fallback is applied — a live check that fires on a build from an export with + no `.git` and on a repository with no commits yet. Do not fold it into the + substitution as `|| echo unknown`, which makes the guard unreachable. The + Dockerfile's side is `ARG VERSION` in the stage that compiles, declared + there because `ARG` is stage-scoped; passing `VERSION` to a repo whose + Dockerfile declares no such `ARG` is ignored and costs nothing, which is why + the scripts stay byte-identical. One consequence for CI: the standard + checkout action clones shallow and fetches no tags, so a repo that embeds a + tag-derived version must set `fetch-depth: 0` on its checkout step. + +- **Verify `.dockerignore` by enumerating the image, not by reading the + patterns.** Plant files at the root _and_ at least two directories deep, build + a probe image that does `COPY . .`, and list what actually landed + (`docker run --rm --entrypoint find IMAGE /app`). The `transferring context` + size is not a substitute: a nested secret is a few bytes, and BuildKit + transfers only the delta from the previous build. - **No build artifacts in version control.** Code-derived data (compiled bundles, minified output, generated assets) must never be committed to the @@ -258,9 +476,56 @@ style conventions are in separate documents: - Make all changes on a feature branch. You can do whatever you want on a feature branch. -- `.golangci.yml` is standardized and must _NEVER_ be modified by an agent, only - manually by the user. Fetch from - `https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml`. +- `.golangci.yml` is standardized. The vendored copy in a consuming repo must + _NEVER_ be modified by an agent: fetch it from + `https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml` and keep it + byte-identical, so that no repo can quietly loosen its own linting. Linter + configuration changes are made to the canonical copy in the `prompts` repo and + reach consuming repos by re-vendoring; an agent may open a PR against + canonical, which only the user merges. One list is exempt from byte-identity, + because it cannot be written once for every repo: the `deny` list of the + `test-support` depguard rule, where a repo names its own test-support packages + by full import path. A repo adds entries there and changes nothing else, and a + re-vendor carries its entries forward. The canonical golangci-lint version is + v2.14.0 (released 2026-09-24), pinned as the digest of the lint phase's base + image + (`golangci/golangci-lint@sha256:ad862ba6b3798cbe0fd9fd7408d498fd74fbd2623a92406b2fd3898faf0bf98f`, + which reports `2.14.0 built with go1.27.0 from 114493f9`). A module's `go` + directive must not name a newer Go minor version than the one golangci-lint + was built with, or golangci-lint refuses to lint it: this release lints + `go 1.27.1` but not `go 1.28`. That digest is the only pin, since no repo + installs golangci-lint on the host. A repo sets the lint phase digest to the + one named here and re-vendors `.golangci.yml` in the same commit, whichever of + the two prompted the change: the canonical copy can name linters that an older + golangci-lint rejects, and a newer golangci-lint can add linters that + `default: all` switches on until the canonical copy disables them. + +- **`script/bootstrap` installs a pinned tool by comparing versions, never by + testing presence.** An `if ! command -v ; then install; fi` guard tests + `PATH` only, so on an already-provisioned machine the pin is inert and a + version bump is a silent no-op — while the Dockerfile, installing into a clean + image, gets the pinned version, so a local `make check` and `make docker` can + disagree about what the tool even is. The canonical form: + - compares the installed version against the pin over the **whole** version + token; a parser that stops at the first `-` reports `2.12.2` for a host + running `2.12.2-rc1` and skips the install; + - treats absent, non-zero, empty or unrecognised `--version` output as a + mismatch, so the failure direction is a redundant install and never a + skipped one; + - after installing, re-resolves the binary the way callers do — `hash -r`, + then through `PATH`, not through the directory the installer wrote to — + and fails naming the resolved path, since an install that a shadowing + binary hides succeeds while changing nothing any caller sees; + - is actually called, and prints the version on both success paths: a + function defined and never invoked has the same exit status and the same + empty output as one that worked. + + Keep it POSIX sh: no arrays, no `[[`, no `grep -P`. + + A Go tool a repo needs on the host is installed with `go install` pinned to + a commit hash (`go install @`). It is never tracked as + a `go.mod` tool dependency or through a `tools.go` file, either of which + pulls the tool's own dependencies into the repo's `go.mod` and `go.sum`. - When pinning images or packages by hash, add a comment above the reference with the version and date (YYYY-MM-DD). @@ -374,12 +639,14 @@ style conventions are in separate documents: settings. - Avoid putting files in the repo root unless necessary. Root should contain - only project-level config files (`README.md`, `Makefile`, `Dockerfile`, - `LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`, and - language-specific config). Everything else goes in a subdirectory. Canonical - subdirectory names: + only project-level config files (`README.md`, `AGENTS.md`, `Makefile`, + `Dockerfile`, `LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`, + and language-specific config). Everything else goes in a subdirectory. + Canonical subdirectory names: - `bin/` — executable scripts and tools - - `cmd/` — Go command entrypoints + - `cmd/` — Go command entrypoints; thin only: one `main.go` per binary whose + body is a single call into `internal/` or `pkg/`, no project logic in + `cmd/` - `configs/` — configuration templates and examples - `deploy/` — deployment manifests (k8s, compose, terraform) - `docs/` — documentation and markdown (README.md stays in root) @@ -406,3 +673,7 @@ style conventions are in separate documents: - Go: `go.mod`, `go.sum`, `.golangci.yml` - JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore` - Python: `pyproject.toml` + +- Guidance for coding agents lives in one `AGENTS.md` at the repository root. It + is never committed under a file or directory named after one agent tool, such + as `CLAUDE.md` or `.claude/`, and never split into separate memory files. diff --git a/TODO.md b/TODO.md index fb587e5..c4acd38 100644 --- a/TODO.md +++ b/TODO.md @@ -18,6 +18,17 @@ https://git.eeqj.de/sneak/secret/milestone/12 # Completed Steps +- 2026-10-07: The canonical files are re-vendored from `sneak/prompts` commit + `dd4027b` (https://git.eeqj.de/sneak/secret/issues/121), with golangci-lint + v2.14.0 in the lint phase. Lint and test are phases of the `Dockerfile`, and + `script/lint` and `script/test` each build one with `--no-cache`; + `Dockerfile.lint` and `script/lint-darwin` are gone, and the lint phase also + checks the macOS build. The tests run on the Debian Go image with cgo and the + race detector. `script/cibuild` bootstraps, runs `script/check` and builds the + image; `CHECK_EPOCH` and the memlock ulimit are gone. `--no-cache` starts Go's + build cache mount empty, so `make test` compiles everything on every run. The + rules in `CLAUDE.md` that `AGENTS.md` lacked are in `AGENTS.md`, and + `CLAUDE.md` is deleted. - 2026-10-06: `script/test` runs the tests with the race detector, a 30-second timeout per package and coverage, as `REPO_POLICIES.md` requires (https://git.eeqj.de/sneak/secret/issues/32). When they fail, it reruns them diff --git a/script/check b/script/check index 1150ff0..92875f7 100755 --- a/script/check +++ b/script/check @@ -1,6 +1,8 @@ #!/bin/sh -# script/check: run all checks (test, lint, lint-darwin, fmt-check). Our -# own extension to scripts-to-rule-them-all. Must not modify any files. +# script/check: run all checks (test, lint, fmt-check). Our own +# extension to scripts-to-rule-them-all. test and lint are Docker +# phases; fmt-check is native, because a formatter writes the working +# tree. Must not modify any files. set -eu SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)" @@ -8,7 +10,6 @@ SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)" main() { "$SCRIPT_DIR/test" "$SCRIPT_DIR/lint" - "$SCRIPT_DIR/lint-darwin" "$SCRIPT_DIR/fmt-check" } diff --git a/script/cibuild b/script/cibuild index feaf540..d8d3200 100755 --- a/script/cibuild +++ b/script/cibuild @@ -1,21 +1,28 @@ #!/bin/sh -# script/cibuild: run the CI build. The Dockerfile runs script/check -# (via make check), so a successful build implies all checks pass. -# The Gitea workflow runs this on push. The memlock ulimit lifts the limit -# on memory the tests lock (memguard mlocks secrets); they also pass under -# the lower limit of a plain `docker build .`. -# A cached build checks nothing: a new CHECK_EPOCH on every run makes the -# Dockerfile's check steps run again on an unchanged tree, while its base -# images, module downloads and the Go build cache that make test and make -# build use stay cached. +# script/cibuild: run the CI build. It bootstraps first: a CI runner +# checks out and runs this and nothing else, and script/fmt-check runs +# the formatter on the host, which a pristine checkout cannot do. +# --no-cache for the same reason as script/docker: the gate phases the +# final stage depends on are RUN steps, and a cached one is a check that +# did not run. set -eu -ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)" +ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)" main() { cd "$ROOT" - docker build --ulimit memlock=-1:-1 \ - --build-arg CHECK_EPOCH="$(date +%s)" . + "$SCRIPT_DIR/bootstrap" + "$SCRIPT_DIR/check" + # Own line: a failing command substitution inside an argument does + # not trip `set -e`, so the inline form degrades silently to an + # empty constant. The VERSION build argument takes precedence over + # the version a build stage derives from the .git in the context. + version="$(git describe --tags --always --dirty 2>/dev/null || true)" + [ -n "$version" ] || version="unknown" + docker build --no-cache \ + --build-arg VERSION="$version" \ + -t "$("$SCRIPT_DIR/projectname")" . } main "$@" diff --git a/script/lint b/script/lint index 75e2e15..2d8b075 100755 --- a/script/lint +++ b/script/lint @@ -1,24 +1,23 @@ #!/bin/sh -# script/lint: run the linter, in docker only. Builds Dockerfile.lint, -# where golangci-lint runs as a build step. +# script/lint: run the linter. Linting is a phase of the Dockerfile and +# this builds that phase alone; the linter is never installed or run on +# a developer host, where a shared result cache and a host-global lock +# make its answer untrustworthy. # -# A cached build lints nothing, so --no-cache-filter rebuilds the lint -# stage on every run, an unchanged tree included. It ignores a stage name -# that does not exist, so --target names the same stage: a rename then -# fails the build instead of serving the lint from cache. cacheonly keeps -# no image; only the build's success matters. +# The phase is not the last stage in the file, so it is built only when +# --target names it. --no-cache because a cached lint layer is a lint +# that did not run. The tag makes each build replace the previous image +# instead of leaving a dangling one behind. set -eu -ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)" +ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)" main() { cd "$ROOT" - docker build \ - --progress=plain \ + docker build --no-cache \ --target lint \ - --no-cache-filter=lint \ - --output=type=cacheonly \ - -f Dockerfile.lint . + -t "$("$SCRIPT_DIR/projectname")-lint" . } main "$@" diff --git a/script/lint-darwin b/script/lint-darwin deleted file mode 100755 index 01cc83d..0000000 --- a/script/lint-darwin +++ /dev/null @@ -1,26 +0,0 @@ -#!/bin/sh -# script/lint-darwin: type-check (go vet) and lint the code as a macOS -# build compiles it, from Linux, in docker only. CI runs on Linux, which -# never compiles the files built only for macOS. Builds the lint-darwin -# stage of Dockerfile.lint, rebuilt on every run as script/lint does. -# -# Cgo is off: compiling cgo code for macOS needs Apple's SDK headers. That -# leaves out the files built only with cgo on macOS: the keychain unlocker's -# calls into the keychain (keychainunlocker_cgo.go, and -# keychainunlocker_test.go) and the Secure Enclave bindings (internal/macse). -# Nothing on Linux checks those. -set -eu - -ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" - -main() { - cd "$ROOT" - docker build \ - --progress=plain \ - --target lint-darwin \ - --no-cache-filter=lint-darwin \ - --output=type=cacheonly \ - -f Dockerfile.lint . -} - -main "$@" diff --git a/script/test b/script/test index f2a4ff4..cd239f2 100755 --- a/script/test +++ b/script/test @@ -1,22 +1,19 @@ #!/bin/sh -# script/test: run the test suite (vet first, then the tests with the race -# detector; a verbose rerun on failure). +# script/test: run the test suite. Testing is a phase of the Dockerfile +# and this builds that phase alone, on the same terms as script/lint: +# --target because a phase that is not the last stage is built only when +# named, --no-cache because a cached test layer is a test that did not +# run, and a tag so each build replaces the previous image. set -eu -ROOT="$(cd "$(dirname "$0")/.." && pwd -P)" +SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)" +ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)" main() { cd "$ROOT" - # CGO is required (Makefile exports this too) - export CGO_ENABLED=1 - go vet ./... - # -count=1: run every test, never take a result from Go's test cache, - # which the Dockerfile keeps between builds. The rerun only prints - # details: `exit 1` keeps the script failing even if a flaky test - # passes on the second attempt. - go test -count=1 -timeout 30s -race -cover ./... || \ - { echo "--- Rerunning with -v for details ---"; \ - go test -count=1 -timeout 30s -race -v ./...; exit 1; } + docker build --no-cache \ + --target test \ + -t "$("$SCRIPT_DIR/projectname")-test" . } main "$@"