Compare commits
1
Commits
next
..
bffb2fbbfd
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bffb2fbbfd |
+3
-12
@@ -18,16 +18,9 @@
|
|||||||
# 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
|
# Each submodule keeps a config with the same exposure in its git directory
|
||||||
# under .git/modules/, nested again for a submodule's own submodules, or in
|
# under .git/modules/, nested again for a submodule's own submodules.
|
||||||
# its own .git directory when it keeps one.
|
.git/config
|
||||||
# KNOWN GAP: a submodule whose name has a `config` segment (`config`,
|
.git/modules/**/config
|
||||||
# `deploy/config`, `config/lib`) loses its whole git directory, because
|
|
||||||
# `**/.git/modules/**/config` also matches that segment's directory
|
|
||||||
# under .git/modules/. Go's version stamping then fails the build;
|
|
||||||
# nothing leaks. Name such a submodule without that segment:
|
|
||||||
# `git submodule add --name`.
|
|
||||||
**/.git/config
|
|
||||||
**/.git/modules/**/config
|
|
||||||
|
|
||||||
# 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.
|
||||||
@@ -51,9 +44,7 @@
|
|||||||
**/[iI][dD]_[rR][sS][aA]
|
**/[iI][dD]_[rR][sS][aA]
|
||||||
**/[iI][dD]_[dD][sS][aA]
|
**/[iI][dD]_[dD][sS][aA]
|
||||||
**/[iI][dD]_[eE][cC][dD][sS][aA]
|
**/[iI][dD]_[eE][cC][dD][sS][aA]
|
||||||
**/[iI][dD]_[eE][cC][dD][sS][aA]_[sS][kK]
|
|
||||||
**/[iI][dD]_[eE][dD]25519
|
**/[iI][dD]_[eE][dD]25519
|
||||||
**/[iI][dD]_[eE][dD]25519_[sS][kK]
|
|
||||||
|
|
||||||
# Dependencies: restored inside the image, never copied in.
|
# Dependencies: restored inside the image, never copied in.
|
||||||
**/node_modules
|
**/node_modules
|
||||||
|
|||||||
@@ -10,9 +10,3 @@ insert_final_newline = true
|
|||||||
|
|
||||||
[Makefile]
|
[Makefile]
|
||||||
indent_style = tab
|
indent_style = tab
|
||||||
|
|
||||||
[*.go]
|
|
||||||
indent_style = tab
|
|
||||||
|
|
||||||
# This repository's own sections, such as one for another language it
|
|
||||||
# uses, go below this comment, and a re-vendor keeps them.
|
|
||||||
|
|||||||
@@ -1,4 +0,0 @@
|
|||||||
# Every PR adds an entry at the top of TODO.md's Completed Steps; union keeps
|
|
||||||
# both sides instead of conflicting. Git never reports a conflict here: read
|
|
||||||
# the merged entries after every merge or rebase.
|
|
||||||
TODO.md merge=union
|
|
||||||
@@ -1,16 +1,9 @@
|
|||||||
name: check
|
name: check
|
||||||
on: [push]
|
on: [push]
|
||||||
# Free the shared runner: a new push cancels only the same branch's older run.
|
|
||||||
concurrency:
|
|
||||||
group: ${{ github.workflow }}-${{ github.ref }}
|
|
||||||
cancel-in-progress: true
|
|
||||||
jobs:
|
jobs:
|
||||||
check:
|
check:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
# actions/checkout v4.2.2, 2026-02-22
|
# actions/checkout v4.2.2, 2026-02-22
|
||||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
||||||
# script/cibuild needs no token, so none is left in .git/config.
|
|
||||||
with:
|
|
||||||
persist-credentials: false
|
|
||||||
- run: script/cibuild
|
- run: script/cibuild
|
||||||
|
|||||||
+1
-7
@@ -27,7 +27,7 @@ node_modules/
|
|||||||
# Environment files. `*.env` covers bare `.env` and the `prod.env`
|
# Environment files. `*.env` covers bare `.env` and the `prod.env`
|
||||||
# convention. Only the templates `example.env` and `sample.env` are
|
# convention. Only the templates `example.env` and `sample.env` are
|
||||||
# re-included below. A repository that commits any other template adds
|
# re-included below. A repository that commits any other template adds
|
||||||
# its own negation at the end of this file, for example `!.env.example`.
|
# its own negation after these lines, for example `!.env.example`.
|
||||||
*.[eE][nN][vV]
|
*.[eE][nN][vV]
|
||||||
.[eE][nN][vV].*
|
.[eE][nN][vV].*
|
||||||
.[eE][nN][vV][rR][cC]
|
.[eE][nN][vV][rR][cC]
|
||||||
@@ -42,10 +42,4 @@ node_modules/
|
|||||||
[iI][dD]_[rR][sS][aA]
|
[iI][dD]_[rR][sS][aA]
|
||||||
[iI][dD]_[dD][sS][aA]
|
[iI][dD]_[dD][sS][aA]
|
||||||
[iI][dD]_[eE][cC][dD][sS][aA]
|
[iI][dD]_[eE][cC][dD][sS][aA]
|
||||||
[iI][dD]_[eE][cC][dD][sS][aA]_[sS][kK]
|
|
||||||
[iI][dD]_[eE][dD]25519
|
[iI][dD]_[eE][dD]25519
|
||||||
[iI][dD]_[eE][dD]25519_[sS][kK]
|
|
||||||
|
|
||||||
# This repository's own entries, such as its build outputs, go below
|
|
||||||
# this comment, and a re-vendor keeps them. Anchor a binary built at the
|
|
||||||
# root: `/myapp`, never `myapp`, which also ignores `cmd/myapp/`.
|
|
||||||
|
|||||||
@@ -25,8 +25,6 @@ linters:
|
|||||||
# silenced by disabling that name, not by enabling the successor.
|
# silenced by disabling that name, not by enabling the successor.
|
||||||
- wsl # Deprecated, replaced by wsl_v5
|
- wsl # Deprecated, replaced by wsl_v5
|
||||||
- gomodguard # Deprecated, replaced by gomodguard_v2
|
- gomodguard # Deprecated, replaced by gomodguard_v2
|
||||||
# Misses findings at random in v2.14.0; back once a pinned release fixes it
|
|
||||||
- canonicalheader
|
|
||||||
settings:
|
settings:
|
||||||
lll:
|
lll:
|
||||||
line-length: 88
|
line-length: 88
|
||||||
|
|||||||
@@ -21,114 +21,12 @@ fmt-check, and commit.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-10-06: `REPO_POLICIES.md` and both checklists now say that a checkout
|
|
||||||
whose `.git` is a file, a linked worktree or a repository checked out as a
|
|
||||||
submodule, is the exception to a plain `docker build .` succeeding (issue
|
|
||||||
111): that file points to a git directory outside the build context, so the
|
|
||||||
build cannot read the version and the version check in the canonical
|
|
||||||
`Dockerfile` stops it. Such a build is given its version with
|
|
||||||
`--build-arg VERSION=...`, as `script/docker` and `script/cibuild` already do.
|
|
||||||
The check itself is unchanged.
|
|
||||||
- 2026-10-06: The canonical `.gitea/workflows/check.yml` now has a `concurrency`
|
|
||||||
block, so a new push cancels the older run on the same branch and no other,
|
|
||||||
and its checkout step sets `persist-credentials: false`, so the job's token is
|
|
||||||
not left in `.git/config` (issue 107). `REPO_POLICIES.md` and both checklists
|
|
||||||
describe the workflow as it now is. Not yet tried on the shared runner, which
|
|
||||||
is out of disk space. Repositories pick this up on their next re-vendor.
|
|
||||||
- 2026-10-06: The canonical `.golangci.yml` now disables `canonicalheader`
|
|
||||||
(issue 105). In golangci-lint v2.14.0 it misses findings at random in a
|
|
||||||
package that also calls `ResponseWriter.Header()`, so the same tree can fail
|
|
||||||
lint on one run and pass on the next. It comes back once a pinned
|
|
||||||
golangci-lint release fixes it.
|
|
||||||
- 2026-10-06: The canonical `.gitignore` and `.editorconfig` now each end with a
|
|
||||||
comment saying the repository's own entries go below it and a re-vendor keeps
|
|
||||||
them (issue 103, which took in issue 104), as `.dockerignore`'s header already
|
|
||||||
does. `.editorconfig` gains a `[*.go]` section with tabs, since `gofmt`
|
|
||||||
decides Go indentation everywhere. `REPO_POLICIES.md` and both checklists say
|
|
||||||
that each of these two files is the canonical content followed by the
|
|
||||||
repository's own entries, which a re-vendor keeps, and the Go styleguide puts
|
|
||||||
`*.log`, `*.out`, `*.test` and binaries among those entries. Common outputs
|
|
||||||
stay out of the canonical `.gitignore`; each repository lists its own.
|
|
||||||
- 2026-10-05: `script/cibuild`, `script/docker`, `script/lint` and `script/test`
|
|
||||||
now assign the image tag from `script/projectname` on its own line before the
|
|
||||||
`docker build` (issue 101), so `set -e` stops the script where
|
|
||||||
`script/projectname` fails instead of running `docker build` with a broken
|
|
||||||
tag. The comment above it in each script says why, and the snippets in
|
|
||||||
`REPO_POLICIES.md` show the same form. Repositories pick this up on their next
|
|
||||||
re-vendor.
|
|
||||||
- 2026-10-04: Went through the fleet findings recorded on 2026-08-09 (issue 62)
|
|
||||||
and added the two rules `REPO_POLICIES.md` did not yet state: a new or changed
|
|
||||||
check is proven by planting a defect it must catch; and a change to a separate
|
|
||||||
workflow limited to `main` is first run from the feature branch, added to that
|
|
||||||
workflow's `branches` list and removed again before merging. The other
|
|
||||||
findings were already stated, replaced by `--no-cache`, about git worktrees,
|
|
||||||
or about how agents work together. The warning against
|
|
||||||
`golangci-lint config verify` is dropped because sneak ruled on
|
|
||||||
https://git.eeqj.de/sneak/prompts/issues/40 (2026-08-10) that there is no
|
|
||||||
config check step and the config is assumed valid; a vendored `.golangci.yml`
|
|
||||||
stays byte-identical to the canonical copy. The issue gives each reason.
|
|
||||||
- 2026-10-04: `REPO_POLICIES.md` now says which `Dockerfile` stages run
|
|
||||||
`script/bootstrap` (issue 90). The gate phases and the build stage start from
|
|
||||||
their pinned base images and install what those images lack either inline, as
|
|
||||||
the canonical Go `Dockerfile` does for `git`, or by running
|
|
||||||
`script/bootstrap`, as this repo's own `Dockerfile` does for its yarn
|
|
||||||
packages. The development environment stage, the final stage of a non-server
|
|
||||||
repo, runs `script/bootstrap`. The new repo checklist says the same.
|
|
||||||
- 2026-10-04: Added a root `.gitattributes` that merges `TODO.md` with git's
|
|
||||||
union merge (issue 98), so two branches that each add an entry at the top of
|
|
||||||
Completed Steps merge without a conflict. Git now never reports a conflict in
|
|
||||||
`TODO.md`: a real conflict elsewhere keeps both versions of the line, and when
|
|
||||||
two new entries share an identical line, one is inserted into the middle of
|
|
||||||
the other, which a rebase can do to an entry already on `next`. Read the
|
|
||||||
merged entries after every merge or rebase. This applies to this repository
|
|
||||||
only; no canonical file changed.
|
|
||||||
- 2026-10-04: The canonical `.dockerignore` now also keeps out the git `config`
|
|
||||||
of a submodule that keeps its own `.git` directory, which still reached the
|
|
||||||
image (issue 88): both git patterns now carry the `**/` prefix. A submodule
|
|
||||||
whose name has a `config` segment (`config`, `deploy/config`, `config/lib`)
|
|
||||||
still loses its whole git directory, so Go's version stamping fails the build;
|
|
||||||
the file records this as a `KNOWN GAP:` with the remedy,
|
|
||||||
`git submodule add --name`. Closing it would take a wildcard re-include, which
|
|
||||||
makes BuildKit walk every excluded directory, such as `node_modules`, on every
|
|
||||||
build. `REPO_POLICIES.md` and both checklists say so in the same words.
|
|
||||||
- 2026-10-04: The note under the canonical Go `Dockerfile` example in
|
|
||||||
`REPO_POLICIES.md` now installs lint-phase system libraries with `apt-get`
|
|
||||||
under their Debian package names (issue 83). The `golangci/golangci-lint`
|
|
||||||
image is Debian-based and has no `apk`, so the old `apk add` instruction
|
|
||||||
failed as written. Nothing is pinned or unpinned; that is still open on
|
|
||||||
issue 72.
|
|
||||||
- 2026-10-04: Fixed the server lifecycle example in
|
|
||||||
`prompts/GO_HTTP_SERVER_CONVENTIONS.md` (issue 86). Only fx handles SIGINT and
|
|
||||||
SIGTERM, and `Run()` in `main` exits with the shutdown's exit code. A listen
|
|
||||||
error asks fx to shut down with exit code 1 through `fx.Shutdowner`; a Sentry
|
|
||||||
start failure is returned from the server's start hook instead of calling
|
|
||||||
`os.Exit` from a goroutine, so the stop hooks of what had started still run.
|
|
||||||
The server's stop hook shuts the HTTP server down within 5 seconds and fails
|
|
||||||
when requests are still running. A new paragraph says who owns signals and the
|
|
||||||
exit code.
|
|
||||||
- 2026-10-04: `REPO_POLICIES.md` now says how a Go tool a repo needs on the host
|
|
||||||
is pinned (issue 37): installed with `go install` pinned to a commit hash,
|
|
||||||
never tracked as a `go.mod` tool dependency or through a `tools.go` file.
|
|
||||||
golangci-lint is unaffected, since no repo installs it on the host.
|
|
||||||
- 2026-10-04: The canonical `.gitignore` and `.dockerignore` now also keep out
|
|
||||||
`id_ecdsa_sk` and `id_ed25519_sk`, the private key files `ssh-keygen` writes
|
|
||||||
for keys backed by a hardware security key (issue 81). Their `.pub` halves
|
|
||||||
stay trackable.
|
|
||||||
- 2026-10-04: `package.json` now has `"license": "MIT"`, matching `LICENSE`, so
|
|
||||||
yarn no longer prints "No license field" when `script/bootstrap` runs it
|
|
||||||
inside the Docker phases (issue 76). That was the only yarn warning there.
|
|
||||||
- 2026-10-04: `REPO_POLICIES.md` now states that guidance for coding agents
|
- 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
|
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
|
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
|
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
|
agent memory as committed files under `.claude/memory/`. `AGENTS.md` joins the
|
||||||
list of files allowed in the root, and both checklists say so.
|
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
|
- 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
|
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
|
a git checkout, or where git is missing or refuses the checkout), instead of
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
{
|
{
|
||||||
"license": "MIT",
|
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"prettier": "3.8.1"
|
"prettier": "3.8.1"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Code Styleguide — Go
|
title: Code Styleguide — Go
|
||||||
last_modified: 2026-10-06
|
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.
|
||||||
@@ -148,9 +148,8 @@ last_modified: 2026-10-06
|
|||||||
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
|
||||||
handlers.
|
handlers.
|
||||||
|
|
||||||
1. The repository's own entries at the end of `.gitignore`, which a re-vendor
|
1. Provide a .gitignore file that ignores at least `*.log`, `*.out`, and
|
||||||
keeps, ignore at least `*.log`, `*.out`, and `*.test` files, as well as any
|
`*.test` files, as well as any binaries.
|
||||||
binaries.
|
|
||||||
|
|
||||||
1. Constructors **must** be called `New()`. `modulename.New()` works great if
|
1. Constructors **must** be called `New()`. `modulename.New()` works great if
|
||||||
you name the packages properly. If the constructor creates an instance from
|
you name the packages properly. If the constructor creates an instance from
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Existing Repo Checklist
|
title: Existing Repo Checklist
|
||||||
last_modified: 2026-10-06
|
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
|
||||||
@@ -28,18 +28,13 @@ with your task.
|
|||||||
root — never a file or directory named after one agent tool, such as
|
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
|
`CLAUDE.md` or `.claude/`, and never separate memory files. Move what any
|
||||||
such committed file says into `AGENTS.md` and delete it.
|
such committed file says into `AGENTS.md` and delete it.
|
||||||
- [ ] `.gitignore` is comprehensive (OS, editor, agent scratch, secrets, the
|
- [ ] `.gitignore` is comprehensive (OS, editor, agent scratch, language
|
||||||
repo's own build outputs) — 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. The file is the
|
so check the entries rather than the file's presence.
|
||||||
canonical content followed by the repo's own entries, such as its
|
|
||||||
binaries; a re-vendor replaces the canonical part and keeps those entries.
|
|
||||||
- [ ] `.editorconfig` exists — fetch from
|
- [ ] `.editorconfig` exists — fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.editorconfig`. The
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.editorconfig`
|
||||||
file is the canonical content followed by the repo's own sections, such as
|
|
||||||
one for another language it uses; a re-vendor replaces the canonical part
|
|
||||||
and keeps those sections.
|
|
||||||
- [ ] `Dockerfile` and `.dockerignore` exist; the Dockerfile carries a `lint`
|
- [ ] `Dockerfile` and `.dockerignore` exist; the Dockerfile carries a `lint`
|
||||||
phase and a `test` phase, and the final stage carries a `COPY --from=` of
|
phase and a `test` phase, and the final stage carries a `COPY --from=` of
|
||||||
a harmless file from each — fetch `.dockerignore` from
|
a harmless file from each — fetch `.dockerignore` from
|
||||||
@@ -68,15 +63,10 @@ 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 every git `config` at any depth
|
the build context. It keeps out `.git/config` and each submodule's
|
||||||
(`**/.git/config`, `**/.git/modules/**/config`): the repository's own,
|
`config` under `.git/modules/` at any depth (`.git/modules/**/config`),
|
||||||
each submodule's under `.git/modules/`, and that of a submodule keeping
|
which `git describe` does not need and which can hold a credential: a
|
||||||
its own `.git` directory. `git describe` does not need them, and each can
|
password in a remote URL, or the token the CI checkout step stores there.
|
||||||
hold a credential: a password in a remote URL, or the token the CI
|
|
||||||
checkout step stores there. A submodule whose name has a `config` segment
|
|
||||||
(`config`, `deploy/config`, `config/lib`) loses its whole git directory to
|
|
||||||
`**/.git/modules/**/config`, and Go's version stamping then fails the
|
|
||||||
build: give it a name without that segment (`git submodule add --name`).
|
|
||||||
The stage that compiles has `git` (the Debian Go image has it; an alpine
|
The stage that compiles has `git` (the Debian Go image has it; an alpine
|
||||||
one needs `apk add --no-cache git`) and takes the version from the
|
one needs `apk add --no-cache git`) and takes the version from the
|
||||||
`VERSION` build argument when one is given, otherwise from
|
`VERSION` build argument when one is given, otherwise from
|
||||||
@@ -91,18 +81,12 @@ with your task.
|
|||||||
version still comes out empty, `dev` or `unknown`. A plain
|
version still comes out empty, `dev` or `unknown`. A plain
|
||||||
`docker build .` with no build arguments must succeed; a Dockerfile that
|
`docker build .` with no build arguments must succeed; a Dockerfile that
|
||||||
refuses an empty build argument drops that refusal and keeps the argument.
|
refuses an empty build argument drops that refusal and keeps the argument.
|
||||||
A checkout whose `.git` is a file (a linked worktree, or a repository
|
`script/docker` and `script/cibuild` pass the version they compute on the
|
||||||
checked out as a submodule) is the exception: that file points to a git
|
host; it takes precedence. A tag-derived version additionally needs
|
||||||
directory outside the build context, so the build cannot read the version
|
`fetch-depth: 0` on the CI checkout step, which clones shallow and fetches
|
||||||
and a plain `docker build .` fails; pass the version with
|
no tags by default.
|
||||||
`--build-arg VERSION=...`. `script/docker` and `script/cibuild` already
|
|
||||||
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, checks out with `persist-credentials: false`, and carries the
|
push — reference
|
||||||
`concurrency` block that lets a new push cancel only the same branch's
|
|
||||||
older run — 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
|
||||||
|
|||||||
@@ -106,9 +106,6 @@ project-root/
|
|||||||
package main
|
package main
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"os/signal"
|
|
||||||
"syscall"
|
|
||||||
|
|
||||||
"yourproject/internal/config"
|
"yourproject/internal/config"
|
||||||
"yourproject/internal/database"
|
"yourproject/internal/database"
|
||||||
"yourproject/internal/globals"
|
"yourproject/internal/globals"
|
||||||
@@ -129,9 +126,6 @@ func main() {
|
|||||||
globals.Appname = Appname
|
globals.Appname = Appname
|
||||||
globals.Version = Version
|
globals.Version = Version
|
||||||
|
|
||||||
// A write to a closed stdout or stderr must not end the process.
|
|
||||||
signal.Ignore(syscall.SIGPIPE)
|
|
||||||
|
|
||||||
fx.New(
|
fx.New(
|
||||||
fx.Provide(
|
fx.Provide(
|
||||||
config.New,
|
config.New,
|
||||||
@@ -204,8 +198,7 @@ Providers are resolved automatically by fx, but conceptually follow this order:
|
|||||||
Database)
|
Database)
|
||||||
6. `middleware.New` - Middleware (depends on Logger, Globals, Config)
|
6. `middleware.New` - Middleware (depends on Logger, Globals, Config)
|
||||||
7. `handlers.New` - Handlers (depends on Logger, Globals, Database, Healthcheck)
|
7. `handlers.New` - Handlers (depends on Logger, Globals, Database, Healthcheck)
|
||||||
8. `server.New` - Server (depends on all above, and on `fx.Shutdowner`, which fx
|
8. `server.New` - Server (depends on all above)
|
||||||
provides itself)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -224,14 +217,16 @@ type ServerParams struct {
|
|||||||
Config *config.Config
|
Config *config.Config
|
||||||
Middleware *middleware.Middleware
|
Middleware *middleware.Middleware
|
||||||
Handlers *handlers.Handlers
|
Handlers *handlers.Handlers
|
||||||
Shutdowner fx.Shutdowner
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type Server struct {
|
type Server struct {
|
||||||
startupTime time.Time
|
startupTime time.Time
|
||||||
port int
|
port int
|
||||||
|
exitCode int
|
||||||
sentryEnabled bool
|
sentryEnabled bool
|
||||||
log *slog.Logger
|
log *slog.Logger
|
||||||
|
ctx context.Context
|
||||||
|
cancelFunc context.CancelFunc
|
||||||
httpServer *http.Server
|
httpServer *http.Server
|
||||||
router *chi.Mux
|
router *chi.Mux
|
||||||
params ServerParams
|
params ServerParams
|
||||||
@@ -253,15 +248,13 @@ func New(lc fx.Lifecycle, params ServerParams) (*Server, error) {
|
|||||||
lc.Append(fx.Hook{
|
lc.Append(fx.Hook{
|
||||||
OnStart: func(ctx context.Context) error {
|
OnStart: func(ctx context.Context) error {
|
||||||
s.startupTime = time.Now()
|
s.startupTime = time.Now()
|
||||||
if err := s.enableSentry(); err != nil {
|
go s.Run()
|
||||||
return err
|
return nil
|
||||||
}
|
},
|
||||||
s.SetupRoutes()
|
OnStop: func(ctx context.Context) error {
|
||||||
s.httpServer = s.newHTTPServer()
|
// Server shutdown logic
|
||||||
go s.serveUntilShutdown()
|
|
||||||
return nil
|
return nil
|
||||||
},
|
},
|
||||||
OnStop: s.cleanShutdown,
|
|
||||||
})
|
})
|
||||||
return s, nil
|
return s, nil
|
||||||
}
|
}
|
||||||
@@ -271,25 +264,23 @@ func New(lc fx.Lifecycle, params ServerParams) (*Server, error) {
|
|||||||
|
|
||||||
```go
|
```go
|
||||||
// internal/server/http.go
|
// internal/server/http.go
|
||||||
func (s *Server) newHTTPServer() *http.Server {
|
func (s *Server) serveUntilShutdown() {
|
||||||
return &http.Server{
|
listenAddr := fmt.Sprintf(":%d", s.params.Config.Port)
|
||||||
Addr: fmt.Sprintf(":%d", s.params.Config.Port),
|
s.httpServer = &http.Server{
|
||||||
|
Addr: listenAddr,
|
||||||
ReadTimeout: 10 * time.Second,
|
ReadTimeout: 10 * time.Second,
|
||||||
WriteTimeout: 10 * time.Second,
|
WriteTimeout: 10 * time.Second,
|
||||||
MaxHeaderBytes: 1 << 20,
|
MaxHeaderBytes: 1 << 20,
|
||||||
Handler: s,
|
Handler: s,
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
// serveUntilShutdown returns when the stop hook shuts the HTTP server down.
|
s.SetupRoutes()
|
||||||
// If it stops for any other reason, such as its port being taken, it asks fx
|
|
||||||
// to shut down with exit code 1.
|
s.log.Info("http begin listen", "listenaddr", listenAddr)
|
||||||
func (s *Server) serveUntilShutdown() {
|
|
||||||
s.log.Info("http begin listen", "listenaddr", s.httpServer.Addr)
|
|
||||||
if err := s.httpServer.ListenAndServe(); err != nil && err != http.ErrServerClosed {
|
if err := s.httpServer.ListenAndServe(); err != nil && err != http.ErrServerClosed {
|
||||||
s.log.Error("listen error", "error", err)
|
s.log.Error("listen error", "error", err)
|
||||||
if err := s.params.Shutdowner.Shutdown(fx.ExitCode(1)); err != nil {
|
if s.cancelFunc != nil {
|
||||||
s.log.Error("shutdown request failed", "error", err)
|
s.cancelFunc()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -301,30 +292,43 @@ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
|
|
||||||
## Signal Handling and Graceful Shutdown
|
## Signal Handling and Graceful Shutdown
|
||||||
|
|
||||||
fx owns SIGINT, SIGTERM and the exit code. `Run()` in `main` waits for one of
|
|
||||||
those signals or for a call to `Shutdown()` on `fx.Shutdowner`, runs the stop
|
|
||||||
hooks, and exits 0 after a signal, or with the code the call gave in
|
|
||||||
`fx.ExitCode`. It exits 1 instead when a start hook or a stop hook returns an
|
|
||||||
error; when a start hook fails, fx first runs the stop hooks of everything
|
|
||||||
already started. No other code calls `signal.Notify` or `os.Exit`: the listen
|
|
||||||
error above asks fx to shut down with `fx.ExitCode(1)`, and a Sentry start
|
|
||||||
failure is returned from the start hook. Each component releases its own
|
|
||||||
resources in its own stop hook, which fx runs in the reverse order of start.
|
|
||||||
|
|
||||||
```go
|
```go
|
||||||
// cleanShutdown is the server's stop hook. It fails when requests are still
|
func (s *Server) serve() int {
|
||||||
// running after 5 seconds.
|
s.ctx, s.cancelFunc = context.WithCancel(context.Background())
|
||||||
func (s *Server) cleanShutdown(ctx context.Context) error {
|
|
||||||
ctxShutdown, shutdownCancel := context.WithTimeout(ctx, 5*time.Second)
|
// Signal watcher
|
||||||
defer shutdownCancel()
|
go func() {
|
||||||
err := s.httpServer.Shutdown(ctxShutdown)
|
c := make(chan os.Signal, 1)
|
||||||
|
signal.Ignore(syscall.SIGPIPE)
|
||||||
|
signal.Notify(c, os.Interrupt, syscall.SIGTERM)
|
||||||
|
sig := <-c
|
||||||
|
s.log.Info("signal received", "signal", sig)
|
||||||
|
if s.cancelFunc != nil {
|
||||||
|
s.cancelFunc()
|
||||||
|
}
|
||||||
|
}()
|
||||||
|
|
||||||
|
go s.serveUntilShutdown()
|
||||||
|
|
||||||
|
for range s.ctx.Done() {
|
||||||
|
}
|
||||||
|
s.cleanShutdown()
|
||||||
|
return s.exitCode
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *Server) cleanShutdown() {
|
||||||
|
s.exitCode = 0
|
||||||
|
ctxShutdown, shutdownCancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||||
|
if err := s.httpServer.Shutdown(ctxShutdown); err != nil {
|
||||||
|
s.log.Error("server clean shutdown failed", "error", err)
|
||||||
|
}
|
||||||
|
if shutdownCancel != nil {
|
||||||
|
shutdownCancel()
|
||||||
|
}
|
||||||
|
s.cleanupForExit()
|
||||||
if s.sentryEnabled {
|
if s.sentryEnabled {
|
||||||
sentry.Flush(2 * time.Second)
|
sentry.Flush(2 * time.Second)
|
||||||
}
|
}
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("http server shutdown: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -1156,11 +1160,11 @@ s.router.Get("/.well-known/healthcheck", s.h.HandleHealthCheck())
|
|||||||
Sentry is conditionally enabled based on `SENTRY_DSN` environment variable:
|
Sentry is conditionally enabled based on `SENTRY_DSN` environment variable:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
func (s *Server) enableSentry() error {
|
func (s *Server) enableSentry() {
|
||||||
s.sentryEnabled = false
|
s.sentryEnabled = false
|
||||||
|
|
||||||
if s.params.Config.SentryDSN == "" {
|
if s.params.Config.SentryDSN == "" {
|
||||||
return nil
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
err := sentry.Init(sentry.ClientOptions{
|
err := sentry.Init(sentry.ClientOptions{
|
||||||
@@ -1168,17 +1172,15 @@ func (s *Server) enableSentry() error {
|
|||||||
Release: fmt.Sprintf("%s-%s", s.params.Globals.Appname, s.params.Globals.Version),
|
Release: fmt.Sprintf("%s-%s", s.params.Globals.Appname, s.params.Globals.Version),
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("sentry init failure: %w", err)
|
s.log.Error("sentry init failure", "error", err)
|
||||||
|
os.Exit(1)
|
||||||
|
return
|
||||||
}
|
}
|
||||||
s.log.Info("sentry error reporting activated")
|
s.log.Info("sentry error reporting activated")
|
||||||
s.sentryEnabled = true
|
s.sentryEnabled = true
|
||||||
return nil
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The server's start hook calls `enableSentry()` and returns its error, so a DSN
|
|
||||||
Sentry rejects stops startup and fx exits 1.
|
|
||||||
|
|
||||||
Sentry middleware with repanic (bubbles panics to chi's Recoverer):
|
Sentry middleware with repanic (bubbles panics to chi's Recoverer):
|
||||||
|
|
||||||
```go
|
```go
|
||||||
@@ -1190,7 +1192,7 @@ if s.sentryEnabled {
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Flush Sentry in the server's stop hook, `cleanShutdown()`:
|
Flush Sentry on shutdown:
|
||||||
|
|
||||||
```go
|
```go
|
||||||
if s.sentryEnabled {
|
if s.sentryEnabled {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: New Repo Checklist
|
title: New Repo Checklist
|
||||||
last_modified: 2026-10-06
|
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
|
||||||
@@ -34,17 +34,14 @@ Template files can be fetched from:
|
|||||||
## Fetch Template Files
|
## Fetch Template Files
|
||||||
|
|
||||||
- [ ] `.gitignore` — fetch from
|
- [ ] `.gitignore` — fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore`, then add
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore`, extend for
|
||||||
the repo's own build outputs, such as its binaries, at the end of the
|
language-specific artifacts. Extensions are written to `.gitignore`'s own
|
||||||
file, where a re-vendor keeps them. Extensions are written to
|
semantics, where an unanchored pattern already matches at every depth:
|
||||||
`.gitignore`'s own semantics, where an unanchored pattern already matches
|
never add a `**/` prefix here, which is a `.dockerignore` form. The
|
||||||
at every depth: never add a `**/` prefix here, which is a `.dockerignore`
|
canonical file already carries `.claude/` so agent worktrees cannot be
|
||||||
form. The canonical file already carries `.claude/` so agent worktrees
|
committed by accident.
|
||||||
cannot be committed by accident.
|
|
||||||
- [ ] `.editorconfig` — fetch from
|
- [ ] `.editorconfig` — fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.editorconfig`, then
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.editorconfig`
|
||||||
add the repo's own sections, such as one for another language it uses, at
|
|
||||||
the end of the file, where a re-vendor keeps them.
|
|
||||||
- [ ] `Makefile` — fetch from
|
- [ ] `Makefile` — fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile`, adapt
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile`, adapt
|
||||||
targets for the project's language and tools
|
targets for the project's language and tools
|
||||||
@@ -74,15 +71,10 @@ 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 every git `config` at any depth
|
into the build context. It keeps out `.git/config` and each submodule's
|
||||||
(`**/.git/config`, `**/.git/modules/**/config`): the repository's own,
|
`config` under `.git/modules/` at any depth (`.git/modules/**/config`),
|
||||||
each submodule's under `.git/modules/`, and that of a submodule keeping
|
which `git describe` does not need and which can hold a credential: a
|
||||||
its own `.git` directory. `git describe` does not need them, and each can
|
password in a remote URL, or the token the CI checkout step stores there.
|
||||||
hold a credential: a password in a remote URL, or the token the CI
|
|
||||||
checkout step stores there. A submodule whose name has a `config` segment
|
|
||||||
(`config`, `deploy/config`, `config/lib`) loses its whole git directory to
|
|
||||||
`**/.git/modules/**/config`, and Go's version stamping then fails the
|
|
||||||
build: give it a name without that segment (`git submodule add --name`).
|
|
||||||
The stage that compiles has `git` (the Debian Go image has it; an alpine
|
The stage that compiles has `git` (the Debian Go image has it; an alpine
|
||||||
one needs `apk add --no-cache git`) and takes the version from the
|
one needs `apk add --no-cache git`) and takes the version from the
|
||||||
`VERSION` build argument when one is given, otherwise from
|
`VERSION` build argument when one is given, otherwise from
|
||||||
@@ -97,12 +89,6 @@ Template files can be fetched from:
|
|||||||
version still comes out empty, `dev` or `unknown`. A plain
|
version still comes out empty, `dev` or `unknown`. A plain
|
||||||
`docker build .` with no build arguments must succeed; a Dockerfile that
|
`docker build .` with no build arguments must succeed; a Dockerfile that
|
||||||
refuses an empty build argument drops that refusal and keeps the argument.
|
refuses an empty build argument drops that refusal and keeps the argument.
|
||||||
A checkout whose `.git` is a file (a linked worktree, or a repository
|
|
||||||
checked out as a submodule) is the exception: that file points to a git
|
|
||||||
directory outside the build context, so the build cannot read the version
|
|
||||||
and a plain `docker build .` fails; pass the version with
|
|
||||||
`--build-arg VERSION=...`, as `script/docker` and `script/cibuild` already
|
|
||||||
do.
|
|
||||||
- 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
|
||||||
@@ -112,9 +98,7 @@ Template files can be fetched from:
|
|||||||
- Non-server: the final stage brings up the dev environment
|
- 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
|
||||||
- [ ] Gitea Actions workflow at `.gitea/workflows/check.yml` that runs
|
- [ ] Gitea Actions workflow at `.gitea/workflows/check.yml` that runs
|
||||||
`script/cibuild` on push, checks out with `persist-credentials: false`,
|
`script/cibuild` on push — reference
|
||||||
and carries the `concurrency` block that lets a new push cancel only the
|
|
||||||
same branch's older run — 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
|
||||||
@@ -135,10 +119,8 @@ are thin shims calling them. Model scripts:
|
|||||||
- [ ] `script/bootstrap` / `make bootstrap` — installs all dependencies,
|
- [ ] `script/bootstrap` / `make bootstrap` — installs all dependencies,
|
||||||
idempotently, assuming nothing (pkg manager detection nix/apt/brew/apk;
|
idempotently, assuming nothing (pkg manager detection nix/apt/brew/apk;
|
||||||
node used if present, else pinned version via nvm from a hash-verified
|
node used if present, else pinned version via nvm from a hash-verified
|
||||||
archive; pinned yarn via corepack); a non-server repo's development
|
archive; pinned yarn via corepack); Dockerfile runs it instead of inline
|
||||||
environment stage runs it instead of inline installs; a gate phase or the
|
installs
|
||||||
build stage installs what its base image lacks either inline or by running
|
|
||||||
it
|
|
||||||
- [ ] `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` — `docker build --no-cache --target test .`,
|
- [ ] `script/test` / `make test` — `docker build --no-cache --target test .`,
|
||||||
|
|||||||
+41
-97
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Repository Policies
|
title: Repository Policies
|
||||||
last_modified: 2026-10-06
|
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
|
||||||
@@ -104,23 +104,18 @@ style conventions are in separate documents:
|
|||||||
`lint` phase and a `test` phase, with the final stage depending on both so the
|
`lint` phase and a `test` phase, with the final stage depending on both so the
|
||||||
image cannot be built unless they pass. For non-server repos the final stage
|
image cannot be built unless they pass. For non-server repos the final stage
|
||||||
brings up a development environment; for server repos it is the runtime image.
|
brings up a development environment; for server repos it is the runtime image.
|
||||||
The gate phases and the build stage start from their pinned base images and
|
Dockerfiles install development prerequisites by running `script/bootstrap`
|
||||||
install what those images lack either inline, as the canonical Go `Dockerfile`
|
rather than duplicating installs inline; COPY `script/` and the dependency
|
||||||
below does for `git`, or by running `script/bootstrap`, as the `prompts`
|
manifests (`package.json` + `yarn.lock`, `go.mod` + `go.sum`, etc.) before
|
||||||
repo's own `Dockerfile` does for its yarn packages. The development
|
running it.
|
||||||
environment stage installs development prerequisites by running
|
|
||||||
`script/bootstrap` rather than duplicating its installs inline. A stage that
|
|
||||||
runs `script/bootstrap` COPYs `script/` and the dependency manifests
|
|
||||||
(`package.json` + `yarn.lock`, `go.mod` + `go.sum`, etc.) before running it.
|
|
||||||
|
|
||||||
- **Linting and testing run in Docker, as phases of the `Dockerfile`.** There is
|
- **Linting and testing run in Docker, as phases of the `Dockerfile`.** There is
|
||||||
no separate lint file. `script/lint` and `script/test` each build one phase
|
no separate lint file. `script/lint` and `script/test` each build one phase
|
||||||
and nothing else:
|
and nothing else:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
tag="$(script/projectname)"
|
docker build --no-cache --target lint -t "$(script/projectname)-lint" .
|
||||||
docker build --no-cache --target lint -t "$tag-lint" .
|
docker build --no-cache --target test -t "$(script/projectname)-test" .
|
||||||
docker build --no-cache --target test -t "$tag-test" .
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**A stage that is not the last one in the file is built only when the final
|
**A stage that is not the last one in the file is built only when the final
|
||||||
@@ -133,9 +128,7 @@ style conventions are in separate documents:
|
|||||||
**Every `docker build` in `script/` is tagged**, here and in
|
**Every `docker build` in `script/` is tagged**, here and in
|
||||||
`script/cibuild` and `script/docker`. An untagged build leaves a dangling
|
`script/cibuild` and `script/docker`. An untagged build leaves a dangling
|
||||||
image behind on every invocation, on every developer host and every CI
|
image behind on every invocation, on every developer host and every CI
|
||||||
runner; a tagged one replaces the previous image. Each script assigns the
|
runner; a tagged one replaces the previous image.
|
||||||
tag on its own line before the build, so `set -e` stops it where
|
|
||||||
`script/projectname` fails.
|
|
||||||
|
|
||||||
Inside a phase the tool is invoked directly — `golangci-lint`, `go test`,
|
Inside a phase the tool is invoked directly — `golangci-lint`, `go test`,
|
||||||
`eslint`, `prettier` — never through `make lint` or `script/test`, which are
|
`eslint`, `prettier` — never through `make lint` or `script/test`, which are
|
||||||
@@ -163,9 +156,6 @@ style conventions are in separate documents:
|
|||||||
not evidence that anything ran: a sub-second build reporting success is a
|
not evidence that anything ran: a sub-second build reporting success is a
|
||||||
cache hit, not a result. Never invalidate by pruning — `docker builder prune`
|
cache hit, not a result. Never invalidate by pruning — `docker builder prune`
|
||||||
and friends destroy a build cache shared with every other build on the host.
|
and friends destroy a build cache shared with every other build on the host.
|
||||||
When a check is added or changed, prove it works by planting a defect it must
|
|
||||||
catch and watching the run fail on it, then revert the defect. A green run
|
|
||||||
alone shows neither that the check ran nor that it covers what it should.
|
|
||||||
|
|
||||||
- **The gate phases are separate stages, and the build stage depends on both.**
|
- **The 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
|
||||||
@@ -246,28 +236,13 @@ style conventions are in separate documents:
|
|||||||
(e.g. a web frontend compiled in a separate stage), the lint phase must
|
(e.g. a web frontend compiled in a separate stage), the lint phase must
|
||||||
create placeholder files so the embed directives resolve. Example:
|
create placeholder files so the embed directives resolve. Example:
|
||||||
`RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css`.
|
`RUN mkdir -p web/dist && touch web/dist/index.html web/dist/style.css`.
|
||||||
- If the project requires CGO or system libraries for linting, install them
|
- If the project requires CGO or system libraries for linting (e.g.
|
||||||
in the lint phase. The `golangci/golangci-lint` image is Debian-based and
|
`vips-dev`), install them in the lint phase with `apk add`.
|
||||||
has no `apk`, so install with `apt-get` under the Debian package name
|
- `.dockerignore` lets `.git` into the build context. It keeps out
|
||||||
(`libvips-dev`, where alpine says `vips-dev`), and delete the package
|
`.git/config` and each submodule's `config` under `.git/modules/` at any
|
||||||
lists in the same `RUN`, so the layer does not keep them:
|
depth (`.git/modules/**/config`), which `git describe` does not need and
|
||||||
|
which can hold a credential: a password in a remote URL, or the token the
|
||||||
```dockerfile
|
CI checkout step stores there. The stage that compiles has `git` (the
|
||||||
RUN apt-get update \
|
|
||||||
&& apt-get install -y --no-install-recommends libvips-dev \
|
|
||||||
&& rm -rf /var/lib/apt/lists/*
|
|
||||||
```
|
|
||||||
|
|
||||||
- `.dockerignore` lets `.git` into the build context. It keeps out every git
|
|
||||||
`config` at any depth (`**/.git/config`, `**/.git/modules/**/config`): the
|
|
||||||
repository's own, each submodule's under `.git/modules/`, and that of a
|
|
||||||
submodule keeping its own `.git` directory. `git describe` does not need
|
|
||||||
them, and each can hold a credential: a password in a remote URL, or the
|
|
||||||
token the CI checkout step stores there. A submodule whose name has a
|
|
||||||
`config` segment (`config`, `deploy/config`, `config/lib`) loses its whole
|
|
||||||
git directory to `**/.git/modules/**/config`, and Go's version stamping
|
|
||||||
then fails the build: give it a name without that segment
|
|
||||||
(`git submodule add --name`). The stage that compiles has `git` (the
|
|
||||||
Debian Go image has it; an alpine one needs `apk add --no-cache git`) and
|
Debian Go image has it; an alpine one needs `apk add --no-cache git`) and
|
||||||
takes the version from the `VERSION` build argument when one is given,
|
takes the version from the `VERSION` build argument when one is given,
|
||||||
otherwise from `git describe --tags --always`. That gives the tag on a
|
otherwise from `git describe --tags --always`. That gives the tag on a
|
||||||
@@ -281,32 +256,15 @@ style conventions are in separate documents:
|
|||||||
`.git` and the version still comes out empty, `dev` or `unknown`. A plain
|
`.git` and the version still comes out empty, `dev` or `unknown`. A plain
|
||||||
`docker build .` with no build arguments must succeed; a Dockerfile that
|
`docker build .` with no build arguments must succeed; a Dockerfile that
|
||||||
refuses an empty build argument drops that refusal and keeps the argument.
|
refuses an empty build argument drops that refusal and keeps the argument.
|
||||||
A checkout whose `.git` is a file (a linked worktree, or a repository
|
|
||||||
checked out as a submodule) is the exception: that file points to a git
|
|
||||||
directory outside the build context, so the build cannot read the version
|
|
||||||
and a plain `docker build .` fails; pass the version with
|
|
||||||
`--build-arg VERSION=...`, as `script/docker` and `script/cibuild` already
|
|
||||||
do.
|
|
||||||
|
|
||||||
- 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.
|
||||||
with `persist-credentials: false`: `script/cibuild` needs no token, and
|
That script bootstraps, runs the gate phases, and then builds the image, so a
|
||||||
without it the checkout leaves the job's token in `.git/config` for every
|
successful run means every check passed; a bare `docker build .` does not
|
||||||
later step. Its `concurrency` block groups runs by workflow and branch
|
|
||||||
(`${{ github.workflow }}-${{ github.ref }}`) with `cancel-in-progress: true`,
|
|
||||||
so a new push cancels the older run on the same branch, queued or running, and
|
|
||||||
no other: runs for replaced commits do not hold up the shared runner.
|
|
||||||
`script/cibuild` bootstraps, runs the gate phases, and then builds the image,
|
|
||||||
so a successful run means every check passed; a bare `docker build .` does not
|
|
||||||
carry the same guarantee, because its gate phases may come from the cache. The
|
carry the same guarantee, because its gate phases may come from the cache. The
|
||||||
image build is uncached and so runs the gate phases a second time. That is the
|
image build is uncached and so runs the gate phases a second time. That is the
|
||||||
price of the rule above, and it is worth paying: the image that ships is built
|
price of the rule above, and it is worth paying: the image that ships is built
|
||||||
from a run of its own gates rather than from a cache entry. A separate
|
from a run of its own gates rather than from a cache entry.
|
||||||
workflow limited to `main` by a `branches` list under `on: push` cannot be
|
|
||||||
checked by review: to try a change to it, add the feature branch to that list
|
|
||||||
and push, then remove the branch from the list again before merging. Keep any
|
|
||||||
job in it that publishes behind `if: github.ref_name == 'main'`, so the run
|
|
||||||
from the feature branch publishes nothing.
|
|
||||||
|
|
||||||
- Use platform-standard formatters: `black` for Python, `prettier` for
|
- Use platform-standard formatters: `black` for Python, `prettier` for
|
||||||
JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with
|
JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with
|
||||||
@@ -359,19 +317,17 @@ 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 neither run can report a stored pass in place of running the
|
cache, so the target cannot report a pass it did not earn, and the rerun
|
||||||
tests. It leaves the build cache alone, so it costs the runtime of the suite
|
reproduces a failure instead of replaying it. It leaves the build cache
|
||||||
and no recompilation.
|
alone, so it costs the runtime of the suite and no recompilation.
|
||||||
|
|
||||||
That cache is Go's own, separate from Docker's layer cache. Go stores a
|
Note that this is a second, independent cache, stacked below the Docker
|
||||||
passing result in its cache directory (`GOCACHE`), and when the same tests
|
layer cache that [issue #26](https://git.eeqj.de/sneak/prompts/issues/26)
|
||||||
run again on unchanged code it prints that result, marked `(cached)`,
|
addresses. `CHECK_EPOCH` guarantees the `RUN make test` _step_ re-executes;
|
||||||
without running them. That matters on a developer's machine, where this
|
it does not guarantee `go test` inside that step does any work, because the
|
||||||
target runs and the directory lasts from one run to the next. The `test`
|
`GOCACHE` baked into earlier image layers survives into the re-executed
|
||||||
phase of the `Dockerfile` needs no `-count=1`: its base image holds no
|
step. They are two separate defects requiring two separate fixes, and a fix
|
||||||
result for this repo's tests and nothing before its `go test` step runs a
|
for one must not be recorded as covering the other.
|
||||||
test, so there is nothing to replay. `--no-cache` (above) is what makes that
|
|
||||||
step run on an unchanged tree.
|
|
||||||
|
|
||||||
Python example:
|
Python example:
|
||||||
|
|
||||||
@@ -399,12 +355,9 @@ style conventions are in separate documents:
|
|||||||
|
|
||||||
- `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`),
|
- `.gitignore` should be comprehensive from the start: OS files (`.DS_Store`),
|
||||||
editor files (`.swp`, `*~`), in-repo agent scratch directories (`.claude/`),
|
editor files (`.swp`, `*~`), in-repo agent scratch directories (`.claude/`),
|
||||||
`node_modules/`, and the repo's own build outputs. Fetch the standard
|
language build artifacts, and `node_modules/`. Fetch the standard `.gitignore`
|
||||||
`.gitignore` from
|
from `https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitignore` when setting up
|
setting up a new repo. These patterns are written to `.gitignore`'s own
|
||||||
a new repo. A repo's `.gitignore` is the standard file followed by the repo's
|
|
||||||
own entries, such as its binaries; a re-vendor replaces the standard part and
|
|
||||||
keeps those entries. These patterns are written to `.gitignore`'s own
|
|
||||||
semantics, in which an unanchored pattern already matches at every depth; they
|
semantics, in which an unanchored pattern already matches at every depth; they
|
||||||
are not a `.dockerignore` and must not be transplanted into one unmodified.
|
are not a `.dockerignore` and must not be transplanted into one unmodified.
|
||||||
|
|
||||||
@@ -452,15 +405,13 @@ style conventions are in separate documents:
|
|||||||
byte-identically across repos:
|
byte-identically across repos:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
# The version and the tag each get their own line: a failing command
|
# Own line: a failing command substitution inside an argument does not
|
||||||
# substitution inside an argument does not trip `set -e`, so the inline
|
# trip `set -e`, so the inline form degrades to an empty constant.
|
||||||
# form degrades to an empty constant.
|
|
||||||
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"
|
||||||
tag="$(script/projectname)"
|
|
||||||
docker build --no-cache \
|
docker build --no-cache \
|
||||||
--build-arg VERSION="$version" \
|
--build-arg VERSION="$version" \
|
||||||
-t "$tag" .
|
-t "$(script/projectname)" .
|
||||||
```
|
```
|
||||||
|
|
||||||
`--always` makes an untagged repo yield an abbreviated commit hash rather
|
`--always` makes an untagged repo yield an abbreviated commit hash rather
|
||||||
@@ -542,11 +493,6 @@ style conventions are in separate documents:
|
|||||||
|
|
||||||
Keep it POSIX sh: no arrays, no `[[`, no `grep -P`.
|
Keep it POSIX sh: no arrays, no `[[`, no `grep -P`.
|
||||||
|
|
||||||
A Go tool a repo needs on the host is installed with `go install` pinned to
|
|
||||||
a commit hash (`go install <package>@<commit hash>`). It is never tracked as
|
|
||||||
a `go.mod` tool dependency or through a `tools.go` file, either of which
|
|
||||||
pulls the tool's own dependencies into the repo's `go.mod` and `go.sum`.
|
|
||||||
|
|
||||||
- When pinning images or packages by hash, add a comment above the reference
|
- When pinning images or packages by hash, add a comment above the reference
|
||||||
with the version and date (YYYY-MM-DD).
|
with the version and date (YYYY-MM-DD).
|
||||||
|
|
||||||
@@ -656,11 +602,7 @@ style conventions are in separate documents:
|
|||||||
Never edit existing migrations after release.
|
Never edit existing migrations after release.
|
||||||
|
|
||||||
- All repos should have an `.editorconfig` enforcing the project's indentation
|
- All repos should have an `.editorconfig` enforcing the project's indentation
|
||||||
settings: the standard file from
|
settings.
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/.editorconfig`, which sets
|
|
||||||
tabs for `Makefile` and Go files, followed by the repo's own sections, such as
|
|
||||||
one for another language it uses. A re-vendor replaces the standard part and
|
|
||||||
keeps those sections.
|
|
||||||
|
|
||||||
- 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`, `AGENTS.md`, `Makefile`,
|
only project-level config files (`README.md`, `AGENTS.md`, `Makefile`,
|
||||||
@@ -698,6 +640,8 @@ style conventions are in separate documents:
|
|||||||
- 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
|
- Guidance for coding agents lives in one `AGENTS.md` at the repository root,
|
||||||
is never committed under a file or directory named after one agent tool, such
|
including anything an agent should remember about the repo from one session to
|
||||||
as `CLAUDE.md` or `.claude/`, and never split into separate memory files.
|
the next. 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.
|
||||||
|
|||||||
+5
-7
@@ -14,17 +14,15 @@ main() {
|
|||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
"$SCRIPT_DIR/bootstrap"
|
"$SCRIPT_DIR/bootstrap"
|
||||||
"$SCRIPT_DIR/check"
|
"$SCRIPT_DIR/check"
|
||||||
# The version and the tag each get their own line: a failing
|
# Own line: a failing command substitution inside an argument does
|
||||||
# command substitution inside an argument does not trip `set -e`,
|
# not trip `set -e`, so the inline form degrades silently to an
|
||||||
# so the inline form degrades silently to an empty constant. The
|
# empty constant. The VERSION build argument takes precedence over
|
||||||
# VERSION build argument takes precedence over the version a build
|
# the version a build stage derives from the .git in the context.
|
||||||
# stage derives from the .git in the context.
|
|
||||||
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"
|
||||||
tag="$("$SCRIPT_DIR/projectname")"
|
|
||||||
docker build --no-cache \
|
docker build --no-cache \
|
||||||
--build-arg VERSION="$version" \
|
--build-arg VERSION="$version" \
|
||||||
-t "$tag" .
|
-t "$("$SCRIPT_DIR/projectname")" .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+5
-7
@@ -10,17 +10,15 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
# The version and the tag each get their own line: a failing
|
# Own line: a failing command substitution inside an argument does
|
||||||
# command substitution inside an argument does not trip `set -e`,
|
# not trip `set -e`, so the inline form degrades silently to an
|
||||||
# so the inline form degrades silently to an empty constant. The
|
# empty constant. The VERSION build argument takes precedence over
|
||||||
# VERSION build argument takes precedence over the version a build
|
# the version a build stage derives from the .git in the context.
|
||||||
# stage derives from the .git in the context.
|
|
||||||
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"
|
||||||
tag="$("$SCRIPT_DIR/projectname")"
|
|
||||||
docker build --no-cache \
|
docker build --no-cache \
|
||||||
--build-arg VERSION="$version" \
|
--build-arg VERSION="$version" \
|
||||||
-t "$tag" .
|
-t "$("$SCRIPT_DIR/projectname")" .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+1
-5
@@ -15,13 +15,9 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
# The tag gets its own line: a failing command substitution inside
|
|
||||||
# an argument does not trip `set -e`, so the inline form degrades
|
|
||||||
# silently to an empty constant.
|
|
||||||
tag="$("$SCRIPT_DIR/projectname")"
|
|
||||||
docker build --no-cache \
|
docker build --no-cache \
|
||||||
--target lint \
|
--target lint \
|
||||||
-t "$tag-lint" .
|
-t "$("$SCRIPT_DIR/projectname")-lint" .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
+1
-5
@@ -11,13 +11,9 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
# The tag gets its own line: a failing command substitution inside
|
|
||||||
# an argument does not trip `set -e`, so the inline form degrades
|
|
||||||
# silently to an empty constant.
|
|
||||||
tag="$("$SCRIPT_DIR/projectname")"
|
|
||||||
docker build --no-cache \
|
docker build --no-cache \
|
||||||
--target test \
|
--target test \
|
||||||
-t "$tag-test" .
|
-t "$("$SCRIPT_DIR/projectname")-test" .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
Reference in New Issue
Block a user