Compare commits
21
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b0215433a0 | ||
|
|
5805909fb9 | ||
|
|
3c1b435990 | ||
|
|
5de98c404e | ||
|
|
dcc0ba0b66 | ||
|
|
343628fb3a | ||
|
|
7ea5cdcdcd | ||
|
|
507a57e813 | ||
|
|
2ae9391b26 | ||
|
|
ed5ed236b1 | ||
|
|
6c489067ce | ||
|
|
c4d5546e86 | ||
|
|
7b55c444ae | ||
|
|
c3a504f647 | ||
|
|
85bea7681e | ||
|
|
58f75147be | ||
|
|
58eafaf4c2 | ||
|
|
fbec5a523b | ||
|
|
f77d785bed | ||
|
|
3f8201d532 | ||
|
|
a8686891ba |
+30
-64
@@ -1,75 +1,42 @@
|
|||||||
# Docker matches this file with moby/patternmatcher: Go filepath.Match
|
# .dockerignore does NOT use .gitignore semantics. Docker matches with
|
||||||
# semantics plus a `**` extension, compiled to a regexp. Plain
|
# moby/patternmatcher: filepath.Match plus `**`, so `*` does not cross
|
||||||
# filepath.Match has no `**` at all. What follows from that: `*` does not
|
# `/` and an unprefixed pattern is anchored at the context root. Every
|
||||||
# cross `/`, and a pattern without a leading `**/` is anchored at the
|
# depth-independent pattern therefore needs `**/`, or `config/.env` and
|
||||||
# build-context root. Every depth-independent pattern therefore needs the
|
# `certs/server.key` still ship while this file reads as solved. Only
|
||||||
# `**/` prefix — without it `config/.env` and `certs/server.key` still
|
# genuinely root-anchored entries go unprefixed. Never transplant these
|
||||||
# ship while the file reads as solved.
|
# into .gitignore, where `**/` is wrong.
|
||||||
#
|
#
|
||||||
# Root-anchored entries are for paths that occur exactly once, at the
|
# Matching is case-sensitive, so secrets use character ranges rather
|
||||||
# context root. A host-built binary is the usual case, and it must be
|
# than an ALL-CAPS twin, which would still miss `Server.Key`.
|
||||||
# written anchored: `/myapp`, never `**/myapp`. The prefixed form also
|
|
||||||
# matches `cmd/myapp/`, which deletes the package directory from the
|
|
||||||
# context. In-repo agent scratch is the other case, for the same reason
|
|
||||||
# — with the caveat recorded at that entry: anchoring is exact only
|
|
||||||
# where agents run at the repo root, and a repo where they do not must
|
|
||||||
# add its own entries.
|
|
||||||
#
|
#
|
||||||
# Matching is case-sensitive, so `**/*.key` does not match
|
# Extend with this repo's own host-built artifacts, written anchored:
|
||||||
# `certs/SERVER.KEY`, which is reachable on the case-insensitive
|
# `/myapp`, never `**/myapp`, which also matches `cmd/myapp/` and
|
||||||
# filesystems most laptops use. Adding an ALL-CAPS twin per pattern is
|
# deletes the package directory from the context.
|
||||||
# not the fix: it still misses `Server.Key` while reading as though case
|
|
||||||
# were handled. Character ranges cover every spelling in one line, so
|
|
||||||
# every secret name below is written that way — including the
|
|
||||||
# extensionless SSH keys and `.envrc`, because on those same
|
|
||||||
# case-insensitive filesystems direnv reads `.ENVRC` and ssh reads
|
|
||||||
# `ID_RSA`.
|
|
||||||
#
|
|
||||||
# `**/*.[eE][nN][vV]` also excludes a committed env template such as
|
|
||||||
# `example.env`. If the build genuinely needs one, re-include it with a
|
|
||||||
# negation after the pattern: `!docs/example.env`.
|
|
||||||
#
|
|
||||||
# Extend this file with the repo's own host-built artifacts (compiled
|
|
||||||
# binaries, test binaries, coverage output); those are per-repo and
|
|
||||||
# belong here because a host build otherwise drops them into the
|
|
||||||
# context.
|
|
||||||
|
|
||||||
# Repository metadata: exactly one, at the context root. Excluding it
|
# .git is sent without its config. Without a VERSION build argument the
|
||||||
# means `git describe` cannot run in any build stage, and it fails
|
# stage that compiles runs `git describe --tags --always` on .git, which
|
||||||
# quietly there rather than erroring, so a version embedded that way
|
# does not need .git/config; that file can hold a credential, such as a
|
||||||
# comes out empty. Compute the version on the host and pass it in with
|
# password in a remote URL or the token the CI checkout step stores there.
|
||||||
# `--build-arg VERSION=...`; see the version rule in REPO_POLICIES.md.
|
# Each submodule keeps a config with the same exposure in its git directory
|
||||||
.git
|
# under .git/modules/, nested again for a submodule's own submodules.
|
||||||
|
.git/config
|
||||||
|
.git/modules/**/config
|
||||||
|
|
||||||
# In-repo agent scratch: a directory holding a full additional checkout
|
# Agent scratch: one full checkout of the repo per in-flight agent.
|
||||||
# of the repo for each in-flight agent. Anchored because it occurs
|
# Anchored because it occurs once where agents run at the repo root.
|
||||||
# exactly once *where agents run at the repo root*, which is the
|
# KNOWN GAP: a repo running agents in subdirectories still ships
|
||||||
# convention this file assumes; the `**/` form would also match any
|
# `services/api/.claude/` and must add its own anchored entry.
|
||||||
# nested directory of that name and delete it from the build.
|
|
||||||
#
|
|
||||||
# KNOWN GAP, and it is not hypothetical: the directory is created in the
|
|
||||||
# agent's working directory. If agents in this repo run in
|
|
||||||
# subdirectories — a monorepo with a per-service agent, say — then
|
|
||||||
# `services/api/.claude/` is NOT excluded by the line below and still
|
|
||||||
# reaches the build context and the image, which is the exposure this
|
|
||||||
# entry exists to close. A repo in that shape adds its own anchored
|
|
||||||
# entries (`/services/api/.claude`), or `**/.claude` after confirming no
|
|
||||||
# legitimately named nested directory would be caught.
|
|
||||||
#
|
|
||||||
# Not case-folded, unlike the secret patterns below: tooling creates
|
|
||||||
# this directory in exactly one spelling, so a folded pattern would add
|
|
||||||
# no coverage.
|
|
||||||
.claude
|
.claude
|
||||||
|
|
||||||
# Environment files. `*.env` covers both the bare `.env` name (`*` matches
|
# Environment files. `*.env` covers bare `.env` and the `prod.env`
|
||||||
# the empty string) and the `prod.env` convention.
|
# 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].*
|
**/.[eE][nN][vV].*
|
||||||
**/.[eE][nN][vV][rR][cC]
|
**/.[eE][nN][vV][rR][cC]
|
||||||
|
|
||||||
# Private keys and the bundles that carry them. Public certificates
|
# Private keys and the bundles carrying them. Public certificates
|
||||||
# (*.crt, *.cer) are deliberately absent: they are not secrets and are
|
# (*.crt, *.cer) are deliberately absent: they are legitimate inputs.
|
||||||
# sometimes a legitimate build input.
|
|
||||||
**/*.[pP][eE][mM]
|
**/*.[pP][eE][mM]
|
||||||
**/*.[kK][eE][yY]
|
**/*.[kK][eE][yY]
|
||||||
**/*.[pP]12
|
**/*.[pP]12
|
||||||
@@ -86,8 +53,7 @@
|
|||||||
**/.DS_Store
|
**/.DS_Store
|
||||||
**/Thumbs.db
|
**/Thumbs.db
|
||||||
|
|
||||||
# Editor state. Never a build input, and it churns under a developer's
|
# Editor state: never a build input, and it churns COPY.
|
||||||
# hands, so it invalidates COPY for reasons unrelated to the source.
|
|
||||||
**/*.swp
|
**/*.swp
|
||||||
**/*.swo
|
**/*.swo
|
||||||
**/*~
|
**/*~
|
||||||
|
|||||||
+23
-5
@@ -20,8 +20,26 @@ Thumbs.db
|
|||||||
# Node
|
# Node
|
||||||
node_modules/
|
node_modules/
|
||||||
|
|
||||||
# Environment / secrets
|
# Secrets. Unanchored like every entry above, so each matches at every
|
||||||
.env
|
# depth. Matching is case-sensitive on Linux, so names use character
|
||||||
.env.*
|
# ranges rather than a lowercase form that misses `Server.Key`.
|
||||||
*.pem
|
|
||||||
*.key
|
# 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][dD]25519
|
||||||
|
|||||||
+67
-2
@@ -10,14 +10,21 @@ run:
|
|||||||
|
|
||||||
linters:
|
linters:
|
||||||
default: all
|
default: all
|
||||||
|
enable:
|
||||||
|
# Successor to the deprecated gomodguard. Named explicitly, rather than
|
||||||
|
# left to `default: all`, because it carries the module policy below.
|
||||||
|
- gomodguard_v2
|
||||||
disable:
|
disable:
|
||||||
# Genuinely incompatible with project patterns
|
# Genuinely incompatible with project patterns
|
||||||
- exhaustruct # Requires all struct fields
|
- exhaustruct # Requires all struct fields
|
||||||
- depguard # Dependency allow/block lists
|
- exhaustruct_v5 # Requires all struct fields (successor to exhaustruct)
|
||||||
- godot # Requires comments to end with periods
|
- godot # Requires comments to end with periods
|
||||||
- wsl # Deprecated, replaced by wsl_v5
|
|
||||||
- wrapcheck # Too verbose for internal packages
|
- wrapcheck # Too verbose for internal packages
|
||||||
- varnamelen # Short names like db, id are idiomatic Go
|
- varnamelen # Short names like db, id are idiomatic Go
|
||||||
|
# Deprecated: the warning is attached to the old name, so it is
|
||||||
|
# silenced by disabling that name, not by enabling the successor.
|
||||||
|
- wsl # Deprecated, replaced by wsl_v5
|
||||||
|
- gomodguard # Deprecated, replaced by gomodguard_v2
|
||||||
settings:
|
settings:
|
||||||
lll:
|
lll:
|
||||||
line-length: 88
|
line-length: 88
|
||||||
@@ -28,6 +35,64 @@ linters:
|
|||||||
max-complexity: 15
|
max-complexity: 15
|
||||||
dupl:
|
dupl:
|
||||||
threshold: 100
|
threshold: 100
|
||||||
|
depguard:
|
||||||
|
# Test-support code must not be compiled into the shipped binary. A
|
||||||
|
# test-support package exists to hand a test privileges the program
|
||||||
|
# itself must never have, so a file that is not a test must not import
|
||||||
|
# one. Test files, and the files inside a package whose directory name
|
||||||
|
# ends in `test`, are where that code belongs, and are exempt.
|
||||||
|
#
|
||||||
|
# The deny list below is the one part of this file a repository is
|
||||||
|
# expected to extend, and the only part it may. depguard matches an
|
||||||
|
# import path against a list of prefixes, so it cannot be told "any path
|
||||||
|
# whose last segment ends in test"; a repository's own test-support
|
||||||
|
# packages have to be named here one at a time, by full import path,
|
||||||
|
# under a module path that differs from repository to repository. Add
|
||||||
|
# them; change nothing else.
|
||||||
|
rules:
|
||||||
|
test-support:
|
||||||
|
list-mode: lax
|
||||||
|
files:
|
||||||
|
- "$all"
|
||||||
|
- "!$test"
|
||||||
|
- "!**/*test/**"
|
||||||
|
deny:
|
||||||
|
- pkg: net/http/httptest
|
||||||
|
desc: >-
|
||||||
|
Test-support code belongs in test files and in packages whose
|
||||||
|
directory name ends in test, not in the shipped binary.
|
||||||
|
# Only decisions already recorded in the Go package defaults are
|
||||||
|
# listed here. Every entry matches the module path exactly.
|
||||||
|
gomodguard_v2:
|
||||||
|
blocked:
|
||||||
|
- module: github.com/rs/zerolog
|
||||||
|
recommendations:
|
||||||
|
- log/slog
|
||||||
|
reason: "Structured logging is stdlib log/slog."
|
||||||
|
# One entry per pre-fork module path, because the later releases
|
||||||
|
# are separate paths. A prefix match would be shorter but would
|
||||||
|
# also reach github.com/go-redis/redismock, the test double for
|
||||||
|
# the successor these entries recommend.
|
||||||
|
- module: github.com/go-redis/redis
|
||||||
|
recommendations:
|
||||||
|
- github.com/redis/go-redis/v9
|
||||||
|
reason: "Pre-fork module; use the maintained go-redis v9."
|
||||||
|
- module: github.com/go-redis/redis/v7
|
||||||
|
recommendations:
|
||||||
|
- github.com/redis/go-redis/v9
|
||||||
|
reason: "Pre-fork module; use the maintained go-redis v9."
|
||||||
|
- module: github.com/go-redis/redis/v8
|
||||||
|
recommendations:
|
||||||
|
- github.com/redis/go-redis/v9
|
||||||
|
reason: "Pre-fork module; use the maintained go-redis v9."
|
||||||
|
- module: github.com/sergi/go-diff
|
||||||
|
recommendations:
|
||||||
|
- github.com/aymanbagabas/go-udiff
|
||||||
|
reason: "No unified diff output; use go-udiff."
|
||||||
|
- module: github.com/hexops/gotextdiff
|
||||||
|
recommendations:
|
||||||
|
- github.com/aymanbagabas/go-udiff
|
||||||
|
reason: "Unmaintained fork; use go-udiff."
|
||||||
|
|
||||||
issues:
|
issues:
|
||||||
max-issues-per-linter: 0
|
max-issues-per-linter: 0
|
||||||
|
|||||||
+48
-26
@@ -1,37 +1,59 @@
|
|||||||
|
# Lint phase. The linter is invoked directly rather than through `make
|
||||||
|
# lint` or `script/lint`, which are themselves a docker build and would
|
||||||
|
# recurse into a daemon that does not exist in a build step.
|
||||||
|
#
|
||||||
# node 22-alpine, 2026-02-22
|
# node 22-alpine, 2026-02-22
|
||||||
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34
|
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS lint
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
# script/bootstrap installs all prerequisites (make via apk here; node
|
|
||||||
# and yarn are already in the base image, so those steps are skipped).
|
|
||||||
# Dependency manifests are copied first so the bootstrap layer is
|
|
||||||
# cached until they change.
|
|
||||||
COPY script/ script/
|
COPY script/ script/
|
||||||
COPY package.json yarn.lock ./
|
COPY package.json yarn.lock ./
|
||||||
RUN script/bootstrap
|
RUN script/bootstrap
|
||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
# CHECK_EPOCH is a per-invocation nonce supplied by script/cibuild and
|
RUN yarn run prettier --check '**/*.md' --tab-width 4 --prose-wrap always
|
||||||
# script/docker. Without it an unchanged tree serves this layer from
|
|
||||||
# cache and the build reports a green it never ran. ARG is stage-scoped,
|
|
||||||
# so it must be redeclared in every stage that runs checks. The guard
|
|
||||||
# makes a bare `docker build .` fail loudly instead of silently reusing
|
|
||||||
# the empty (and therefore stable) cache key. Expand the value into the
|
|
||||||
# command so the cache miss does not depend on BuildKit's handling of an
|
|
||||||
# unreferenced ARG. Both the guard and the check RUN reference the value,
|
|
||||||
# so both are value-keyed: there are two independent invalidation points
|
|
||||||
# here, not one. Keep both.
|
|
||||||
ARG CHECK_EPOCH
|
|
||||||
RUN [ -n "$CHECK_EPOCH" ] || exit 1
|
|
||||||
|
|
||||||
# The individual non-lint checks, NOT `make check`. Lint is deliberately
|
# Test phase, same shape and for the same reason.
|
||||||
# absent here: `script/lint` is itself a `docker build` (of
|
#
|
||||||
# Dockerfile.lint), so running `make check` in this image would attempt
|
# node 22-alpine, 2026-02-22
|
||||||
# a docker build inside a build step, where there is no daemon. Putting
|
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34 AS test
|
||||||
# `make check` back reintroduces exactly that recursion. Lint is not
|
|
||||||
# skipped — script/cibuild runs script/lint first, in its own container,
|
WORKDIR /app
|
||||||
# before this build starts.
|
|
||||||
RUN echo "check epoch: ${CHECK_EPOCH}" && script/test
|
COPY script/ script/
|
||||||
RUN script/fmt-check
|
COPY package.json yarn.lock ./
|
||||||
|
RUN script/bootstrap
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
RUN echo "No tests defined."
|
||||||
|
|
||||||
|
# Development environment, and the last stage: a plain `docker build .`
|
||||||
|
# names no target and so builds this one. Nothing is wanted from the two
|
||||||
|
# phases above; the copies are what make BuildKit build them first, so
|
||||||
|
# this image cannot be produced unless lint and test passed. A stage
|
||||||
|
# appended after this one would drop all three out of a plain build.
|
||||||
|
#
|
||||||
|
# node 22-alpine, 2026-02-22
|
||||||
|
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY --from=lint /app/package.json /dev/null
|
||||||
|
COPY --from=test /app/package.json /dev/null
|
||||||
|
|
||||||
|
# script/bootstrap installs all prerequisites. Manifests are copied
|
||||||
|
# first so that layer stays cached until dependencies change.
|
||||||
|
COPY script/ script/
|
||||||
|
COPY package.json yarn.lock ./
|
||||||
|
RUN script/bootstrap
|
||||||
|
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# Nothing here is compiled and a LABEL cannot run git, so the version is
|
||||||
|
# the VERSION build argument that script/docker and script/cibuild pass;
|
||||||
|
# a plain `docker build .` leaves it empty.
|
||||||
|
ARG VERSION
|
||||||
|
LABEL org.opencontainers.image.version="${VERSION}"
|
||||||
|
|||||||
@@ -1,41 +0,0 @@
|
|||||||
# Lint-only image. `script/lint` builds this file and nothing else: the
|
|
||||||
# linter runs as a build step, so a successful build IS a clean lint.
|
|
||||||
# Building rather than bind-mounting is what makes it work where the
|
|
||||||
# docker daemon is remote and bind mounts are impossible.
|
|
||||||
#
|
|
||||||
# The linter is invoked directly below rather than through `make lint`.
|
|
||||||
# That is not a style choice: `script/lint` IS this build, so calling it
|
|
||||||
# from inside would recurse into a docker build with no daemon.
|
|
||||||
#
|
|
||||||
# This repo's linter is prettier over markdown. A Go repo's version of
|
|
||||||
# this file differs only in the base image and the two lint commands;
|
|
||||||
# see the containerised-lint rule in prompts/REPO_POLICIES.md.
|
|
||||||
#
|
|
||||||
# node 22-alpine, 2026-02-22
|
|
||||||
FROM node@sha256:e4bf2a82ad0a4037d28035ae71529873c069b13eb0455466ae0bc13363826e34
|
|
||||||
|
|
||||||
WORKDIR /app
|
|
||||||
|
|
||||||
# Dependency layer first, and deliberately above the ARG below, so it
|
|
||||||
# stays cached and only the lint steps re-run on every invocation.
|
|
||||||
# Without that ordering the cache-bust would reinstall dependencies on
|
|
||||||
# every lint and make linting network-dependent.
|
|
||||||
COPY script/ script/
|
|
||||||
COPY package.json yarn.lock ./
|
|
||||||
RUN script/bootstrap
|
|
||||||
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
# CHECK_EPOCH is a per-invocation nonce supplied by script/lint. Without
|
|
||||||
# it an unchanged tree serves the lint layer from cache and the build
|
|
||||||
# reports a lint it never ran — a green that proves nothing, which is
|
|
||||||
# the whole failure mode this file exists to avoid reintroducing. The
|
|
||||||
# guard makes a bare `docker build -f Dockerfile.lint .` fail loudly
|
|
||||||
# instead of silently reusing the empty (and therefore stable) cache
|
|
||||||
# key. The value is expanded into the lint command as well, so the cache
|
|
||||||
# miss does not depend on BuildKit's handling of an unreferenced ARG and
|
|
||||||
# the epoch is visible in the build log. Keep both references.
|
|
||||||
ARG CHECK_EPOCH
|
|
||||||
RUN [ -n "$CHECK_EPOCH" ] || exit 1
|
|
||||||
RUN echo "lint epoch: ${CHECK_EPOCH}" && \
|
|
||||||
yarn run prettier --check '**/*.md' --tab-width 4 --prose-wrap always
|
|
||||||
@@ -116,26 +116,23 @@ alpine. We provide:
|
|||||||
`script/bootstrap`, then `script/install-precommit`
|
`script/bootstrap`, then `script/install-precommit`
|
||||||
- `script/projectname` — output the project name (our own extension); used by
|
- `script/projectname` — output the project name (our own extension); used by
|
||||||
`script/docker` for the image tag
|
`script/docker` for the image tag
|
||||||
- `script/test` — run the test suite (no tests defined here)
|
- `script/test` — `docker build --no-cache --target test -t prompts-test .`,
|
||||||
- `script/lint` — lint the markdown files, by building `Dockerfile.lint`. The
|
building the `test` phase of the `Dockerfile` (no tests defined here)
|
||||||
linter runs in a container, always: it is never installed on the host and
|
- `script/lint` — `docker build --no-cache --target lint -t prompts-lint .`,
|
||||||
never invoked there. Linting happens as a build step, so a successful build is
|
building the `lint` phase, which runs prettier over the markdown files
|
||||||
a clean lint, and the same per-invocation `CHECK_EPOCH` nonce used elsewhere
|
- `script/fmt` — format all markdown files with prettier (writes; native, not in
|
||||||
is what stops Docker serving that lint from cache on an unchanged tree
|
a container)
|
||||||
- `script/fmt` — format all markdown files with prettier (writes)
|
- `script/fmt-check` — check formatting (read-only; native)
|
||||||
- `script/fmt-check` — check formatting (read-only)
|
|
||||||
- `script/check` — run all checks: `test`, `lint`, `fmt-check` (our own
|
- `script/check` — run all checks: `test`, `lint`, `fmt-check` (our own
|
||||||
extension). Needs a docker daemon, since `script/lint` is a container build
|
extension); builds no image of its own
|
||||||
- `script/docker` — build the Docker image, tagged via `script/projectname`
|
- `script/docker` —
|
||||||
(byte-identical across repos); passes the same `CHECK_EPOCH` nonce as
|
`docker build --no-cache --build-arg VERSION="$version" -t prompts .`, the tag
|
||||||
`script/cibuild`
|
coming from `script/projectname` (byte-identical across repos)
|
||||||
- `script/cibuild` — cd to the repo root, run `script/lint` first, then assign
|
- `script/cibuild` — cd to the repo root, run `script/bootstrap`, run
|
||||||
`epoch="$(date +%s%N)$$"` and
|
`script/check`, compute `version` from `git describe`, then
|
||||||
`docker build --build-arg CHECK_EPOCH="$epoch" .` (what CI runs). Two
|
`docker build --no-cache --build-arg VERSION="$version" -t prompts .` (what CI
|
||||||
container builds: the lint image, then the main image, which runs
|
runs; it bootstraps because CI checks out and runs this alone while
|
||||||
`script/test` and `script/fmt-check` but deliberately not `make check` — that
|
`script/fmt-check` is native)
|
||||||
would nest a docker build inside a build step. A bare `docker build .` fails
|
|
||||||
closed on purpose
|
|
||||||
- `script/precommit` — run by the git pre-commit hook (our own extension); calls
|
- `script/precommit` — run by the git pre-commit hook (our own extension); calls
|
||||||
`script/check`
|
`script/check`
|
||||||
- `script/install-precommit` — installs the git pre-commit hook (our own
|
- `script/install-precommit` — installs the git pre-commit hook (our own
|
||||||
|
|||||||
@@ -21,140 +21,98 @@ fmt-check, and commit.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-08-10: Closed three gaps the containerised-lint rule left between the
|
- 2026-10-04: `REPO_POLICIES.md` now states that guidance for coding agents
|
||||||
canonical text and the first repos to implement it. `.dockerignore` excluding
|
lives in one `AGENTS.md` at the repository root, never under a file or
|
||||||
the agent scratch directory is now stated as a correctness precondition of
|
directory named after one agent tool and never in separate memory files (issue
|
||||||
that rule rather than a context-size measure: the lint image lints whatever
|
31). This retires the rule, still present in older vendored copies, that kept
|
||||||
`COPY . .` copies, and toolchains discover files by walking the tree instead
|
agent memory as committed files under `.claude/memory/`. `AGENTS.md` joins the
|
||||||
of reading `.gitignore`, so a nested worktree puts the foreign-tree false reds
|
list of files allowed in the root, and both checklists say so.
|
||||||
back inside the container — `sneak/quak` measured the same discovery mechanism
|
- 2026-10-04: Rewrote the note under the canonical Go `make test` example in
|
||||||
taking a test count from 210 to 1050. The cache-bust arg is fixed at
|
`REPO_POLICIES.md` (issue 77), which still named the cache-busting build
|
||||||
`CHECK_EPOCH` in `Dockerfile.lint` as well, because a per-file name is
|
argument that `--no-cache` replaced. It now says where Go's test result cache
|
||||||
invisible to the grep that proves every build is busted, making a renamed
|
can replay a pass: on a developer's machine, where the Makefile target runs,
|
||||||
guard indistinguishable from a missing one. And the formatting check is now
|
and not in the `test` phase of the `Dockerfile`, whose base image and earlier
|
||||||
required to run in exactly one of the two images, with either placement
|
steps hold no result for the repo's tests.
|
||||||
allowed: splitting lint out of the `Dockerfile` is precisely when `fmt-check`
|
- 2026-10-04: The Makefile examples in the Go styleguide and the HTTP server
|
||||||
gets dropped from both, and running the formatter beside the linters is the
|
conventions now fall back to `dev` when `git describe` prints nothing (outside
|
||||||
better shape where it is the same pinned dependency.
|
a git checkout, or where git is missing or refuses the checkout), instead of
|
||||||
- 2026-08-10: Moved every lint run into a container, on the owner's ruling, and
|
stamping an empty version (issue 74). The canonical `Dockerfile` already fails
|
||||||
made this repo do it rather than merely document it. `script/lint` is now
|
on a `dev` version when `.git` is in the build context.
|
||||||
`docker build -f Dockerfile.lint .` and nothing else; the linter is never
|
- 2026-10-04: The canonical `.dockerignore` now also keeps out each submodule's
|
||||||
installed on the host and never invoked there, so a run cannot inherit another
|
`config` (issue 75). A submodule's git directory lives under `.git/modules/`,
|
||||||
checkout's content-keyed result cache, the host-global
|
nested again for its own submodules, and its `config` can hold a credential
|
||||||
`$TMPDIR/golangci-lint.lock`, or a host toolchain that differs from the pinned
|
just like `.git/config`. The pattern `.git/modules/**/config` covers every
|
||||||
one — the three mechanisms behind a confirmed false green, a string of
|
depth and leaves the top-level `.git` that `git describe` reads untouched.
|
||||||
findings reported against other agents' checkouts, and a container that saw
|
`REPO_POLICIES.md` and both checklists say so in the same words.
|
||||||
thirteen findings the host missed. Linting runs as a build step, so a
|
- 2026-10-03: Fixed two defects in the canonical Go `Dockerfile` example (issue
|
||||||
successful build is a clean lint, which also works where the docker daemon is
|
73). The test phase now uses the Debian Go image, since `-race` needs cgo and
|
||||||
remote and bind mounts are impossible. The recursion this creates is resolved
|
the alpine image has no C compiler, so the phase failed before running a test.
|
||||||
by direction rather than by detection: the main `Dockerfile` runs the
|
The stage that compiles runs `git config --system --add safe.directory /src`,
|
||||||
individual non-lint checks instead of `make check`, and `script/cibuild` runs
|
because a context sent as a tar stream keeps the sender's file owners and git
|
||||||
`script/lint` first, so no build ever nests a build. `Dockerfile.lint` carries
|
refuses that checkout, leaving the version empty. Both checklists state that
|
||||||
the same `CHECK_EPOCH` guard as the main image, with the `ARG` below the
|
step in the same words.
|
||||||
dependency layer so only the lint steps re-run — blanket `--no-cache` was
|
- 2026-10-03: Moved the canonical golangci-lint to v2.14.0, built with go1.27,
|
||||||
rejected because it makes every lint reinstall its dependencies over the
|
because v2.12.2 refuses to lint a module whose `go` directive is 1.27 (issue
|
||||||
network. Two canonical forms were superseded rather than left standing beside
|
65). Releases from v2.13.0 deprecate `exhaustruct` in favour of
|
||||||
the new one, since consuming repos read this document literally: the
|
`exhaustruct_v5`, which `default: all` switches on, so the canonical
|
||||||
`script/bootstrap` golangci-lint install (nothing runs a host linter now, so
|
`.golangci.yml` now disables `exhaustruct_v5` beside `exhaustruct`. v2.12.2
|
||||||
it can only reintroduce skew; the version-enforcement principle stays
|
rejects that file, so `REPO_POLICIES.md` and both repo checklists now say a
|
||||||
documented for other pinned host tools) and the per-checkout
|
repo sets the lint phase digest and re-vendors `.golangci.yml` in one commit.
|
||||||
cache/lock/`.lint-cache` wrapper (its whole subject was making a host run
|
- 2026-10-03: Brought the canonical `.gitignore` level with `.dockerignore` on
|
||||||
trustworthy). The Go multistage lint stage goes with them: it ran `make lint`,
|
secrets (issue 38): it now also ignores `prod.env`-style `*.env` files,
|
||||||
which is now a docker build. `golangci-lint config verify` was kept on
|
`.envrc`, `*.p12`, `*.pfx` and the extensionless SSH private keys, written to
|
||||||
measurement, not preference — a bogus config key passes `golangci-lint run`
|
`.gitignore`'s own rules (no `**/` prefix) and case-folded with character
|
||||||
with `0 issues` and fails `config verify`, and every case reproduced
|
ranges. `example.env` and `sample.env` stay trackable through negations.
|
||||||
byte-identically under `docker run --network none`, so the schema is embedded
|
- 2026-10-02: The image version now comes from git inside the build (issues 69
|
||||||
in the pinned binary and the line costs no network. Verified with two
|
and 71), superseding the 2026-09-08 entry that excluded `.git`. The canonical
|
||||||
consecutive runs on an unchanged tree both executing the linter, a planted
|
`.dockerignore` sends `.git` but keeps out `.git/config`, which can hold a
|
||||||
violation caught and reverted, the bare-build guard firing, and the main image
|
credential. The Dockerfile example in `REPO_POLICIES.md` installs `git`, takes
|
||||||
building without attempting a nested build.
|
the `VERSION` build argument when one is given and otherwise
|
||||||
- 2026-08-09: Made a golangci-lint result belong to the tree that asked for it.
|
`git describe --tags --always`, and fails when `.git` exists but the version
|
||||||
REPO_POLICIES.md now carries the canonical Go `script/lint`, which gives the
|
is empty, `dev` or `unknown`; a plain `docker build .` with no build arguments
|
||||||
linter per-checkout `GOLANGCI_LINT_CACHE` and per-checkout `TMPDIR`. The two
|
must succeed. This repo's `script/docker` and `script/cibuild` still pass
|
||||||
are separate defects and the second is the one that gets dropped: the result
|
`--build-arg VERSION`, since its own `Dockerfile` compiles nothing.
|
||||||
cache is keyed on file content rather than location, so checkouts holding
|
- 2026-09-08: Moved linting and testing into Docker as phases of the main
|
||||||
identical files serve each other's findings under the other's path, while the
|
`Dockerfile`, per the owner ruling on issue 40. `script/lint` and
|
||||||
concurrency lock is `$TMPDIR/golangci-lint.lock` — host-global, independent of
|
`script/test` build one phase each by name with `--no-cache` — the same answer
|
||||||
the cache, and unaffected by isolating it. Moving workers from worktrees to
|
issue 26 got, so no separate cache-busting mechanism survives — and the final
|
||||||
their own clones does not help either half; it only removes the foreign-path
|
stage copies a harmless file from both, so the image cannot be built unless
|
||||||
artefact that made the defect visible. The lock error is retried rather than
|
they pass. This also closes issue 30: a container has its own result cache and
|
||||||
surfaced, because it is not a result: it exits non-zero exactly as findings
|
its own lock, so a lint verdict can no longer belong to another checkout. No
|
||||||
do, and reporting it as findings sends a correct branch back for rework.
|
separate lint Dockerfile, and no `golangci-lint config verify` step.
|
||||||
Detection is on the stderr stream and never on exit status, so a finding
|
`script/check` runs the gates and nothing else, and `script/cibuild`
|
||||||
quoting the lock message in source cannot be retried away, and exhaustion
|
bootstraps first, since it is all CI runs and `script/fmt-check` is native.
|
||||||
exits 75 with a VOID message rather than passing or failing quietly.
|
- 2026-09-08: Kept in-repo agent scratch out of the Docker build context and out
|
||||||
`--allow-serial-runners` (which keeps the guard and queues) covers the
|
of version control: `.claude/` is one full checkout of the repo per in-flight
|
||||||
same-checkout overlap that `TMPDIR` scoping cannot; `--allow-parallel-runners`
|
agent, and under `COPY . .` all of it was reaching the image. Also closed the
|
||||||
is rejected outright. The stdout and stderr capture files are per invocation
|
consequence of excluding `.git` — `git describe` yields an empty version
|
||||||
rather than per checkout, because serialising the linter does not serialise
|
inside a build stage without failing, so `script/docker` and `script/cibuild`
|
||||||
the shell's redirections: two runs in one checkout — the overlap the flag
|
now compute the version on the host and pass `--build-arg VERSION`.
|
||||||
exists to support — would otherwise truncate and read each other's output,
|
- 2026-09-08: Closed the secret exposure in the canonical `.dockerignore`: a
|
||||||
which is the same defect one layer above where it was fixed. Both checklists
|
local `.env`, `*.pem` or `*.key` was reaching the build context under
|
||||||
gained the corresponding items, since a half-fix that sets only the cache
|
`COPY . .`, invisible to every git-based check. The patterns are now written
|
||||||
reads as complete. `GOCACHE` was measured and does not need isolating.
|
to `.dockerignore`'s own semantics — `**/`-prefixed so they hold at every
|
||||||
Verified with the snippet extracted from the committed document and executed
|
depth, case-folded with character ranges — and `REPO_POLICIES.md` requires
|
||||||
as a consuming repo would adopt it, against paired controls: contamination
|
verifying by enumerating the image rather than by reading the file.
|
||||||
reproduced on the pre-fix form and absent on the adopted one, retry engaged,
|
- 2026-09-08: Made a pinned tool in `script/bootstrap` actually reach the host.
|
||||||
exhaustion loud, a genuine finding still reported, and a held host lock
|
`REPO_POLICIES.md` now requires comparing the installed version against the
|
||||||
failing the pre-fix script while leaving the adopted one untouched.
|
pin rather than testing `PATH` presence, and re-resolving the binary through
|
||||||
- 2026-08-09: Kept in-repo agent scratch out of the Docker build context and out
|
`PATH` after installing, so a version bump cannot be a silent no-op and a
|
||||||
of version control. `.claude/` holds one worktree — an entire additional
|
shadowed install cannot report success.
|
||||||
checkout of the repo — per in-flight agent, and under `COPY . .` all of it was
|
- 2026-09-08: Closed the false green in the canonical CI gate: `script/cibuild`
|
||||||
reaching the image: another session's unreviewed, sometimes uncommitted work,
|
and `script/docker` now build with `--no-cache`, so the Dockerfile's check
|
||||||
inflating the context by a multiple of the repo and invalidating `COPY` for
|
layers cannot be served from cache on an unchanged tree, and the text claiming
|
||||||
reasons unrelated to the repo's own content. The `.dockerignore` entry is
|
a bare `docker build .` proves the checks ran is corrected in
|
||||||
root-anchored, because the directory occurs exactly once where agents run at
|
`REPO_POLICIES.md`, both checklists and the Go styleguide.
|
||||||
the repo root and the `**/` form additionally deletes any nested directory of
|
- 2026-09-03: Added `-count=1` to both `go test` invocations in the canonical Go
|
||||||
that name — with the residual gap that follows from anchoring (a monorepo
|
`make test` example in `REPO_POLICIES.md`, so the target cannot report a
|
||||||
running agents in subdirectories still ships `services/api/.claude/`) stated
|
cached pass it did not earn, and documented that Go's test-result cache is a
|
||||||
in the canonical `.dockerignore`, the policy and the existing-repo checklist,
|
second, independent cache stacked below the Docker layer cache.
|
||||||
since consuming repos receive the files rather than the tracker; the
|
- 2026-08-31: Migrated the canonical `.golangci.yml` from the deprecated
|
||||||
`.gitignore` entry is unanchored, because `.gitignore` patterns already match
|
`gomodguard` to `gomodguard_v2`: the old linter is disabled by name (which is
|
||||||
at every depth, and each file is written to its own semantics rather than
|
what silences the deprecation warning), the successor is named explicitly in
|
||||||
derived from the other. Also closed the consequence that ships broken
|
`linters.enable`, and it carries a `blocked` module list drawn only from
|
||||||
silently: excluding `.git` means `git describe` cannot run in any build stage
|
decisions already recorded in the Go package defaults.
|
||||||
and yields an empty version without erroring, so `script/docker` and
|
|
||||||
`script/cibuild` now compute the version on the host and pass
|
|
||||||
`--build-arg VERSION`, and `REPO_POLICIES.md` states where `VERSION` comes
|
|
||||||
from instead of leaving the reader to fill the gap with `git describe` inside
|
|
||||||
the build. The two Go documents that carry the `GOLDFLAGS` pattern were
|
|
||||||
corrected in the same pass, from `:=` to `?=`, since a `$(shell git describe)`
|
|
||||||
evaluated inside a build stage is exactly the empty version this closes.
|
|
||||||
Verified by enumerating a probe image before, after, and against the
|
|
||||||
`**/`-prefixed form, with a positive control and the `CHECK_EPOCH` cache
|
|
||||||
verification re-run under the changed build context.
|
|
||||||
- 2026-08-09: Closed the secret exposure in the canonical `.dockerignore`: a
|
|
||||||
developer's local `.env`, `*.pem` or `*.key` was reaching the Docker build
|
|
||||||
context under `COPY . .`, invisible to every git-based check because
|
|
||||||
`.gitignore` covers it. The patterns are written to `.dockerignore`'s own
|
|
||||||
`moby/patternmatcher` semantics — `**/`-prefixed so they hold at every depth,
|
|
||||||
which also fixes nested `node_modules` — rather than transplanted from
|
|
||||||
`.gitignore`, whose unprefixed form protects only the repository root while
|
|
||||||
reading as solved. Coverage extends past the `.env`/`.pem`/`.key` trio to the
|
|
||||||
`prod.env` convention, `.envrc`, PKCS#12 bundles and extensionless SSH keys,
|
|
||||||
every one of them case-folded with character ranges because matching is
|
|
||||||
case-sensitive and an ALL-CAPS twin per pattern still misses `Server.Key`.
|
|
||||||
`REPO_POLICIES.md` and both repo checklists now state that asymmetry and
|
|
||||||
require verification by enumerating the image rather than by reading the
|
|
||||||
patterns. Verified with a probe image before, against three naive forms
|
|
||||||
(unprefixed, lowercase-only, ALL-CAPS-doubled), and after.
|
|
||||||
- 2026-08-09: Made the pinned golangci-lint actually propagate: REPO_POLICIES.md
|
|
||||||
now carries the canonical `script/bootstrap` snippet for Go repos, which
|
|
||||||
installs when the installed version does not match the pin (the old
|
|
||||||
`if missing` guard tested PATH presence only, so pins were inert on any
|
|
||||||
provisioned machine and CI silently disagreed with local) and then re-resolves
|
|
||||||
the binary through `PATH` and fails loudly, naming the shadowing path, when
|
|
||||||
the install did not take effect — the failure mode the naive
|
|
||||||
compare-then-install fix leaves behind while reporting success.
|
|
||||||
- 2026-08-09: Fixed the false green in the canonical CI gate: `script/cibuild`
|
|
||||||
and `script/docker` now pass a per-invocation `CHECK_EPOCH` nonce, and the
|
|
||||||
`Dockerfile` (plus the Go multistage template in REPO_POLICIES.md, in both its
|
|
||||||
lint and builder stages) declares `ARG CHECK_EPOCH` with a guard that makes a
|
|
||||||
bare `docker build .` fail closed. Corrected the org-canonical text that
|
|
||||||
asserted a successful build implies all checks pass, across every document
|
|
||||||
carrying it: `REPO_POLICIES.md`, both repo checklists (which still told agents
|
|
||||||
to write the pre-fix `script/cibuild` and ended on an acceptance item the
|
|
||||||
guard makes unsatisfiable), and the Go styleguide.
|
|
||||||
- 2026-08-07: Set the canonical `.golangci.yml` to the org-standard v2-schema
|
- 2026-08-07: Set the canonical `.golangci.yml` to the org-standard v2-schema
|
||||||
config already deployed byte-identical across the org's Go repos (settings
|
config already deployed byte-identical across the org's Go repos (settings
|
||||||
under `linters.settings` so thresholds like lll/funlen/cyclop/dupl actually
|
under `linters.settings` so thresholds like lll/funlen/cyclop/dupl actually
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Code Styleguide — Go
|
title: Code Styleguide — Go
|
||||||
last_modified: 2026-08-10
|
last_modified: 2026-10-04
|
||||||
---
|
---
|
||||||
|
|
||||||
1. Try to hard wrap long lines at 77 characters or less.
|
1. Try to hard wrap long lines at 77 characters or less.
|
||||||
@@ -24,7 +24,8 @@ last_modified: 2026-08-10
|
|||||||
1. Embed the git commit hash into the binary and include it in startup logs and
|
1. Embed the git commit hash into the binary and include it in startup logs and
|
||||||
in health check output. This is to make it easier to correlate running
|
in health check output. This is to make it easier to correlate running
|
||||||
instances with their code. Do not include build time or build user, as these
|
instances with their code. Do not include build time or build user, as these
|
||||||
will make the build nondeterministic.
|
will make the build nondeterministic. The architecture is not passed in at
|
||||||
|
build time; a program that reports it reads `runtime.GOARCH` at run time.
|
||||||
|
|
||||||
Example relevant Makefile sections:
|
Example relevant Makefile sections:
|
||||||
|
|
||||||
@@ -35,38 +36,27 @@ last_modified: 2026-08-10
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"runtime"
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var Version string
|
||||||
Version string
|
|
||||||
Buildarch string
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
fmt.Printf("Version: %s\n", Version)
|
fmt.Printf("Version: %s\n", Version)
|
||||||
fmt.Printf("Buildarch: %s\n", Buildarch)
|
fmt.Printf("Arch: %s\n", runtime.GOARCH)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
```make
|
```make
|
||||||
# ?= rather than := because this `$(shell git describe ...)` is only
|
# ?= rather than := so that a `VERSION` build argument takes precedence:
|
||||||
# correct on the host. `.dockerignore` excludes `.git`, so evaluated
|
# where a build stage invokes make, `ARG VERSION` puts it in the
|
||||||
# inside a build stage it expands to the empty string without failing
|
# environment and `?=` defers to it. Otherwise `git describe` runs, in a
|
||||||
# and the binary reports no version at all. The version is computed on
|
# build stage on the `.git` the build context carries. When it prints
|
||||||
# the host by `script/docker` / `script/cibuild` and passed with
|
# nothing (outside a git checkout, or where git is missing or refuses the
|
||||||
# `--build-arg VERSION=...`. If this repo's Dockerfile compiles by
|
# checkout), the version falls back to `dev`.
|
||||||
# invoking make (`RUN make build`), `ARG VERSION` in that stage puts the
|
VERSION ?= $(or $(shell git describe --tags --always 2>/dev/null),dev)
|
||||||
# value in the environment and `?=` defers to it. The canonical Go
|
|
||||||
# template in REPO_POLICIES.md instead runs `go build` directly with
|
|
||||||
# `-ldflags "... -X main.Version=${VERSION}"`, so there this Makefile is
|
|
||||||
# a host-only path — but it is still `?=`, because a repo that later
|
|
||||||
# moves the build behind make must not silently start shipping an empty
|
|
||||||
# version. See the git-describe rule in REPO_POLICIES.md.
|
|
||||||
VERSION ?= $(shell git describe --always --dirty)
|
|
||||||
BUILDARCH := $(shell uname -m)
|
|
||||||
|
|
||||||
GOLDFLAGS += -X main.Version=$(VERSION)
|
GOLDFLAGS += -X main.Version=$(VERSION)
|
||||||
GOLDFLAGS += -X main.Buildarch=$(BUILDARCH)
|
|
||||||
|
|
||||||
# osx can't statically link apparently?!
|
# osx can't statically link apparently?!
|
||||||
ifeq ($(UNAME_S),Darwin)
|
ifeq ($(UNAME_S),Darwin)
|
||||||
@@ -111,26 +101,19 @@ last_modified: 2026-08-10
|
|||||||
|
|
||||||
1. For anything beyond a simple script or tool, or anything that is going to
|
1. For anything beyond a simple script or tool, or anything that is going to
|
||||||
run in any sort of "production" anywhere, make sure it passes
|
run in any sort of "production" anywhere, make sure it passes
|
||||||
`golangci-lint`. Run it with `make lint`, which builds `Dockerfile.lint`:
|
`golangci-lint`. Run it with `make lint`, never by invoking the binary: the
|
||||||
the linter runs in a container, always, and is never installed on the host.
|
linter runs as a phase of the `Dockerfile` and is not installed on the host
|
||||||
A `golangci-lint` invoked directly on a shared host reads a result cache
|
by any repo. Invoked directly on a shared host it reads a result cache keyed
|
||||||
keyed on file content rather than location and a host-global lock, so its
|
on file content rather than location, and a host-global lock, so its answer
|
||||||
answer may belong to another checkout entirely.
|
may belong to another checkout entirely.
|
||||||
|
|
||||||
1. Write a `Dockerfile` for every repo, even if it only runs the tests. It runs
|
1. Write a `Dockerfile` for every repo, even if it only runs the tests and
|
||||||
the non-lint checks; linting lives in `Dockerfile.lint` and is run by
|
linting. It carries the lint and test phases, and the final stage depends on
|
||||||
`script/cibuild` before the main build, because `script/lint` is itself a
|
both, so a build makes sure the code is in an able-to-be-compiled state,
|
||||||
`docker build` and cannot run inside one. So `script/cibuild` is what
|
linted, and its tests run. Go through `script/cibuild` or `script/docker`
|
||||||
guarantees the code is in an able-to-be-compiled state, linted, and tested —
|
rather than a bare `docker build .`: they pass `--no-cache`, without which
|
||||||
**a successful `docker build .` on its own does not, because it never
|
an unchanged tree serves the gate layers from cache and the build reports a
|
||||||
lints.** That guarantee holds only because each build passes a
|
green it never ran.
|
||||||
per-invocation `CHECK_EPOCH` build arg that busts its check layers out of
|
|
||||||
the Docker cache; without it an unchanged tree serves those layers from
|
|
||||||
cache and the build reports a green it never ran. A bare `docker build .`
|
|
||||||
fails closed by design, on the `[ -n "$CHECK_EPOCH" ]` guard — always go
|
|
||||||
through `script/cibuild`, `script/docker` or `script/lint`. See
|
|
||||||
[Repository Policies](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md)
|
|
||||||
for the canonical form.
|
|
||||||
|
|
||||||
1. Every repo must have a `Makefile`. See
|
1. Every repo must have a `Makefile`. See
|
||||||
[Repository Policies](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md)
|
[Repository Policies](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md)
|
||||||
@@ -151,10 +134,15 @@ last_modified: 2026-08-10
|
|||||||
|
|
||||||
1. Keep the `main()` function as small as possible.
|
1. Keep the `main()` function as small as possible.
|
||||||
|
|
||||||
1. Keep the `main` package as small as possible. Move as much code as is
|
1. Keep the `main` package as small as possible. Each `cmd/<name>/` directory
|
||||||
feasible to a library package, even if it's an internal one. `main` is just
|
contains a single `main.go` whose body is one call into library code (for
|
||||||
an entrypoint to your code, not a place for implementations. Exception:
|
example `os.Exit(cli.Main())` calling `internal/cli`). All CLI logic — flag
|
||||||
single-file scripts.
|
parsing, subcommand dispatch, argument handling, output formatting — lives
|
||||||
|
in `internal/` or `pkg/`, not in `cmd/`. `main` is just an entrypoint to
|
||||||
|
your code, not a place for implementations. Exception: single-file scripts.
|
||||||
|
|
||||||
|
1. No project logic outside `internal/` or `pkg/`. Anything in `cmd/` is a thin
|
||||||
|
entrypoint only.
|
||||||
|
|
||||||
1. HTTP HandleFuncs should be returned from methods or functions that need to
|
1. HTTP HandleFuncs should be returned from methods or functions that need to
|
||||||
handle HTTP requests. Don't use methods or your top level functions as
|
handle HTTP requests. Don't use methods or your top level functions as
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Existing Repo Checklist
|
title: Existing Repo Checklist
|
||||||
last_modified: 2026-08-10
|
last_modified: 2026-10-04
|
||||||
---
|
---
|
||||||
|
|
||||||
Use this checklist when beginning work in a repo that may not yet conform to our
|
Use this checklist when beginning work in a repo that may not yet conform to our
|
||||||
@@ -24,84 +24,75 @@ with your task.
|
|||||||
- [ ] `LICENSE` file exists and matches the README
|
- [ ] `LICENSE` file exists and matches the README
|
||||||
- [ ] `REPO_POLICIES.md` exists and version date is current — fetch from
|
- [ ] `REPO_POLICIES.md` exists and version date is current — fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md`
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md`
|
||||||
|
- [ ] Guidance for coding agents, if the repo has any, is one `AGENTS.md` at the
|
||||||
|
root — never a file or directory named after one agent tool, such as
|
||||||
|
`CLAUDE.md` or `.claude/`, and never separate memory files. Move what any
|
||||||
|
such committed file says into `AGENTS.md` and delete it.
|
||||||
- [ ] `.gitignore` is comprehensive (OS, editor, agent scratch, language
|
- [ ] `.gitignore` is comprehensive (OS, editor, agent scratch, language
|
||||||
artifacts, secrets) — fetch from
|
artifacts, secrets) — fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` if missing.
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` if missing.
|
||||||
An existing repo usually has a hand-written one that is never re-fetched,
|
An existing repo usually has a hand-written one that is never re-fetched,
|
||||||
so check the entries rather than the file's presence: `.claude/` in
|
so check the entries rather than the file's presence.
|
||||||
particular, unanchored, so agent worktrees cannot be committed by
|
|
||||||
accident. Do not give it a `**/` prefix — that is a `.dockerignore` form
|
|
||||||
and is wrong here.
|
|
||||||
- [ ] `.editorconfig` exists — fetch from
|
- [ ] `.editorconfig` exists — fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.editorconfig`
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.editorconfig`
|
||||||
- [ ] `Dockerfile` and `.dockerignore` exist (fetch `.dockerignore` from
|
- [ ] `Dockerfile` and `.dockerignore` exist; the Dockerfile carries a `lint`
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.dockerignore`);
|
phase and a `test` phase, and the final stage carries a `COPY --from=` of
|
||||||
Dockerfile runs the **non-lint** checks as build steps (`script/test`,
|
a harmless file from each — fetch `.dockerignore` from
|
||||||
`script/fmt-check`), and every stage containing a check-running `RUN`
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.dockerignore`
|
||||||
declares `ARG CHECK_EPOCH` with the `RUN [ -n "$CHECK_EPOCH" ] || exit 1`
|
- [ ] Nothing has been appended after the final stage, and the gate phases are
|
||||||
guard immediately below it — see the `CHECK_EPOCH` rule in
|
reachable from it. A stage nothing depends on is built only when
|
||||||
`REPO_POLICIES.md`. Without them the check layer is served from cache on
|
`--target` names it, so a lost `COPY --from=` edge leaves `docker build .`
|
||||||
an unchanged tree and the build reports a green it never ran.
|
passing while the gate never runs. Confirm by planting a violation, not by
|
||||||
- [ ] The `Dockerfile` no longer runs `make check`, and no longer has a `lint`
|
reading the file.
|
||||||
stage or a `COPY --from=lint ... /dev/null` ordering line. This is the
|
- [ ] The gate phases invoke their tools directly, never through `make lint` or
|
||||||
item an existing repo most often fails: `script/lint` is now a
|
`script/test` — those are themselves a `docker build` and would recurse
|
||||||
`docker build`, so both of those nest a docker build inside a build step.
|
inside a build step
|
||||||
Delete the stage; `script/cibuild` running `script/lint` first is what
|
- [ ] Every depth-independent pattern in `.dockerignore` carries a `**/` prefix,
|
||||||
replaces its fail-fast purpose.
|
only genuinely root-anchored entries such as `.claude` are unprefixed, and
|
||||||
- [ ] `Dockerfile.lint` exists and `script/lint` builds it — see the
|
`.gitignore`'s patterns have not been transplanted unmodified — the
|
||||||
containerised-lint rule in `REPO_POLICIES.md` for the canonical file. Its
|
transplanted form leaves `config/.env` and `certs/server.key` in the build
|
||||||
base image is pinned by sha256 with a version/date comment, it carries
|
context while reading as solved
|
||||||
`ARG CHECK_EPOCH` **after** the dependency layer with the guard below it,
|
|
||||||
and it invokes the linter directly rather than through `make lint`. The
|
|
||||||
arg is named `CHECK_EPOCH` in this file too — a repo that calls it
|
|
||||||
`LINT_EPOCH` here is missed by the grep that checks every build is
|
|
||||||
cache-busted.
|
|
||||||
- [ ] The formatting check runs in exactly one of the two images — either
|
|
||||||
`script/fmt-check` in the `Dockerfile` or the formatter beside the linters
|
|
||||||
in `Dockerfile.lint`, whichever puts it on the pinned toolchain. Neither
|
|
||||||
image running it is the failure to look for here, since moving lint out of
|
|
||||||
the `Dockerfile` is exactly when it gets dropped.
|
|
||||||
- [ ] `.dockerignore` excludes the repo's own host-built artifacts (compiled
|
- [ ] `.dockerignore` excludes the repo's own host-built artifacts (compiled
|
||||||
binaries, test binaries, coverage output), written root-anchored —
|
binaries, test binaries, coverage output), written root-anchored —
|
||||||
`/myapp`, never `**/myapp`, which would also match `cmd/myapp/`. An
|
`/myapp`, never `**/myapp`. An existing repo is where such a binary is
|
||||||
existing repo is where such a binary is likeliest to already be sitting in
|
likeliest to already be sitting in the build context, invisible to git.
|
||||||
the build context, invisible to git.
|
- [ ] `.claude/` is in `.gitignore` (unanchored) and `.claude` in
|
||||||
- [ ] `.dockerignore` excludes `.claude`, root-anchored and with no `**/`
|
`.dockerignore` (anchored, no `**/` prefix). Agent worktrees are entire
|
||||||
prefix. Agent worktrees are entire checkouts of the repo, so they inflate
|
checkouts of the repo, so they inflate the context by a multiple of it and
|
||||||
the context by a multiple of it and can copy another session's unreviewed
|
can copy another session's unreviewed work into an image layer. If agents
|
||||||
work into an image layer — and `Dockerfile.lint` then lints that checkout
|
here run anywhere other than the repo root, the anchored entry misses
|
||||||
as though it were this one, because toolchains discover files by walking
|
`services/api/.claude/`: add anchored entries for those directories.
|
||||||
the tree and never read `.gitignore` (`sneak/quak`: 210 discovered tests
|
- [ ] If the repo embeds a version in a binary: `.dockerignore` lets `.git` into
|
||||||
became 1050). Confirm by enumerating the image, not by reading the file —
|
the build context. It keeps out `.git/config` and each submodule's
|
||||||
`.gitignore` hides these from `git status` too.
|
`config` under `.git/modules/` at any depth (`.git/modules/**/config`),
|
||||||
- [ ] **Do agents in this repo run anywhere other than the repo root?** The
|
which `git describe` does not need and which can hold a credential: a
|
||||||
scratch directory is created in the agent's working directory, so the
|
password in a remote URL, or the token the CI checkout step stores there.
|
||||||
canonical anchored entry misses `services/api/.claude/` in a monorepo with
|
The stage that compiles has `git` (the Debian Go image has it; an alpine
|
||||||
a per-service agent — it still reaches the build context and the image. An
|
one needs `apk add --no-cache git`) and takes the version from the
|
||||||
existing repo is where such a layout already exists, so check it here
|
`VERSION` build argument when one is given, otherwise from
|
||||||
rather than assuming the canonical entry covers you: add anchored entries
|
`git describe --tags --always`. That gives the tag on a tagged commit; on
|
||||||
for the subdirectories that have one (`/services/api/.claude`), or
|
a later commit, the tag, the number of commits since it and the short
|
||||||
`**/.claude` once you have confirmed no legitimately named nested
|
commit (`v1.2.3-4-gabc1234`); and the short commit when no tag is
|
||||||
directory would be caught.
|
reachable. The stage that compiles also marks its working directory safe
|
||||||
- [ ] If the repo embeds a version in a binary, that version is computed on the
|
for git (`git config --system --add safe.directory /src`): a context sent
|
||||||
host and passed with `--build-arg VERSION=...` by `script/docker` and
|
as a tar stream keeps the sender's file owners, and git refuses a checkout
|
||||||
`script/cibuild`. No stage calls `git describe`: `.dockerignore` excludes
|
owned by another user, so the version would come out empty. `ARG VERSION`
|
||||||
`.git`, so it yields an empty version without failing the build. A
|
has no default, and the build fails if the context carries `.git` and the
|
||||||
tag-derived version additionally needs `fetch-depth: 0` on the CI checkout
|
version still comes out empty, `dev` or `unknown`. A plain
|
||||||
step, which clones shallow and fetches no tags by default.
|
`docker build .` with no build arguments must succeed; a Dockerfile that
|
||||||
- [ ] Every depth-independent pattern in `.dockerignore` carries a `**/` prefix;
|
refuses an empty build argument drops that refusal and keeps the argument.
|
||||||
only genuinely root-anchored entries such as `.git` are unprefixed, and
|
`script/docker` and `script/cibuild` pass the version they compute on the
|
||||||
`.gitignore`'s patterns have not been transplanted unmodified.
|
host; it takes precedence. A tag-derived version additionally needs
|
||||||
`.dockerignore` anchors an unprefixed pattern at the context root, so the
|
`fetch-depth: 0` on the CI checkout step, which clones shallow and fetches
|
||||||
transplanted form leaves `config/.env` and `certs/server.key` in the build
|
no tags by default.
|
||||||
context while reading as solved — see the `.dockerignore` rule in
|
|
||||||
`REPO_POLICIES.md`.
|
|
||||||
- [ ] Gitea Actions workflow in `.gitea/workflows/` runs `script/cibuild` on
|
- [ ] Gitea Actions workflow in `.gitea/workflows/` runs `script/cibuild` on
|
||||||
push — reference
|
push — reference
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitea/workflows/check.yml`
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitea/workflows/check.yml`
|
||||||
- [ ] Language-specific config:
|
- [ ] Language-specific config:
|
||||||
- [ ] Go: `go.mod`, `go.sum`, `.golangci.yml` (fetch from
|
- [ ] Go: `go.mod`, `go.sum`, `.golangci.yml` (fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml`)
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml` and,
|
||||||
|
in the same commit, set the lint phase digest to the one named in the
|
||||||
|
`.golangci.yml` paragraph of `REPO_POLICIES.md`)
|
||||||
- [ ] JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
|
- [ ] JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
|
||||||
(fetch from
|
(fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.prettierrc` and
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.prettierrc` and
|
||||||
@@ -122,26 +113,33 @@ with your task.
|
|||||||
`script/install-precommit`, shimmed by `make hooks`) runs it
|
`script/install-precommit`, shimmed by `make hooks`) runs it
|
||||||
- [ ] README has an **Entrypoints** section documenting the `script/`
|
- [ ] README has an **Entrypoints** section documenting the `script/`
|
||||||
entrypoints and linking the standard
|
entrypoints and linking the standard
|
||||||
- [ ] `script/lint` is the canonical container build and nothing else. No host
|
- [ ] `script/lint` and `script/test` build their phase by name
|
||||||
linter invocation survives anywhere in the repo — grep for the linter's
|
(`docker build --no-cache --target <phase> -t <name>-<phase> .`), and no
|
||||||
own name in `script/`, the `Makefile` and CI config, not just in
|
host invocation anywhere in the repo can produce a lint verdict — grep for
|
||||||
`script/lint`. An existing repo is where a second path to the linter is
|
the linter's own name across `script/`, the `Makefile` and CI config, not
|
||||||
likeliest to exist: a `make lint-fast`, a container-versus-host branch, or
|
just `script/lint`. A second path is likeliest here: a `make lint-fast`,
|
||||||
a CI step that calls the binary directly.
|
an older host-versus-container branch, or a CI step calling the binary
|
||||||
- [ ] `script/bootstrap` installs no linter. Delete the golangci-lint install
|
directly. `script/fmt` and `script/fmt-check` are expected hits and stay
|
||||||
block, its version and ref variables, and its call site: nothing invokes a
|
on the host.
|
||||||
host linter any more, so all it can still do is put a differently
|
- [ ] Every `docker build` in `script/` is tagged — an untagged one leaves a
|
||||||
versioned binary where somebody runs it by hand and believes the result.
|
dangling image behind on every run, on every host and CI runner
|
||||||
- [ ] The per-checkout lint state is gone: no `GOLANGCI_LINT_CACHE` or `TMPDIR`
|
- [ ] `script/cibuild` runs `script/bootstrap` before `script/check`, and builds
|
||||||
exports, no `--allow-serial-runners`, and `.lint-cache/` removed from
|
the image with `--no-cache`. Without the bootstrap the CI run dies in
|
||||||
`.gitignore` and `.dockerignore`. A container has its own cache and its
|
`script/fmt-check`, which runs the formatter on the host and finds nothing
|
||||||
own lock, so keeping the wrapper leaves two contradictory `script/lint`
|
installed.
|
||||||
forms in the fleet.
|
- [ ] `script/fmt` and `script/fmt-check` source nvm for the pinned node version
|
||||||
- [ ] `script/cibuild` runs `script/lint` before the main `docker build`.
|
before invoking `yarn`, as `script/bootstrap`'s own install step does.
|
||||||
Without that line CI never lints at all, because the main image
|
`script/bootstrap` leaves the node and yarn it installs off the `PATH` of
|
||||||
deliberately does not.
|
the shell that called it, so a bare `yarn` exits 127 on a runner carrying
|
||||||
|
nothing but docker and git.
|
||||||
|
- [ ] `script/bootstrap` installs no linter of its own — delete the block, its
|
||||||
|
version variables and its call site. A JS repo's `yarn install` stays; it
|
||||||
|
brings a linter along with every other dependency, and no verdict is taken
|
||||||
|
from it.
|
||||||
- [ ] `make check` does not modify any files in the repo
|
- [ ] `make check` does not modify any files in the repo
|
||||||
- [ ] `make test` has a 30-second timeout
|
- [ ] `make test` has a 90-second timeout and completes within the 60-second
|
||||||
|
hard cap (over 20 seconds is green but must be filed as an improvement
|
||||||
|
bug)
|
||||||
- [ ] `make test` runs real tests, not a no-op (at minimum, import/compile
|
- [ ] `make test` runs real tests, not a no-op (at minimum, import/compile
|
||||||
check)
|
check)
|
||||||
- [ ] `make check` passes on current branch
|
- [ ] `make check` passes on current branch
|
||||||
@@ -186,9 +184,10 @@ with your task.
|
|||||||
# Final
|
# Final
|
||||||
|
|
||||||
- [ ] `make check` passes
|
- [ ] `make check` passes
|
||||||
- [ ] `make lint` runs twice on an unchanged tree with the lint layer `DONE`
|
- [ ] `script/cibuild` succeeds in a fresh clone on a host carrying nothing but
|
||||||
both times, never `CACHED` and never sub-second
|
docker and git, with no node or yarn on `PATH`, which is what CI has, and
|
||||||
- [ ] `script/cibuild` succeeds and runs both container builds (a bare
|
demonstrably executed the checks — a sub-second build, or `CACHED` on a
|
||||||
`docker build .` or `docker build -f Dockerfile.lint .` fails closed by
|
gate layer, means nothing ran
|
||||||
design, on the `CHECK_EPOCH` guard)
|
- [ ] A planted lint violation fails both `make lint` and a plain
|
||||||
|
`docker build .`; revert it afterwards
|
||||||
- [ ] Commit and merge fixes before starting your actual task
|
- [ ] Commit and merge fixes before starting your actual task
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Go HTTP Server Conventions
|
title: Go HTTP Server Conventions
|
||||||
last_modified: 2026-08-09
|
last_modified: 2026-10-04
|
||||||
---
|
---
|
||||||
|
|
||||||
This document defines the architectural patterns, design decisions, and
|
This document defines the architectural patterns, design decisions, and
|
||||||
@@ -120,13 +120,11 @@ import (
|
|||||||
var (
|
var (
|
||||||
Appname string = "CHANGEME"
|
Appname string = "CHANGEME"
|
||||||
Version string
|
Version string
|
||||||
Buildarch string
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
globals.Appname = Appname
|
globals.Appname = Appname
|
||||||
globals.Version = Version
|
globals.Version = Version
|
||||||
globals.Buildarch = Buildarch
|
|
||||||
|
|
||||||
fx.New(
|
fx.New(
|
||||||
fx.Provide(
|
fx.Provide(
|
||||||
@@ -826,7 +824,7 @@ func (l *Logger) Identify() {
|
|||||||
l.log.Info("starting",
|
l.log.Info("starting",
|
||||||
"appname", l.params.Globals.Appname,
|
"appname", l.params.Globals.Appname,
|
||||||
"version", l.params.Globals.Version,
|
"version", l.params.Globals.Version,
|
||||||
"buildarch", l.params.Globals.Buildarch,
|
"arch", runtime.GOARCH,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -948,20 +946,17 @@ import "go.uber.org/fx"
|
|||||||
var (
|
var (
|
||||||
Appname string
|
Appname string
|
||||||
Version string
|
Version string
|
||||||
Buildarch string
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// Struct for DI
|
// Struct for DI
|
||||||
type Globals struct {
|
type Globals struct {
|
||||||
Appname string
|
Appname string
|
||||||
Version string
|
Version string
|
||||||
Buildarch string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func New(lc fx.Lifecycle) (*Globals, error) {
|
func New(lc fx.Lifecycle) (*Globals, error) {
|
||||||
n := &Globals{
|
n := &Globals{
|
||||||
Appname: Appname,
|
Appname: Appname,
|
||||||
Buildarch: Buildarch,
|
|
||||||
Version: Version,
|
Version: Version,
|
||||||
}
|
}
|
||||||
return n, nil
|
return n, nil
|
||||||
@@ -975,13 +970,11 @@ func New(lc fx.Lifecycle) (*Globals, error) {
|
|||||||
var (
|
var (
|
||||||
Appname string = "CHANGEME" // Default, overridden by build
|
Appname string = "CHANGEME" // Default, overridden by build
|
||||||
Version string // Set at build time
|
Version string // Set at build time
|
||||||
Buildarch string // Set at build time
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
globals.Appname = Appname
|
globals.Appname = Appname
|
||||||
globals.Version = Version
|
globals.Version = Version
|
||||||
globals.Buildarch = Buildarch
|
|
||||||
// ...
|
// ...
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@@ -991,18 +984,16 @@ func main() {
|
|||||||
Use ldflags to inject version information at build time:
|
Use ldflags to inject version information at build time:
|
||||||
|
|
||||||
```makefile
|
```makefile
|
||||||
# ?= rather than := because this `$(shell git describe ...)` is only correct
|
# ?= rather than := so that a `VERSION` build argument takes precedence:
|
||||||
# on the host: `.dockerignore` excludes `.git`, so evaluated inside a build
|
# where a build stage invokes make, `ARG VERSION` puts it in the
|
||||||
# stage it expands to the empty string without failing and the binary reports
|
# environment and `?=` defers to it. Otherwise `git describe` runs, in a
|
||||||
# no version. The version is computed on the host by `script/docker` /
|
# build stage on the `.git` the build context carries. When it prints
|
||||||
# `script/cibuild` and passed with `--build-arg VERSION=...`; where the build
|
# nothing (outside a git checkout, or where git is missing or refuses the
|
||||||
# stage invokes make, `ARG VERSION` puts it in the environment and `?=` defers
|
# checkout), the version falls back to `dev`.
|
||||||
# to it. See the git-describe rule in REPO_POLICIES.md.
|
VERSION ?= $(or $(shell git describe --tags --always 2>/dev/null),dev)
|
||||||
VERSION ?= $(shell git describe --tags --always)
|
|
||||||
BUILDARCH := $(shell go env GOARCH)
|
|
||||||
|
|
||||||
build:
|
build:
|
||||||
go build -ldflags "-X main.Version=$(VERSION) -X main.Buildarch=$(BUILDARCH)" ./cmd/httpd
|
go build -ldflags "-X main.Version=$(VERSION)" ./cmd/httpd
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: New Repo Checklist
|
title: New Repo Checklist
|
||||||
last_modified: 2026-08-10
|
last_modified: 2026-10-04
|
||||||
---
|
---
|
||||||
|
|
||||||
Use this checklist when creating a new repository from scratch. Follow the steps
|
Use this checklist when creating a new repository from scratch. Follow the steps
|
||||||
@@ -54,6 +54,9 @@ Template files can be fetched from:
|
|||||||
- [ ] `LICENSE` file matching the chosen license
|
- [ ] `LICENSE` file matching the chosen license
|
||||||
- [ ] `REPO_POLICIES.md` — fetch from
|
- [ ] `REPO_POLICIES.md` — fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md`
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md`
|
||||||
|
- [ ] Guidance for coding agents, if the repo has any, is one `AGENTS.md` at the
|
||||||
|
root — never a file or directory named after one agent tool, such as
|
||||||
|
`CLAUDE.md` or `.claude/`, and never separate memory files
|
||||||
- [ ] `Dockerfile` and `.dockerignore` — fetch `.dockerignore` from
|
- [ ] `Dockerfile` and `.dockerignore` — fetch `.dockerignore` from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.dockerignore`
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.dockerignore`
|
||||||
- Extend `.dockerignore` with the repo's own host-built artifacts, giving
|
- Extend `.dockerignore` with the repo's own host-built artifacts, giving
|
||||||
@@ -62,53 +65,46 @@ Template files can be fetched from:
|
|||||||
`cmd/myapp/` and delete the package directory. Do not transplant
|
`cmd/myapp/` and delete the package directory. Do not transplant
|
||||||
`.gitignore`'s patterns: `.dockerignore` anchors an unprefixed pattern at
|
`.gitignore`'s patterns: `.dockerignore` anchors an unprefixed pattern at
|
||||||
the context root, so the copied form leaves `config/.env` in the build
|
the context root, so the copied form leaves `config/.env` in the build
|
||||||
context while reading as solved. See the `.dockerignore` rule in
|
context while reading as solved. The canonical file's `.claude` entry is
|
||||||
`REPO_POLICIES.md`. The canonical file's `.claude` entry is anchored for
|
anchored for the same reason as a repo-root binary; leave it that way, but
|
||||||
the same reason as a repo-root binary; leave it that way, but note it only
|
note that it only covers agents running at the repo root — if this repo
|
||||||
covers agents running at the repo root — if this repo will run them in
|
will run them in subdirectories, `services/api/.claude/` needs its own
|
||||||
subdirectories, `services/api/.claude/` is not excluded and needs its own
|
|
||||||
anchored entry.
|
anchored entry.
|
||||||
- If the image embeds a version in a binary, the version is computed on the
|
- If the image embeds a version in a binary: `.dockerignore` lets `.git`
|
||||||
host and passed with `--build-arg VERSION=...`. `ARG VERSION=dev` is
|
into the build context. It keeps out `.git/config` and each submodule's
|
||||||
declared in the stage that compiles, and **no stage calls `git describe`**
|
`config` under `.git/modules/` at any depth (`.git/modules/**/config`),
|
||||||
— `.dockerignore` excludes `.git`, so it yields an empty version without
|
which `git describe` does not need and which can hold a credential: a
|
||||||
failing the build.
|
password in a remote URL, or the token the CI checkout step stores there.
|
||||||
- The `Dockerfile` runs the **non-lint** checks as build steps —
|
The stage that compiles has `git` (the Debian Go image has it; an alpine
|
||||||
`script/test` and `script/fmt-check`, never `make check`. `script/lint` is
|
one needs `apk add --no-cache git`) and takes the version from the
|
||||||
a `docker build` of `Dockerfile.lint`, so `make check` here nests a build
|
`VERSION` build argument when one is given, otherwise from
|
||||||
inside a build step, where there is no daemon. Put a comment above those
|
`git describe --tags --always`. That gives the tag on a tagged commit; on
|
||||||
`RUN` lines saying so. Every stage containing a check-running `RUN` must
|
a later commit, the tag, the number of commits since it and the short
|
||||||
declare `ARG CHECK_EPOCH` with the `RUN [ -n "$CHECK_EPOCH" ] || exit 1`
|
commit (`v1.2.3-4-gabc1234`); and the short commit when no tag is
|
||||||
guard immediately below it — see the `CHECK_EPOCH` rule in
|
reachable. The stage that compiles also marks its working directory safe
|
||||||
`REPO_POLICIES.md`. Without them the check layer is served from cache on
|
for git (`git config --system --add safe.directory /src`): a context sent
|
||||||
an unchanged tree and the build reports a green it never ran.
|
as a tar stream keeps the sender's file owners, and git refuses a checkout
|
||||||
- Server: also builds and runs the application
|
owned by another user, so the version would come out empty. `ARG VERSION`
|
||||||
- Non-server: brings up dev environment and runs those checks
|
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.
|
||||||
|
- The Dockerfile carries a `lint` phase and a `test` phase, each invoking
|
||||||
|
its tool directly rather than through `make` or `script/`, and the final
|
||||||
|
stage carries a `COPY --from=` of a harmless file from each so the image
|
||||||
|
cannot be built unless both passed. Keep the final stage last: a stage
|
||||||
|
nothing depends on is built only when `--target` names it.
|
||||||
|
- Server: the final stage builds and runs the application
|
||||||
|
- Non-server: the final stage brings up the dev environment
|
||||||
- Image pinned by sha256 hash with version/date comment
|
- Image pinned by sha256 hash with version/date comment
|
||||||
- [ ] `Dockerfile.lint` — the lint-only image that `script/lint` builds. Same
|
|
||||||
`ARG CHECK_EPOCH` + guard + expanded-value discipline as above, with the
|
|
||||||
`ARG` placed **after** the dependency layer so only the lint steps re-run.
|
|
||||||
Base image pinned by sha256 with a version/date comment. Go repos use
|
|
||||||
`golangci/golangci-lint` and run both `golangci-lint config verify` and
|
|
||||||
`golangci-lint run`; other repos use the same pattern around their own
|
|
||||||
linter (eslint, ruff, prettier). Copy the canonical file from
|
|
||||||
`REPO_POLICIES.md`. The linter is invoked directly there, never via
|
|
||||||
`make lint`, which would recurse. The arg keeps the name `CHECK_EPOCH` in
|
|
||||||
this file as well, so one grep covers both builds.
|
|
||||||
- The formatting check runs in exactly one of the two images: either
|
|
||||||
`script/fmt-check` in the `Dockerfile`, or the formatter beside the
|
|
||||||
linters in `Dockerfile.lint` where that is the same pinned dependency.
|
|
||||||
Never neither, never both.
|
|
||||||
- `.dockerignore` must exclude the agent scratch directory before this image
|
|
||||||
is trusted: it lints whatever is in the build context, and toolchains walk
|
|
||||||
the tree rather than reading `.gitignore`, so an agent worktree that
|
|
||||||
reaches the context is linted as though it were the repo.
|
|
||||||
- [ ] Gitea Actions workflow at `.gitea/workflows/check.yml` that runs
|
- [ ] Gitea Actions workflow at `.gitea/workflows/check.yml` that runs
|
||||||
`script/cibuild` on push — reference
|
`script/cibuild` on push — reference
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitea/workflows/check.yml`
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitea/workflows/check.yml`
|
||||||
- [ ] Language-specific:
|
- [ ] Language-specific:
|
||||||
- [ ] Go: `go mod init sneak.berlin/go/<name>`, `.golangci.yml` (fetch from
|
- [ ] Go: `go mod init sneak.berlin/go/<name>`, `.golangci.yml` (fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml`)
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.golangci.yml` and,
|
||||||
|
in the same commit, set the lint phase digest to the one named in the
|
||||||
|
`.golangci.yml` paragraph of `REPO_POLICIES.md`)
|
||||||
- [ ] JS: `yarn init`, `yarn add --dev prettier`
|
- [ ] JS: `yarn init`, `yarn add --dev prettier`
|
||||||
- [ ] Python: `pyproject.toml`
|
- [ ] Python: `pyproject.toml`
|
||||||
|
|
||||||
@@ -127,51 +123,34 @@ are thin shims calling them. Model scripts:
|
|||||||
installs
|
installs
|
||||||
- [ ] `script/setup` / `make setup` — readies a fresh clone: runs `bootstrap`,
|
- [ ] `script/setup` / `make setup` — readies a fresh clone: runs `bootstrap`,
|
||||||
then `install-precommit`, plus repo-specific init
|
then `install-precommit`, plus repo-specific init
|
||||||
- [ ] `script/test` / `make test` — runs real tests, not a no-op (30-second
|
- [ ] `script/test` / `make test` — `docker build --no-cache --target test .`,
|
||||||
timeout)
|
tagged; the phase runs real tests, not a no-op (90-second timeout,
|
||||||
- [ ] `script/lint` / `make lint` — builds `Dockerfile.lint` and nothing else:
|
60-second hard cap on wall time)
|
||||||
`epoch="$(date +%s%N)$$"` on its own line, then
|
- [ ] `script/lint` / `make lint` — `docker build --no-cache --target lint .`,
|
||||||
`docker build --build-arg CHECK_EPOCH="$epoch" -f Dockerfile.lint .`. The
|
tagged. No lint verdict may come from a host invocation of the linter.
|
||||||
linter is never installed on the host and never invoked there. Copy the
|
- [ ] `script/fmt` / `make fmt` — formats code (writes; native, never in a
|
||||||
canonical script from `REPO_POLICIES.md`; it is byte-identical across
|
container)
|
||||||
repos. Without the nonce this script exits 0 on an unchanged tree having
|
- [ ] `script/fmt-check` / `make fmt-check` — checks formatting (read-only;
|
||||||
linted nothing.
|
native)
|
||||||
- [ ] `script/fmt` / `make fmt` — formats code (writes)
|
|
||||||
- [ ] `script/fmt-check` / `make fmt-check` — checks formatting (read-only)
|
|
||||||
- [ ] `script/check` / `make check` — runs `test`, `lint`, `fmt-check`; must not
|
- [ ] `script/check` / `make check` — runs `test`, `lint`, `fmt-check`; must not
|
||||||
modify files. It needs a docker daemon, because `script/lint` is a
|
modify files
|
||||||
container build, and it must never be called from inside a build stage
|
|
||||||
- [ ] `script/projectname` — outputs the project name (used by `script/docker`
|
- [ ] `script/projectname` — outputs the project name (used by `script/docker`
|
||||||
for the image tag)
|
for the image tag)
|
||||||
- [ ] `script/docker` / `make docker` — builds Docker image, tagged via
|
- [ ] `script/docker` / `make docker` — builds Docker image, tagged via
|
||||||
`script/projectname` (byte-identical across repos); carries the same three
|
`script/projectname` (byte-identical across repos); `--no-cache`, plus the
|
||||||
version lines as `script/cibuild` below, and passes
|
version as a build arg
|
||||||
`--build-arg CHECK_EPOCH="$epoch"` and `--build-arg VERSION="$version"`
|
- [ ] `script/cibuild` — cd to repo root, run `script/bootstrap`, run
|
||||||
- [ ] `script/cibuild` — cd to repo root, run `script/lint` **first** for
|
`script/check`, then
|
||||||
fail-fast feedback, then, each on its own line:
|
`docker build --no-cache --build-arg VERSION="$version" .` (what CI runs).
|
||||||
|
The bootstrap is required: CI checks out and runs this alone, and
|
||||||
```sh
|
`script/fmt-check` runs the formatter on the host.
|
||||||
epoch="$(date +%s%N)$$"
|
- [ ] `script/fmt` and `script/fmt-check` source nvm for the pinned node version
|
||||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
before invoking `yarn`, as `script/bootstrap`'s own install step does.
|
||||||
[ -n "$version" ] || version="unknown"
|
`script/bootstrap` leaves the node and yarn it installs off the `PATH` of
|
||||||
docker build \
|
the shell that called it, so a bare `yarn` exits 127 on a runner carrying
|
||||||
--build-arg CHECK_EPOCH="$epoch" \
|
nothing but docker and git.
|
||||||
--build-arg VERSION="$version" \
|
- [ ] Every `docker build` in `script/` is tagged, so no invocation leaves a
|
||||||
.
|
dangling image behind
|
||||||
```
|
|
||||||
|
|
||||||
(what CI runs). The `script/lint` call is not optional: the main image does
|
|
||||||
not lint, so without it CI never lints. Both build args are mandatory, and
|
|
||||||
both assignments must be on their 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 `[ -n "$version" ]` line is a live check
|
|
||||||
that fires on an export with no `.git` and on a repo with no commits — keep
|
|
||||||
it, and do not collapse it into `|| echo unknown`, which makes it
|
|
||||||
unreachable. See the `CHECK_EPOCH` and git-describe rules in
|
|
||||||
`REPO_POLICIES.md` for why each element is load-bearing. A bare
|
|
||||||
`docker build .` fails closed by design, and so does a bare
|
|
||||||
`docker build -f Dockerfile.lint .`.
|
|
||||||
|
|
||||||
- [ ] `script/precommit` — called by the pre-commit hook; runs `script/check`
|
- [ ] `script/precommit` — called by the pre-commit hook; runs `script/check`
|
||||||
- [ ] `script/install-precommit` — installs the pre-commit hook that runs
|
- [ ] `script/install-precommit` — installs the pre-commit hook that runs
|
||||||
`script/precommit`
|
`script/precommit`
|
||||||
@@ -182,12 +161,16 @@ are thin shims calling them. Model scripts:
|
|||||||
# 4. Verify
|
# 4. Verify
|
||||||
|
|
||||||
- [ ] `make check` passes
|
- [ ] `make check` passes
|
||||||
- [ ] `make lint` demonstrably runs the linter rather than returning a cached
|
|
||||||
build: run it twice on an unchanged tree and confirm the lint layer says
|
|
||||||
`DONE`, never `CACHED`, both times
|
|
||||||
- [ ] `make docker` succeeds
|
- [ ] `make docker` succeeds
|
||||||
- [ ] `script/cibuild` succeeds and runs both container builds
|
- [ ] `script/cibuild` succeeds in a fresh clone on a host carrying nothing but
|
||||||
- [ ] No secrets in repo
|
docker and git, with no node or yarn on `PATH`, which is what CI has, and
|
||||||
|
demonstrably executed the checks — a sub-second build, or `CACHED` on a
|
||||||
|
gate layer, means nothing ran
|
||||||
|
- [ ] Plant a lint violation and confirm both `make lint` and a plain
|
||||||
|
`docker build .` fail on it; revert. A plain build that passes proves the
|
||||||
|
final stage is missing its `COPY --from=` edge to the gate phases.
|
||||||
|
- [ ] No secrets in repo, and none in the build context: enumerate a probe image
|
||||||
|
rather than reading `.dockerignore`
|
||||||
- [ ] No mutable image/package references
|
- [ ] No mutable image/package references
|
||||||
- [ ] No unnecessary files in repo root
|
- [ ] No unnecessary files in repo root
|
||||||
- [ ] All dates written as YYYY-MM-DD
|
- [ ] All dates written as YYYY-MM-DD
|
||||||
|
|||||||
+299
-608
File diff suppressed because it is too large
Load Diff
+3
-8
@@ -1,13 +1,8 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/check: run all checks (test, lint, fmt-check). Our own
|
# script/check: run all checks (test, lint, fmt-check). Our own
|
||||||
# extension to scripts-to-rule-them-all. Must not modify any files.
|
# extension to scripts-to-rule-them-all. test and lint are Docker
|
||||||
#
|
# phases; fmt-check is native, because a formatter writes the working
|
||||||
# script/lint is a docker build (see Dockerfile.lint), so this script
|
# tree. Must not modify any files.
|
||||||
# requires a docker daemon. That is deliberate: it is the only way a
|
|
||||||
# developer and the pre-commit hook get the same linter CI gets. It also
|
|
||||||
# means this script must never be run from inside a build stage — see
|
|
||||||
# the comment in Dockerfile, which runs the individual non-lint checks
|
|
||||||
# for exactly that reason.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
|||||||
+14
-26
@@ -1,10 +1,10 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/cibuild: run the CI build. Two container builds, in order:
|
# script/cibuild: run the CI build. It bootstraps first: a CI runner
|
||||||
# script/lint (Dockerfile.lint) and then the main image, which runs the
|
# checks out and runs this and nothing else, and script/fmt-check runs
|
||||||
# non-lint checks. Both only prove anything because each passes its own
|
# the formatter on the host, which a pristine checkout cannot do.
|
||||||
# fresh CHECK_EPOCH nonce: without it Docker serves the check layers
|
# --no-cache for the same reason as script/docker: the gate phases the
|
||||||
# from cache on an unchanged tree and the build exits 0 without running
|
# final stage depends on are RUN steps, and a cached one is a check that
|
||||||
# anything.
|
# did not run.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
@@ -12,29 +12,17 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
# Lint first, for fail-fast feedback: it is its own container build
|
"$SCRIPT_DIR/bootstrap"
|
||||||
# and computes its own CHECK_EPOCH. It runs here rather than inside
|
"$SCRIPT_DIR/check"
|
||||||
# the main image because a docker build cannot run a docker build.
|
# Own line: a failing command substitution inside an argument does
|
||||||
"$SCRIPT_DIR/lint"
|
# not trip `set -e`, so the inline form degrades silently to an
|
||||||
# Assign on its own line: a failing command substitution inside an
|
# empty constant. The VERSION build argument takes precedence over
|
||||||
# argument does not trip `set -e`, which would silently degrade the
|
# the version a build stage derives from the .git in the context.
|
||||||
# nonce to an empty constant. `$$` is required because busybox `date`
|
|
||||||
# drops %N without erroring.
|
|
||||||
epoch="$(date +%s%N)$$"
|
|
||||||
# VERSION must be computed here, on the host: .dockerignore excludes
|
|
||||||
# .git, so `git describe` cannot run in any build stage and fails
|
|
||||||
# quietly there rather than erroring. Same own-line discipline as the
|
|
||||||
# epoch. `|| true` keeps a failing describe from tripping `set -e`
|
|
||||||
# and leaves the value empty; the guard below is then the single
|
|
||||||
# place the fallback is applied, and it does fire — on an export with
|
|
||||||
# no .git, or a repo with no commits yet. `unknown` is visibly wrong
|
|
||||||
# in a binary in a way that an empty version is not.
|
|
||||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||||
[ -n "$version" ] || version="unknown"
|
[ -n "$version" ] || version="unknown"
|
||||||
docker build \
|
docker build --no-cache \
|
||||||
--build-arg CHECK_EPOCH="$epoch" \
|
|
||||||
--build-arg VERSION="$version" \
|
--build-arg VERSION="$version" \
|
||||||
.
|
-t "$("$SCRIPT_DIR/projectname")" .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+8
-19
@@ -1,9 +1,8 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/docker: build the Docker image tagged with the project name.
|
# script/docker: build the Docker image tagged with the project name.
|
||||||
# Identical in all repos; the tag comes from script/projectname. The
|
# Identical in all repos; the tag comes from script/projectname.
|
||||||
# Dockerfile's checks only actually run because CHECK_EPOCH is a fresh
|
# --no-cache because the gate phases the final stage depends on are RUN
|
||||||
# nonce on every invocation; without it a warm cache turns this into a
|
# steps, and a cached one is a check that did not run.
|
||||||
# green that proves nothing.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
@@ -11,23 +10,13 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
# Assign on its own line: a failing command substitution inside an
|
# Own line: a failing command substitution inside an argument does
|
||||||
# argument does not trip `set -e`, which would silently degrade the
|
# not trip `set -e`, so the inline form degrades silently to an
|
||||||
# nonce to an empty constant. `$$` is required because busybox `date`
|
# empty constant. The VERSION build argument takes precedence over
|
||||||
# drops %N without erroring.
|
# the version a build stage derives from the .git in the context.
|
||||||
epoch="$(date +%s%N)$$"
|
|
||||||
# VERSION must be computed here, on the host: .dockerignore excludes
|
|
||||||
# .git, so `git describe` cannot run in any build stage and fails
|
|
||||||
# quietly there rather than erroring. Same own-line discipline as the
|
|
||||||
# epoch. `|| true` keeps a failing describe from tripping `set -e`
|
|
||||||
# and leaves the value empty; the guard below is then the single
|
|
||||||
# place the fallback is applied, and it does fire — on an export with
|
|
||||||
# no .git, or a repo with no commits yet. `unknown` is visibly wrong
|
|
||||||
# in a binary in a way that an empty version is not.
|
|
||||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||||
[ -n "$version" ] || version="unknown"
|
[ -n "$version" ] || version="unknown"
|
||||||
docker build \
|
docker build --no-cache \
|
||||||
--build-arg CHECK_EPOCH="$epoch" \
|
|
||||||
--build-arg VERSION="$version" \
|
--build-arg VERSION="$version" \
|
||||||
-t "$("$SCRIPT_DIR/projectname")" .
|
-t "$("$SCRIPT_DIR/projectname")" .
|
||||||
}
|
}
|
||||||
|
|||||||
+20
-1
@@ -4,9 +4,28 @@ set -eu
|
|||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
# Must match the pin in script/bootstrap.
|
||||||
|
NODE_VERSION="22.17.0"
|
||||||
|
|
||||||
|
# script/bootstrap installs node and yarn under nvm and leaves neither
|
||||||
|
# on the PATH of the shell that called it, so resolve the pinned
|
||||||
|
# toolchain here the way bootstrap's own install step does. nvm is a
|
||||||
|
# bash script, hence the subshell.
|
||||||
|
run_yarn() {
|
||||||
|
if command -v yarn >/dev/null 2>&1; then
|
||||||
|
exec yarn "$@"
|
||||||
|
fi
|
||||||
|
if [ ! -s "$HOME/.nvm/nvm.sh" ]; then
|
||||||
|
echo "fmt: no yarn; run script/bootstrap first" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
exec bash -c '. "$HOME/.nvm/nvm.sh" && nvm use "$1" >/dev/null &&
|
||||||
|
shift && exec yarn "$@"' bash "$NODE_VERSION" "$@"
|
||||||
|
}
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
yarn run prettier --write '**/*.md' --tab-width 4 --prose-wrap always
|
run_yarn run prettier --write '**/*.md' --tab-width 4 --prose-wrap always
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+20
-1
@@ -4,9 +4,28 @@ set -eu
|
|||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
|
# Must match the pin in script/bootstrap.
|
||||||
|
NODE_VERSION="22.17.0"
|
||||||
|
|
||||||
|
# script/bootstrap installs node and yarn under nvm and leaves neither
|
||||||
|
# on the PATH of the shell that called it, so resolve the pinned
|
||||||
|
# toolchain here the way bootstrap's own install step does. nvm is a
|
||||||
|
# bash script, hence the subshell.
|
||||||
|
run_yarn() {
|
||||||
|
if command -v yarn >/dev/null 2>&1; then
|
||||||
|
exec yarn "$@"
|
||||||
|
fi
|
||||||
|
if [ ! -s "$HOME/.nvm/nvm.sh" ]; then
|
||||||
|
echo "fmt-check: no yarn; run script/bootstrap first" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
exec bash -c '. "$HOME/.nvm/nvm.sh" && nvm use "$1" >/dev/null &&
|
||||||
|
shift && exec yarn "$@"' bash "$NODE_VERSION" "$@"
|
||||||
|
}
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
yarn run prettier --check '**/*.md' --tab-width 4 --prose-wrap always
|
run_yarn run prettier --check '**/*.md' --tab-width 4 --prose-wrap always
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+14
-18
@@ -1,27 +1,23 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/lint: run the linter. The linter is never installed on the host
|
# script/lint: run the linter. Linting is a phase of the Dockerfile and
|
||||||
# and never invoked there — it runs in a container, one way, everywhere,
|
# this builds that phase alone; the linter is never installed or run on
|
||||||
# so a run cannot inherit another checkout's cache, another process's
|
# a developer host, where a shared result cache and a host-global lock
|
||||||
# lock, or a host toolchain that differs from the pinned one. Linting
|
# make its answer untrustworthy.
|
||||||
# happens as a build step (see Dockerfile.lint), so a successful build
|
#
|
||||||
# is a clean lint, and it works where the docker daemon is remote and
|
# The phase is not the last stage in the file, so it is built only when
|
||||||
# bind mounts are impossible.
|
# --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
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
# Assign on its own line: a failing command substitution inside an
|
docker build --no-cache \
|
||||||
# argument does not trip `set -e`, which would silently degrade the
|
--target lint \
|
||||||
# nonce to an empty constant. `$$` is required because busybox `date`
|
-t "$("$SCRIPT_DIR/projectname")-lint" .
|
||||||
# drops %N without erroring. Without a fresh nonce the lint layer is
|
|
||||||
# served from cache and this script exits 0 having linted nothing.
|
|
||||||
epoch="$(date +%s%N)$$"
|
|
||||||
docker build \
|
|
||||||
--build-arg CHECK_EPOCH="$epoch" \
|
|
||||||
-f Dockerfile.lint \
|
|
||||||
.
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+10
-3
@@ -1,12 +1,19 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/test: run the test suite.
|
# 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
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
echo "No tests defined."
|
docker build --no-cache \
|
||||||
|
--target test \
|
||||||
|
-t "$("$SCRIPT_DIR/projectname")-test" .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
Reference in New Issue
Block a user