Compare commits
8
Commits
3926fff07e
..
next
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
562b40bfe5 | ||
|
|
5805909fb9 | ||
|
|
3c1b435990 | ||
|
|
5de98c404e | ||
|
|
dcc0ba0b66 | ||
|
|
343628fb3a | ||
|
|
7ea5cdcdcd | ||
|
|
507a57e813 |
@@ -17,7 +17,10 @@
|
|||||||
# stage that compiles runs `git describe --tags --always` on .git, which
|
# stage that compiles runs `git describe --tags --always` on .git, which
|
||||||
# does not need .git/config; that file can hold a credential, such as a
|
# does not need .git/config; that file can hold a credential, such as a
|
||||||
# password in a remote URL or the token the CI checkout step stores there.
|
# password in a remote URL or the token the CI checkout step stores there.
|
||||||
|
# Each submodule keeps a config with the same exposure in its git directory
|
||||||
|
# under .git/modules/, nested again for a submodule's own submodules.
|
||||||
.git/config
|
.git/config
|
||||||
|
.git/modules/**/config
|
||||||
|
|
||||||
# Agent scratch: one full checkout of the repo per in-flight agent.
|
# Agent scratch: one full checkout of the repo per in-flight agent.
|
||||||
# Anchored because it occurs once where agents run at the repo root.
|
# Anchored because it occurs once where agents run at the repo root.
|
||||||
|
|||||||
+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
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ linters:
|
|||||||
disable:
|
disable:
|
||||||
# Genuinely incompatible with project patterns
|
# Genuinely incompatible with project patterns
|
||||||
- exhaustruct # Requires all struct fields
|
- exhaustruct # Requires all struct fields
|
||||||
|
- exhaustruct_v5 # Requires all struct fields (successor to exhaustruct)
|
||||||
- godot # Requires comments to end with periods
|
- godot # Requires comments to end with periods
|
||||||
- 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
|
||||||
|
|||||||
@@ -21,6 +21,48 @@ fmt-check, and commit.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-10-04: `REPO_POLICIES.md` now states that guidance for coding agents
|
||||||
|
lives in one `AGENTS.md` at the repository root, never under a file or
|
||||||
|
directory named after one agent tool and never in separate memory files (issue
|
||||||
|
31). This retires the rule, still present in older vendored copies, that kept
|
||||||
|
agent memory as committed files under `.claude/memory/`. `AGENTS.md` joins the
|
||||||
|
list of files allowed in the root, and both checklists say so.
|
||||||
|
- 2026-10-04: Rewrote the note under the canonical Go `make test` example in
|
||||||
|
`REPO_POLICIES.md` (issue 77), which still named the cache-busting build
|
||||||
|
argument that `--no-cache` replaced. It now says where Go's test result cache
|
||||||
|
can replay a pass: on a developer's machine, where the Makefile target runs,
|
||||||
|
and not in the `test` phase of the `Dockerfile`, whose base image and earlier
|
||||||
|
steps hold no result for the repo's tests.
|
||||||
|
- 2026-10-04: The Makefile examples in the Go styleguide and the HTTP server
|
||||||
|
conventions now fall back to `dev` when `git describe` prints nothing (outside
|
||||||
|
a git checkout, or where git is missing or refuses the checkout), instead of
|
||||||
|
stamping an empty version (issue 74). The canonical `Dockerfile` already fails
|
||||||
|
on a `dev` version when `.git` is in the build context.
|
||||||
|
- 2026-10-04: The canonical `.dockerignore` now also keeps out each submodule's
|
||||||
|
`config` (issue 75). A submodule's git directory lives under `.git/modules/`,
|
||||||
|
nested again for its own submodules, and its `config` can hold a credential
|
||||||
|
just like `.git/config`. The pattern `.git/modules/**/config` covers every
|
||||||
|
depth and leaves the top-level `.git` that `git describe` reads untouched.
|
||||||
|
`REPO_POLICIES.md` and both checklists say so in the same words.
|
||||||
|
- 2026-10-03: Fixed two defects in the canonical Go `Dockerfile` example (issue
|
||||||
|
73). The test phase now uses the Debian Go image, since `-race` needs cgo and
|
||||||
|
the alpine image has no C compiler, so the phase failed before running a test.
|
||||||
|
The stage that compiles runs `git config --system --add safe.directory /src`,
|
||||||
|
because a context sent as a tar stream keeps the sender's file owners and git
|
||||||
|
refuses that checkout, leaving the version empty. Both checklists state that
|
||||||
|
step in the same words.
|
||||||
|
- 2026-10-03: Moved the canonical golangci-lint to v2.14.0, built with go1.27,
|
||||||
|
because v2.12.2 refuses to lint a module whose `go` directive is 1.27 (issue
|
||||||
|
65). Releases from v2.13.0 deprecate `exhaustruct` in favour of
|
||||||
|
`exhaustruct_v5`, which `default: all` switches on, so the canonical
|
||||||
|
`.golangci.yml` now disables `exhaustruct_v5` beside `exhaustruct`. v2.12.2
|
||||||
|
rejects that file, so `REPO_POLICIES.md` and both repo checklists now say a
|
||||||
|
repo sets the lint phase digest and re-vendors `.golangci.yml` in one commit.
|
||||||
|
- 2026-10-03: Brought the canonical `.gitignore` level with `.dockerignore` on
|
||||||
|
secrets (issue 38): it now also ignores `prod.env`-style `*.env` files,
|
||||||
|
`.envrc`, `*.p12`, `*.pfx` and the extensionless SSH private keys, written to
|
||||||
|
`.gitignore`'s own rules (no `**/` prefix) and case-folded with character
|
||||||
|
ranges. `example.env` and `sample.env` stay trackable through negations.
|
||||||
- 2026-10-02: The image version now comes from git inside the build (issues 69
|
- 2026-10-02: The image version now comes from git inside the build (issues 69
|
||||||
and 71), superseding the 2026-09-08 entry that excluded `.git`. The canonical
|
and 71), superseding the 2026-09-08 entry that excluded `.git`. The canonical
|
||||||
`.dockerignore` sends `.git` but keeps out `.git/config`, which can hold a
|
`.dockerignore` sends `.git` but keeps out `.git/config`, which can hold a
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Code Styleguide — Go
|
title: Code Styleguide — Go
|
||||||
last_modified: 2026-10-02
|
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.
|
||||||
@@ -51,8 +51,10 @@ last_modified: 2026-10-02
|
|||||||
# ?= rather than := so that a `VERSION` build argument takes precedence:
|
# ?= rather than := so that a `VERSION` build argument takes precedence:
|
||||||
# where a build stage invokes make, `ARG VERSION` puts it in the
|
# where a build stage invokes make, `ARG VERSION` puts it in the
|
||||||
# environment and `?=` defers to it. Otherwise `git describe` runs, in a
|
# environment and `?=` defers to it. Otherwise `git describe` runs, in a
|
||||||
# build stage on the `.git` the build context carries.
|
# build stage on the `.git` the build context carries. When it prints
|
||||||
VERSION ?= $(shell git describe --tags --always)
|
# nothing (outside a git checkout, or where git is missing or refuses the
|
||||||
|
# checkout), the version falls back to `dev`.
|
||||||
|
VERSION ?= $(or $(shell git describe --tags --always 2>/dev/null),dev)
|
||||||
|
|
||||||
GOLDFLAGS += -X main.Version=$(VERSION)
|
GOLDFLAGS += -X main.Version=$(VERSION)
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Existing Repo Checklist
|
title: Existing Repo Checklist
|
||||||
last_modified: 2026-10-02
|
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,6 +24,10 @@ 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.
|
||||||
@@ -59,28 +63,36 @@ with your task.
|
|||||||
here run anywhere other than the repo root, the anchored entry misses
|
here run anywhere other than the repo root, the anchored entry misses
|
||||||
`services/api/.claude/`: add anchored entries for those directories.
|
`services/api/.claude/`: add anchored entries for those directories.
|
||||||
- [ ] If the repo embeds a version in a binary: `.dockerignore` lets `.git` into
|
- [ ] If the repo embeds a version in a binary: `.dockerignore` lets `.git` into
|
||||||
the build context. It keeps out `.git/config`, which `git describe` does
|
the build context. It keeps out `.git/config` and each submodule's
|
||||||
not need and which can hold a credential: a password in a remote URL, or
|
`config` under `.git/modules/` at any depth (`.git/modules/**/config`),
|
||||||
the token the CI checkout step stores there. The stage that compiles has
|
which `git describe` does not need and which can hold a credential: a
|
||||||
`git` (the Debian Go image has it; an alpine one needs
|
password in a remote URL, or the token the CI checkout step stores there.
|
||||||
`apk add --no-cache git`) and takes the version from the `VERSION` build
|
The stage that compiles has `git` (the Debian Go image has it; an alpine
|
||||||
argument when one is given, otherwise from `git describe --tags --always`.
|
one needs `apk add --no-cache git`) and takes the version from the
|
||||||
That gives the tag on a tagged commit; on a later commit, the tag, the
|
`VERSION` build argument when one is given, otherwise from
|
||||||
number of commits since it and the short commit (`v1.2.3-4-gabc1234`); and
|
`git describe --tags --always`. That gives the tag on a tagged commit; on
|
||||||
the short commit when no tag is reachable. `ARG VERSION` has no default,
|
a later commit, the tag, the number of commits since it and the short
|
||||||
and the build fails if the context carries `.git` and the version still
|
commit (`v1.2.3-4-gabc1234`); and the short commit when no tag is
|
||||||
comes out empty, `dev` or `unknown`. A plain `docker build .` with no
|
reachable. The stage that compiles also marks its working directory safe
|
||||||
build arguments must succeed; a Dockerfile that refuses an empty build
|
for git (`git config --system --add safe.directory /src`): a context sent
|
||||||
argument drops that refusal and keeps the argument. `script/docker` and
|
as a tar stream keeps the sender's file owners, and git refuses a checkout
|
||||||
`script/cibuild` pass the version they compute on the host; it takes
|
owned by another user, so the version would come out empty. `ARG VERSION`
|
||||||
precedence. A tag-derived version additionally needs `fetch-depth: 0` on
|
has no default, and the build fails if the context carries `.git` and the
|
||||||
the CI checkout step, which clones shallow and fetches no tags by default.
|
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.
|
||||||
|
`script/docker` and `script/cibuild` pass the version they compute on the
|
||||||
|
host; it takes precedence. A tag-derived version additionally needs
|
||||||
|
`fetch-depth: 0` on the CI checkout step, which clones shallow and fetches
|
||||||
|
no tags by default.
|
||||||
- [ ] 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
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Go HTTP Server Conventions
|
title: Go HTTP Server Conventions
|
||||||
last_modified: 2026-10-02
|
last_modified: 2026-10-04
|
||||||
---
|
---
|
||||||
|
|
||||||
This document defines the architectural patterns, design decisions, and
|
This document defines the architectural patterns, design decisions, and
|
||||||
@@ -987,8 +987,10 @@ Use ldflags to inject version information at build time:
|
|||||||
# ?= rather than := so that a `VERSION` build argument takes precedence:
|
# ?= rather than := so that a `VERSION` build argument takes precedence:
|
||||||
# where a build stage invokes make, `ARG VERSION` puts it in the
|
# where a build stage invokes make, `ARG VERSION` puts it in the
|
||||||
# environment and `?=` defers to it. Otherwise `git describe` runs, in a
|
# environment and `?=` defers to it. Otherwise `git describe` runs, in a
|
||||||
# build stage on the `.git` the build context carries.
|
# build stage on the `.git` the build context carries. When it prints
|
||||||
VERSION ?= $(shell git describe --tags --always)
|
# nothing (outside a git checkout, or where git is missing or refuses the
|
||||||
|
# checkout), the version falls back to `dev`.
|
||||||
|
VERSION ?= $(or $(shell git describe --tags --always 2>/dev/null),dev)
|
||||||
|
|
||||||
build:
|
build:
|
||||||
go build -ldflags "-X main.Version=$(VERSION)" ./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-10-02
|
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
|
||||||
@@ -68,19 +71,24 @@ Template files can be fetched from:
|
|||||||
will run them in subdirectories, `services/api/.claude/` needs its own
|
will run them in subdirectories, `services/api/.claude/` needs its own
|
||||||
anchored entry.
|
anchored entry.
|
||||||
- If the image embeds a version in a binary: `.dockerignore` lets `.git`
|
- If the image embeds a version in a binary: `.dockerignore` lets `.git`
|
||||||
into the build context. It keeps out `.git/config`, which `git describe`
|
into the build context. It keeps out `.git/config` and each submodule's
|
||||||
does not need and which can hold a credential: a password in a remote URL,
|
`config` under `.git/modules/` at any depth (`.git/modules/**/config`),
|
||||||
or the token the CI checkout step stores there. The stage that compiles
|
which `git describe` does not need and which can hold a credential: a
|
||||||
has `git` (the Debian Go image has it; an alpine one needs
|
password in a remote URL, or the token the CI checkout step stores there.
|
||||||
`apk add --no-cache git`) and takes the version from the `VERSION` build
|
The stage that compiles has `git` (the Debian Go image has it; an alpine
|
||||||
argument when one is given, otherwise from `git describe --tags --always`.
|
one needs `apk add --no-cache git`) and takes the version from the
|
||||||
That gives the tag on a tagged commit; on a later commit, the tag, the
|
`VERSION` build argument when one is given, otherwise from
|
||||||
number of commits since it and the short commit (`v1.2.3-4-gabc1234`); and
|
`git describe --tags --always`. That gives the tag on a tagged commit; on
|
||||||
the short commit when no tag is reachable. `ARG VERSION` has no default,
|
a later commit, the tag, the number of commits since it and the short
|
||||||
and the build fails if the context carries `.git` and the version still
|
commit (`v1.2.3-4-gabc1234`); and the short commit when no tag is
|
||||||
comes out empty, `dev` or `unknown`. A plain `docker build .` with no
|
reachable. The stage that compiles also marks its working directory safe
|
||||||
build arguments must succeed; a Dockerfile that refuses an empty build
|
for git (`git config --system --add safe.directory /src`): a context sent
|
||||||
argument drops that refusal and keeps the argument.
|
as a tar stream keeps the sender's file owners, and git refuses a checkout
|
||||||
|
owned by another user, so the version would come out empty. `ARG VERSION`
|
||||||
|
has no default, and the build fails if the context carries `.git` and the
|
||||||
|
version still comes out empty, `dev` or `unknown`. A plain
|
||||||
|
`docker build .` with no build arguments must succeed; a Dockerfile that
|
||||||
|
refuses an empty build argument drops that refusal and keeps the argument.
|
||||||
- The Dockerfile carries a `lint` phase and a `test` phase, each invoking
|
- The Dockerfile carries a `lint` phase and a `test` phase, each invoking
|
||||||
its tool directly rather than through `make` or `script/`, and the final
|
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
|
stage carries a `COPY --from=` of a harmless file from each so the image
|
||||||
@@ -94,7 +102,9 @@ Template files can be fetched from:
|
|||||||
`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`
|
||||||
|
|
||||||
|
|||||||
+55
-36
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Repository Policies
|
title: Repository Policies
|
||||||
last_modified: 2026-10-02
|
last_modified: 2026-10-04
|
||||||
---
|
---
|
||||||
|
|
||||||
This document covers repository structure, tooling, and workflow standards. Code
|
This document covers repository structure, tooling, and workflow standards. Code
|
||||||
@@ -160,7 +160,7 @@ style conventions are in separate documents:
|
|||||||
- **The gate phases are separate stages, and the build stage depends on both.**
|
- **The gate phases are separate stages, and the build stage depends on both.**
|
||||||
The lint phase is based on the `golangci/golangci-lint` image (pinned by
|
The lint phase is based on the `golangci/golangci-lint` image (pinned by
|
||||||
hash), so lint failures surface in seconds rather than after a full compile,
|
hash), so lint failures surface in seconds rather than after a full compile,
|
||||||
and the test phase is based on the Go image. The canonical Go repo
|
and the test phase is based on the Debian Go image. The canonical Go repo
|
||||||
`Dockerfile`:
|
`Dockerfile`:
|
||||||
|
|
||||||
```dockerfile
|
```dockerfile
|
||||||
@@ -173,8 +173,9 @@ style conventions are in separate documents:
|
|||||||
COPY . .
|
COPY . .
|
||||||
RUN golangci-lint run --config .golangci.yml ./...
|
RUN golangci-lint run --config .golangci.yml ./...
|
||||||
|
|
||||||
# Test phase
|
# Test phase. -race needs cgo and so a C compiler, which the Debian Go
|
||||||
# golang:1.x-alpine, YYYY-MM-DD
|
# image ships and the alpine one does not.
|
||||||
|
# golang:1.x, YYYY-MM-DD
|
||||||
FROM golang@sha256:... AS test
|
FROM golang@sha256:... AS test
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
@@ -192,6 +193,8 @@ style conventions are in separate documents:
|
|||||||
COPY --from=lint /src/go.sum /dev/null
|
COPY --from=lint /src/go.sum /dev/null
|
||||||
COPY --from=test /src/go.sum /dev/null
|
COPY --from=test /src/go.sum /dev/null
|
||||||
RUN apk add --no-cache git
|
RUN apk add --no-cache git
|
||||||
|
# A tar-stream context keeps the sender's file owners, which git refuses.
|
||||||
|
RUN git config --system --add safe.directory /src
|
||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
@@ -236,19 +239,23 @@ style conventions are in separate documents:
|
|||||||
- If the project requires CGO or system libraries for linting (e.g.
|
- If the project requires CGO or system libraries for linting (e.g.
|
||||||
`vips-dev`), install them in the lint phase with `apk add`.
|
`vips-dev`), install them in the lint phase with `apk add`.
|
||||||
- `.dockerignore` lets `.git` into the build context. It keeps out
|
- `.dockerignore` lets `.git` into the build context. It keeps out
|
||||||
`.git/config`, which `git describe` does not need and which can hold a
|
`.git/config` and each submodule's `config` under `.git/modules/` at any
|
||||||
credential: a password in a remote URL, or the token the CI checkout step
|
depth (`.git/modules/**/config`), which `git describe` does not need and
|
||||||
stores there. The stage that compiles has `git` (the Debian Go image has
|
which can hold a credential: a password in a remote URL, or the token the
|
||||||
it; an alpine one needs `apk add --no-cache git`) and takes the version
|
CI checkout step stores there. The stage that compiles has `git` (the
|
||||||
from the `VERSION` build argument when one is given, otherwise from
|
Debian Go image has it; an alpine one needs `apk add --no-cache git`) and
|
||||||
`git describe --tags --always`. That gives the tag on a tagged commit; on
|
takes the version from the `VERSION` build argument when one is given,
|
||||||
a later commit, the tag, the number of commits since it and the short
|
otherwise from `git describe --tags --always`. That gives the tag on a
|
||||||
commit (`v1.2.3-4-gabc1234`); and the short commit when no tag is
|
tagged commit; on a later commit, the tag, the number of commits since it
|
||||||
reachable. `ARG VERSION` has no default, and the build fails if the
|
and the short commit (`v1.2.3-4-gabc1234`); and the short commit when no
|
||||||
context carries `.git` and the version still comes out empty, `dev` or
|
tag is reachable. The stage that compiles also marks its working directory
|
||||||
`unknown`. A plain `docker build .` with no build arguments must succeed;
|
safe for git (`git config --system --add safe.directory /src`): a context
|
||||||
a Dockerfile that refuses an empty build argument drops that refusal and
|
sent as a tar stream keeps the sender's file owners, and git refuses a
|
||||||
keeps the argument.
|
checkout owned by another user, so the version would come out empty.
|
||||||
|
`ARG VERSION` has no default, and the build fails if the context carries
|
||||||
|
`.git` and the version still comes out empty, `dev` or `unknown`. A plain
|
||||||
|
`docker build .` with no build arguments must succeed; a Dockerfile that
|
||||||
|
refuses an empty build argument drops that refusal and keeps the argument.
|
||||||
|
|
||||||
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
|
- Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that
|
||||||
runs `script/cibuild` on push, and checks out the repo as its only other step.
|
runs `script/cibuild` on push, and checks out the repo as its only other step.
|
||||||
@@ -310,17 +317,19 @@ style conventions are in separate documents:
|
|||||||
```
|
```
|
||||||
|
|
||||||
`-count=1` is required on both invocations: it defeats Go's test _result_
|
`-count=1` is required on both invocations: it defeats Go's test _result_
|
||||||
cache, so the target cannot report a pass it did not earn, and the rerun
|
cache, so neither run can report a stored pass in place of running the
|
||||||
reproduces a failure instead of replaying it. It leaves the build cache
|
tests. It leaves the build cache alone, so it costs the runtime of the suite
|
||||||
alone, so it costs the runtime of the suite and no recompilation.
|
and no recompilation.
|
||||||
|
|
||||||
Note that this is a second, independent cache, stacked below the Docker
|
That cache is Go's own, separate from Docker's layer cache. Go stores a
|
||||||
layer cache that [issue #26](https://git.eeqj.de/sneak/prompts/issues/26)
|
passing result in its cache directory (`GOCACHE`), and when the same tests
|
||||||
addresses. `CHECK_EPOCH` guarantees the `RUN make test` _step_ re-executes;
|
run again on unchanged code it prints that result, marked `(cached)`,
|
||||||
it does not guarantee `go test` inside that step does any work, because the
|
without running them. That matters on a developer's machine, where this
|
||||||
`GOCACHE` baked into earlier image layers survives into the re-executed
|
target runs and the directory lasts from one run to the next. The `test`
|
||||||
step. They are two separate defects requiring two separate fixes, and a fix
|
phase of the `Dockerfile` needs no `-count=1`: its base image holds no
|
||||||
for one must not be recorded as covering the other.
|
result for this repo's tests and nothing before its `go test` step runs a
|
||||||
|
test, so there is nothing to replay. `--no-cache` (above) is what makes that
|
||||||
|
step run on an unchanged tree.
|
||||||
|
|
||||||
Python example:
|
Python example:
|
||||||
|
|
||||||
@@ -451,12 +460,18 @@ style conventions are in separate documents:
|
|||||||
`test-support` depguard rule, where a repo names its own test-support packages
|
`test-support` depguard rule, where a repo names its own test-support packages
|
||||||
by full import path. A repo adds entries there and changes nothing else, and a
|
by full import path. A repo adds entries there and changes nothing else, and a
|
||||||
re-vendor carries its entries forward. The canonical golangci-lint version is
|
re-vendor carries its entries forward. The canonical golangci-lint version is
|
||||||
v2.12.2 (released 2026-05-06), pinned as the digest of the lint phase's base
|
v2.14.0 (released 2026-09-24), pinned as the digest of the lint phase's base
|
||||||
image
|
image
|
||||||
(`golangci/golangci-lint@sha256:5cceeef04e53efe1470638d4b4b4f5ceefd574955ab3941b2d9a68a8c9ad5240`,
|
(`golangci/golangci-lint@sha256:ad862ba6b3798cbe0fd9fd7408d498fd74fbd2623a92406b2fd3898faf0bf98f`,
|
||||||
which reports `2.12.2 built with go1.26.2 from c0d3ddc9`). That digest is the
|
which reports `2.14.0 built with go1.27.0 from 114493f9`). A module's `go`
|
||||||
only pin, since no repo installs golangci-lint on the host: bumping the
|
directive must not name a newer Go minor version than the one golangci-lint
|
||||||
version means changing it and nothing else.
|
was built with, or golangci-lint refuses to lint it: this release lints
|
||||||
|
`go 1.27.1` but not `go 1.28`. That digest is the only pin, since no repo
|
||||||
|
installs golangci-lint on the host. A repo sets the lint phase digest to the
|
||||||
|
one named here and re-vendors `.golangci.yml` in the same commit, whichever of
|
||||||
|
the two prompted the change: the canonical copy can name linters that an older
|
||||||
|
golangci-lint rejects, and a newer golangci-lint can add linters that
|
||||||
|
`default: all` switches on until the canonical copy disables them.
|
||||||
|
|
||||||
- **`script/bootstrap` installs a pinned tool by comparing versions, never by
|
- **`script/bootstrap` installs a pinned tool by comparing versions, never by
|
||||||
testing presence.** An `if ! command -v <tool>; then install; fi` guard tests
|
testing presence.** An `if ! command -v <tool>; then install; fi` guard tests
|
||||||
@@ -592,10 +607,10 @@ style conventions are in separate documents:
|
|||||||
settings.
|
settings.
|
||||||
|
|
||||||
- Avoid putting files in the repo root unless necessary. Root should contain
|
- Avoid putting files in the repo root unless necessary. Root should contain
|
||||||
only project-level config files (`README.md`, `Makefile`, `Dockerfile`,
|
only project-level config files (`README.md`, `AGENTS.md`, `Makefile`,
|
||||||
`LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`, and
|
`Dockerfile`, `LICENSE`, `.gitignore`, `.editorconfig`, `REPO_POLICIES.md`,
|
||||||
language-specific config). Everything else goes in a subdirectory. Canonical
|
and language-specific config). Everything else goes in a subdirectory.
|
||||||
subdirectory names:
|
Canonical subdirectory names:
|
||||||
- `bin/` — executable scripts and tools
|
- `bin/` — executable scripts and tools
|
||||||
- `cmd/` — Go command entrypoints; thin only: one `main.go` per binary whose
|
- `cmd/` — Go command entrypoints; thin only: one `main.go` per binary whose
|
||||||
body is a single call into `internal/` or `pkg/`, no project logic in
|
body is a single call into `internal/` or `pkg/`, no project logic in
|
||||||
@@ -626,3 +641,7 @@ style conventions are in separate documents:
|
|||||||
- Go: `go.mod`, `go.sum`, `.golangci.yml`
|
- Go: `go.mod`, `go.sum`, `.golangci.yml`
|
||||||
- JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
|
- JS: `package.json`, `yarn.lock`, `.prettierrc`, `.prettierignore`
|
||||||
- Python: `pyproject.toml`
|
- Python: `pyproject.toml`
|
||||||
|
|
||||||
|
- Guidance for coding agents lives in one `AGENTS.md` at the repository root. It
|
||||||
|
is never committed under a file or directory named after one agent tool, such
|
||||||
|
as `CLAUDE.md` or `.claude/`, and never split into separate memory files.
|
||||||
|
|||||||
Reference in New Issue
Block a user