Compare commits
3
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
29dcf38205 | ||
|
|
964d973e3c | ||
|
|
1ad7ae14be |
No files matched your search
+4
-10
@@ -2,18 +2,14 @@
|
|||||||
# lint` or `script/lint`, which are themselves a docker build and would
|
# lint` or `script/lint`, which are themselves a docker build and would
|
||||||
# recurse into a daemon that does not exist in a build step.
|
# recurse into a daemon that does not exist in a build step.
|
||||||
#
|
#
|
||||||
# In every stage, ARG CACHEBUST comes right after the step that installs
|
# node and yarn come from the distribution, which is trusted, so they
|
||||||
# system packages. script/ passes a new value on every build. That value
|
# need no version and no hash. That yarn only starts the release file in
|
||||||
# reruns every RUN step below the ARG line, and the install step keeps
|
# .yarn/releases/, so every stage copies that file and .yarnrc.yml
|
||||||
# its layer. node and yarn come from the distribution, which is trusted,
|
# before it runs script/bootstrap.
|
||||||
# so they need no version and no hash. That yarn only starts the release
|
|
||||||
# file in .yarn/releases/, so every stage copies that file and
|
|
||||||
# .yarnrc.yml before it runs script/bootstrap.
|
|
||||||
#
|
#
|
||||||
# alpine 3.24.3, 2026-11-04
|
# alpine 3.24.3, 2026-11-04
|
||||||
FROM alpine@sha256:be2656061b536c1883c4034790e21d0a09c5aaaf51968b89368a3c0371ea2c9a AS lint
|
FROM alpine@sha256:be2656061b536c1883c4034790e21d0a09c5aaaf51968b89368a3c0371ea2c9a AS lint
|
||||||
RUN apk add --no-cache git make nodejs-current yarn
|
RUN apk add --no-cache git make nodejs-current yarn
|
||||||
ARG CACHEBUST
|
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
@@ -31,7 +27,6 @@ RUN yarn run prettier --check '**/*.md' --tab-width 4 --prose-wrap always
|
|||||||
# alpine 3.24.3, 2026-11-04
|
# alpine 3.24.3, 2026-11-04
|
||||||
FROM alpine@sha256:be2656061b536c1883c4034790e21d0a09c5aaaf51968b89368a3c0371ea2c9a AS test
|
FROM alpine@sha256:be2656061b536c1883c4034790e21d0a09c5aaaf51968b89368a3c0371ea2c9a AS test
|
||||||
RUN apk add --no-cache git make nodejs-current yarn
|
RUN apk add --no-cache git make nodejs-current yarn
|
||||||
ARG CACHEBUST
|
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
@@ -53,7 +48,6 @@ RUN timeout 90 test/update-policy.sh
|
|||||||
# alpine 3.24.3, 2026-11-04
|
# alpine 3.24.3, 2026-11-04
|
||||||
FROM alpine@sha256:be2656061b536c1883c4034790e21d0a09c5aaaf51968b89368a3c0371ea2c9a
|
FROM alpine@sha256:be2656061b536c1883c4034790e21d0a09c5aaaf51968b89368a3c0371ea2c9a
|
||||||
RUN apk add --no-cache git make nodejs-current yarn
|
RUN apk add --no-cache git make nodejs-current yarn
|
||||||
ARG CACHEBUST
|
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
|
|||||||
@@ -116,12 +116,10 @@ alpine. We provide:
|
|||||||
`script/bootstrap`, then `script/install-precommit`
|
`script/bootstrap`, then `script/install-precommit`
|
||||||
- `script/projectname` — output the project name (our own extension); used by
|
- `script/projectname` — output the project name (our own extension); used by
|
||||||
`script/docker` for the image tag
|
`script/docker` for the image tag
|
||||||
- `script/test` —
|
- `script/test` — `docker build --target test --output type=cacheonly .`,
|
||||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --target test --output type=cacheonly .`,
|
|
||||||
building the `test` phase of the `Dockerfile`, which runs
|
building the `test` phase of the `Dockerfile`, which runs
|
||||||
`test/update-policy.sh`, without writing an image
|
`test/update-policy.sh`, without writing an image
|
||||||
- `script/lint` —
|
- `script/lint` — `docker build --target lint --output type=cacheonly .`,
|
||||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --target lint --output type=cacheonly .`,
|
|
||||||
building the `lint` phase, which runs prettier over the markdown files,
|
building the `lint` phase, which runs prettier over the markdown files,
|
||||||
without writing an image
|
without writing an image
|
||||||
- `script/fmt` — format all markdown files with prettier (writes; native, not in
|
- `script/fmt` — format all markdown files with prettier (writes; native, not in
|
||||||
@@ -129,14 +127,13 @@ alpine. We provide:
|
|||||||
- `script/fmt-check` — check formatting (read-only; native)
|
- `script/fmt-check` — check formatting (read-only; native)
|
||||||
- `script/check` — run all checks: `test`, `lint`, `fmt-check` (our own
|
- `script/check` — run all checks: `test`, `lint`, `fmt-check` (our own
|
||||||
extension); builds no image of its own
|
extension); builds no image of its own
|
||||||
- `script/docker` —
|
- `script/docker` — `docker build --build-arg VERSION="$version" -t prompts .`,
|
||||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --build-arg VERSION="$version" -t prompts .`,
|
|
||||||
the tag coming from `script/projectname` (byte-identical across repos)
|
the tag coming from `script/projectname` (byte-identical across repos)
|
||||||
- `script/cibuild` — cd to the repo root, run `script/bootstrap`, run
|
- `script/cibuild` — cd to the repo root, run `script/bootstrap`, run
|
||||||
`script/check`, compute `version` from `git describe`, then
|
`script/check`, compute `version` from `git describe`, then
|
||||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --build-arg VERSION="$version" -t prompts .`
|
`docker build --build-arg VERSION="$version" -t prompts .` (what CI runs; it
|
||||||
(what CI runs; it bootstraps because CI checks out and runs this alone while
|
bootstraps because CI checks out and runs this alone while `script/fmt-check`
|
||||||
`script/fmt-check` is native)
|
is native)
|
||||||
- `script/precommit` — run by the git pre-commit hook (our own extension); calls
|
- `script/precommit` — run by the git pre-commit hook (our own extension); calls
|
||||||
`script/check`
|
`script/check`
|
||||||
- `script/install-precommit` — installs the git pre-commit hook (our own
|
- `script/install-precommit` — installs the git pre-commit hook (our own
|
||||||
@@ -147,23 +144,6 @@ alpine. We provide:
|
|||||||
|
|
||||||
`make hooks` installs the pre-commit hook that runs `script/precommit`.
|
`make hooks` installs the pre-commit hook that runs `script/precommit`.
|
||||||
|
|
||||||
In every stage of a `Dockerfile`, every step that lints, tests or compiles comes
|
|
||||||
after `ARG CACHEBUST`. `ARG CACHEBUST` comes right after these steps:
|
|
||||||
|
|
||||||
- the steps that install system packages
|
|
||||||
- the steps that download Go's modules
|
|
||||||
- the step that runs `script/bootstrap` to install a Python `test` phase's
|
|
||||||
packages from `Pipfile.lock`
|
|
||||||
|
|
||||||
A stage with none of these steps declares `ARG CACHEBUST` right after `FROM`.
|
|
||||||
The `script/` builds pass a new `CACHEBUST` value on every build, which reruns
|
|
||||||
every `RUN` step after that line and leaves the layers above it and the cache
|
|
||||||
mounts in place; `--no-cache` would build those layers again and empty the
|
|
||||||
mounts. This repo's own `Dockerfile` installs git, make, node and yarn right
|
|
||||||
after `FROM` in every stage, above `ARG CACHEBUST`. `script/bootstrap` installs
|
|
||||||
the node packages below that line, because check builds keep system packages but
|
|
||||||
not node packages.
|
|
||||||
|
|
||||||
## Rationale
|
## Rationale
|
||||||
|
|
||||||
LLM prompts, especially development policies, benefit from version control and a
|
LLM prompts, especially development policies, benefit from version control and a
|
||||||
|
|||||||
+120
-10
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Code Styleguide — Go
|
title: Code Styleguide — Go
|
||||||
last_modified: 2026-11-07
|
last_modified: 2026-11-16
|
||||||
---
|
---
|
||||||
|
|
||||||
1. Format Go code with `gofmt` and then `golines -m 77`, through `make fmt`.
|
1. Format Go code with `gofmt` and then `golines -m 77`, through `make fmt`.
|
||||||
@@ -113,13 +113,7 @@ last_modified: 2026-11-07
|
|||||||
1. Write a `Dockerfile` for every repo, even if it only runs the tests and
|
1. Write a `Dockerfile` for every repo, even if it only runs the tests and
|
||||||
linting. It carries the lint and test phases, and the final stage depends on
|
linting. It carries the lint and test phases, and the final stage depends on
|
||||||
both, so a build makes sure the code is in an able-to-be-compiled state,
|
both, so a build makes sure the code is in an able-to-be-compiled state,
|
||||||
linted, and its tests run. Go through `script/cibuild` or `script/docker`
|
linted, and its tests run.
|
||||||
rather than a bare `docker build .`: they pass a new `CACHEBUST` value on
|
|
||||||
every build, which reruns every step that lints, tests or compiles and keeps
|
|
||||||
the system packages, Go's modules and build cache, and golangci-lint's
|
|
||||||
cache; `--no-cache` would throw all of them away. Without a new value an
|
|
||||||
unchanged tree serves the gate layers from cache and the build reports a
|
|
||||||
green it never ran.
|
|
||||||
|
|
||||||
1. Every repo must have a `Makefile`. See
|
1. Every repo must have a `Makefile`. See
|
||||||
[Repository Policies](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md)
|
[Repository Policies](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md)
|
||||||
@@ -176,7 +170,7 @@ last_modified: 2026-11-07
|
|||||||
them a bit long.
|
them a bit long.
|
||||||
|
|
||||||
1. Use descriptive names for modules and filenames. Avoid generic names like
|
1. Use descriptive names for modules and filenames. Avoid generic names like
|
||||||
`server`. `util` is banned.
|
`server`. The rules for package names are under Naming, below.
|
||||||
|
|
||||||
1. Constructors **must** take a `Params` struct (or `ThingParams` when
|
1. Constructors **must** take a `Params` struct (or `ThingParams` when
|
||||||
`NewThing()` is used), even for a single argument. Named fields in a Params
|
`NewThing()` is used), even for a single argument. Named fields in a Params
|
||||||
@@ -221,7 +215,7 @@ last_modified: 2026-11-07
|
|||||||
...
|
...
|
||||||
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
SendErrorResponse(w, MSGenericError)
|
SendErrorResponse(w, ErrBadRequest)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -487,6 +481,122 @@ last_modified: 2026-11-07
|
|||||||
releasable". "Releasable" in this context means that it builds and functions
|
releasable". "Releasable" in this context means that it builds and functions
|
||||||
as expected, and that all tests and linting passes.
|
as expected, and that all tests and linting passes.
|
||||||
|
|
||||||
|
# Naming
|
||||||
|
|
||||||
|
Judge a name where it is read. A caller writes the package name, a dot and the
|
||||||
|
exported name, and reads them as one name: `http.Server`, `list.New`.
|
||||||
|
|
||||||
|
## Package names
|
||||||
|
|
||||||
|
1. Name a package for what it provides (`time`, `list`, `http`), because the
|
||||||
|
caller writes that name in front of everything the package exports.
|
||||||
|
|
||||||
|
1. Write a package name in lowercase letters and digits only, with its words
|
||||||
|
run together (`tabwriter`, never `tab_writer` or `tabWriter`), because that
|
||||||
|
is how the standard library spells every package name.
|
||||||
|
|
||||||
|
1. Never use a package name from the list below, or anything else that says
|
||||||
|
nothing about what is in it, because every program has a data model, helpers
|
||||||
|
and types.
|
||||||
|
- `model` and `models`
|
||||||
|
- `util` and `utils`
|
||||||
|
- `common`
|
||||||
|
- `misc`
|
||||||
|
- `helper` and `helpers`
|
||||||
|
- `types`
|
||||||
|
- `interfaces`
|
||||||
|
- `api`
|
||||||
|
|
||||||
|
1. Split a package whose code is about several things, so that each part can be
|
||||||
|
named for what it provides (`stringset`, not `util`).
|
||||||
|
|
||||||
|
1. Spell a word out unless its short form is the one everybody already uses
|
||||||
|
(`fmt`, `strconv`), because any other abbreviation has to be decoded.
|
||||||
|
|
||||||
|
1. Lengthen a package name that callers want for a variable or that a widely
|
||||||
|
used standard package has (`bufio`, not `buf`; `auditlog`, not `log`),
|
||||||
|
because importers must otherwise rename one of the two.
|
||||||
|
|
||||||
|
1. Give a package's directory the package's name, package `main` excepted, so
|
||||||
|
that the import path ends in the name the code uses.
|
||||||
|
|
||||||
|
1. Name a package that supports the tests of one package after that package
|
||||||
|
plus `test` (`storetest`, never `testutil` or `testhelper`), because the
|
||||||
|
name then says whose tests it is for.
|
||||||
|
|
||||||
|
1. Import a package under its own name unless two imports share a name or its
|
||||||
|
own name breaks these rules, so that a reader knows it without checking the
|
||||||
|
imports.
|
||||||
|
|
||||||
|
1. Give a renamed import the same local name in every file, so that one name
|
||||||
|
always means one package.
|
||||||
|
|
||||||
|
## Exported names
|
||||||
|
|
||||||
|
1. Never repeat the package name inside a longer exported name (`http.Server`,
|
||||||
|
not `http.HTTPServer`; `yamlconfig.Parse`, not
|
||||||
|
`yamlconfig.ParseYAMLConfig`), because the caller has already written it.
|
||||||
|
|
||||||
|
1. Use the same plain name in two packages when it fits both (`bufio.Reader`,
|
||||||
|
`csv.Reader`), because the package name already tells them apart.
|
||||||
|
|
||||||
|
1. Leave the receiver's type out of a method name, and the parameter and result
|
||||||
|
types out of a function name (`(c *Config) WriteTo(w)`, not
|
||||||
|
`WriteConfigTo`), because the signature already states them.
|
||||||
|
|
||||||
|
1. Put a type at the end of a function's name when the type is the only
|
||||||
|
difference between two functions (`ParseInt`, `ParseInt64`), because Go
|
||||||
|
needs a different name for each.
|
||||||
|
|
||||||
|
1. Use a noun for a function that only reports a value (`Owner()`,
|
||||||
|
`JobName(key)`), so that a call reads as the value it gives.
|
||||||
|
|
||||||
|
1. Use a verb for a function that does work, even when it also returns a result
|
||||||
|
(`Parse`, `WriteDetail(w)`), so that a call reads as the work it does.
|
||||||
|
|
||||||
|
1. Never start a getter with `Get` (`Owner()`, not `GetOwner()`; the setter is
|
||||||
|
`SetOwner()`), because the capital letter already tells the method from the
|
||||||
|
field.
|
||||||
|
|
||||||
|
1. Start a getter's name with `Fetch` when it reads the value from a database
|
||||||
|
or the network (`FetchOwner`, never `Owner` or `GetOwner`), because the
|
||||||
|
reader must know the call can be slow or fail.
|
||||||
|
|
||||||
|
1. Name a one-method interface for its method plus `er` (`Reader`,
|
||||||
|
`Formatter`), because the name then says the one thing a value of it does.
|
||||||
|
|
||||||
|
1. Use a well-known method's name and signature for a method that does the same
|
||||||
|
thing (`String()`, never `ToString()`), because readers and the standard
|
||||||
|
interfaces expect them.
|
||||||
|
|
||||||
|
1. Give another name to a method that differs in meaning or signature from a
|
||||||
|
well-known method of the same name (`Read`, `Write`, `Close`, `String`),
|
||||||
|
because readers rely on each name meaning one thing.
|
||||||
|
|
||||||
|
1. Write an initialism in one case throughout (`ServeHTTP`, `appID`, `URL` or
|
||||||
|
`url`; never `Url`, `Id` or `Http`), because that is how the standard
|
||||||
|
library spells them.
|
||||||
|
|
||||||
|
1. Write a constant in MixedCaps like every other name (`MaxPacketSize`, never
|
||||||
|
`MAX_PACKET_SIZE`), because an all-capitals name is exported whether or not
|
||||||
|
that was meant.
|
||||||
|
|
||||||
|
1. Name an error value `Err` plus what went wrong (`ErrNotFound`) and an error
|
||||||
|
type for what went wrong plus `Error` (`NotFoundError`), because callers
|
||||||
|
know a package's errors by those two forms.
|
||||||
|
|
||||||
|
## Local names
|
||||||
|
|
||||||
|
1. Match a local name's length to how far from its declaration it is used (`i`
|
||||||
|
in a short loop), because a reader far from the declaration has only the
|
||||||
|
name.
|
||||||
|
|
||||||
|
1. Name a receiver with one or two letters, never `this`, `self` or `me`,
|
||||||
|
because its role is plain from the method.
|
||||||
|
|
||||||
|
1. Use the same receiver name in every method of a type, so that the name
|
||||||
|
always means the receiver.
|
||||||
|
|
||||||
# Other Golang Tips and Best Practices (Optional)
|
# Other Golang Tips and Best Practices (Optional)
|
||||||
|
|
||||||
1. For any internet-facing http server, set appropriate timeouts and limits to
|
1. For any internet-facing http server, set appropriate timeouts and limits to
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Existing Repo Checklist
|
title: Existing Repo Checklist
|
||||||
last_modified: 2026-11-09
|
last_modified: 2026-11-16
|
||||||
---
|
---
|
||||||
|
|
||||||
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
|
||||||
@@ -49,23 +49,8 @@ with your task.
|
|||||||
`--target` names it, so a lost `COPY --from=` edge leaves `docker build .`
|
`--target` names it, so a lost `COPY --from=` edge leaves `docker build .`
|
||||||
passing while the gate never runs. Confirm by planting a violation, not by
|
passing while the gate never runs. Confirm by planting a violation, not by
|
||||||
reading the file.
|
reading the file.
|
||||||
- [ ] In every stage, every step that lints, tests or compiles comes after
|
|
||||||
`ARG CACHEBUST`. `ARG CACHEBUST` comes right after these steps:
|
|
||||||
- the steps that install system packages
|
|
||||||
- the steps that download Go's modules
|
|
||||||
- the step that runs `script/bootstrap` to install a Python `test` phase's
|
|
||||||
packages from `Pipfile.lock`
|
|
||||||
- [ ] A stage with none of these steps declares `ARG CACHEBUST` right after
|
|
||||||
`FROM`. A step that also installs anything else comes after
|
|
||||||
`ARG CACHEBUST` too. A `script/bootstrap` that also installs node packages
|
|
||||||
is one. The `script/` builds pass a new `CACHEBUST` value on every build,
|
|
||||||
which reruns every `RUN` step after that line and leaves the layers above
|
|
||||||
it and the cache mounts in place; `--no-cache` would build those layers
|
|
||||||
again and empty the mounts. A stage without the `ARG` line is served from
|
|
||||||
cache on an unchanged tree, so the scripts and the `ARG` lines are
|
|
||||||
re-vendored in one commit.
|
|
||||||
- [ ] Go: each Go stage downloads the modules (`COPY go.mod go.sum ./`,
|
- [ ] Go: each Go stage downloads the modules (`COPY go.mod go.sum ./`,
|
||||||
`RUN go mod download`) above `ARG CACHEBUST`; the steps that compile
|
`RUN go mod download`) before `COPY . .`; the steps that compile
|
||||||
(`golangci-lint run`, `go test`, `go build`) mount Go's build cache
|
(`golangci-lint run`, `go test`, `go build`) mount Go's build cache
|
||||||
(`--mount=type=cache,target=/root/.cache/go-build`), `golangci-lint run`
|
(`--mount=type=cache,target=/root/.cache/go-build`), `golangci-lint run`
|
||||||
also mounts golangci-lint's
|
also mounts golangci-lint's
|
||||||
@@ -74,7 +59,7 @@ with your task.
|
|||||||
that timed out gets no rerun, as in the canonical Go `Dockerfile` in
|
that timed out gets no rerun, as in the canonical Go `Dockerfile` in
|
||||||
`REPO_POLICIES.md`
|
`REPO_POLICIES.md`
|
||||||
- [ ] Python: a `test` phase that installs its packages from `Pipfile.lock` does
|
- [ ] Python: a `test` phase that installs its packages from `Pipfile.lock` does
|
||||||
it above `ARG CACHEBUST`, with `COPY script/ script/`,
|
it before `COPY . .`, with `COPY script/ script/`,
|
||||||
`COPY Pipfile Pipfile.lock ./` and `RUN script/bootstrap`. When
|
`COPY Pipfile Pipfile.lock ./` and `RUN script/bootstrap`. When
|
||||||
`script/bootstrap` runs in that step, it installs nothing beyond these:
|
`script/bootstrap` runs in that step, it installs nothing beyond these:
|
||||||
- system packages
|
- system packages
|
||||||
@@ -91,9 +76,8 @@ with your task.
|
|||||||
a package with no wheel for the image stops the install. In that step it
|
a package with no wheel for the image stops the install. In that step it
|
||||||
installs no Python, because a step above it already did. `Pipfile` names no
|
installs no Python, because a step above it already did. `Pipfile` names no
|
||||||
`python_version`, because `--deploy` stops when the distribution's Python
|
`python_version`, because `--deploy` stops when the distribution's Python
|
||||||
differs from it. The tests run after `ARG CACHEBUST`, and every other stage
|
differs from it. The tests run after `COPY . .`, as in the Python `test`
|
||||||
installs its Python packages after it, as in the Python `test` phase example
|
phase example in `REPO_POLICIES.md`
|
||||||
in `REPO_POLICIES.md`
|
|
||||||
|
|
||||||
- [ ] The gate phases invoke their tools directly, never through `make lint` or
|
- [ ] The gate phases invoke their tools directly, never through `make lint` or
|
||||||
`script/test` — those are themselves a `docker build` and would recurse
|
`script/test` — those are themselves a `docker build` and would recurse
|
||||||
@@ -223,23 +207,21 @@ with your task.
|
|||||||
- [ ] README has an **Entrypoints** section documenting the `script/`
|
- [ ] README has an **Entrypoints** section documenting the `script/`
|
||||||
entrypoints and linking the standard
|
entrypoints and linking the standard
|
||||||
- [ ] `script/lint` and `script/test` each run
|
- [ ] `script/lint` and `script/test` each run
|
||||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --target <phase> --output type=cacheonly .`,
|
`docker build --target <phase> --output type=cacheonly .`, which builds
|
||||||
which builds their phase by name and writes no image, and no host
|
their phase by name and writes no image, and no host invocation anywhere
|
||||||
invocation anywhere in the repo can produce a lint verdict — grep for the
|
in the repo can produce a lint verdict — grep for the linter's own name
|
||||||
linter's own name across `script/`, the `Makefile` and CI config, not just
|
across `script/`, the `Makefile` and CI config, not just `script/lint`. A
|
||||||
`script/lint`. A second path is likeliest here: a `make lint-fast`, an
|
second path is likeliest here: a `make lint-fast`, an older
|
||||||
older host-versus-container branch, or a CI step calling the binary
|
host-versus-container branch, or a CI step calling the binary directly.
|
||||||
directly. `script/fmt` and `script/fmt-check` are expected hits and stay
|
`script/fmt` and `script/fmt-check` are expected hits and stay on the
|
||||||
on the host.
|
host.
|
||||||
- [ ] No `docker build` in `script/` leaves a dangling image behind:
|
- [ ] No `docker build` in `script/` leaves a dangling image behind:
|
||||||
`script/lint` and `script/test` write no image, and `script/docker` and
|
`script/lint` and `script/test` write no image, and `script/docker` and
|
||||||
`script/cibuild` tag theirs. A build that writes an untagged image leaves
|
`script/cibuild` tag theirs. A build that writes an untagged image leaves
|
||||||
one behind on every run, on every host and CI runner.
|
one behind on every run, on every host and CI runner.
|
||||||
- [ ] `script/cibuild` runs `script/bootstrap` before `script/check`, and builds
|
- [ ] `script/cibuild` runs `script/bootstrap` before `script/check`. Without
|
||||||
the image with a new `CACHEBUST` value on every build, like every
|
the bootstrap the CI run dies in `script/fmt-check`, which runs the
|
||||||
`docker build` in `script/`. Without the bootstrap the CI run dies in
|
formatter on the host and finds nothing installed.
|
||||||
`script/fmt-check`, which runs the formatter on the host and finds nothing
|
|
||||||
installed.
|
|
||||||
- [ ] `script/bootstrap` installs node, yarn and the node packages only when
|
- [ ] `script/bootstrap` installs node, yarn and the node packages only when
|
||||||
`yarn.lock` is in the tree. node and yarn come from the distribution when
|
`yarn.lock` is in the tree. node and yarn come from the distribution when
|
||||||
they are missing. It installs the node packages with
|
they are missing. It installs the node packages with
|
||||||
@@ -327,14 +309,7 @@ with your task.
|
|||||||
- [ ] `script/cibuild` succeeds in a fresh clone on a host carrying what CI has.
|
- [ ] `script/cibuild` succeeds in a fresh clone on a host carrying what CI has.
|
||||||
That host is the runner image
|
That host is the runner image
|
||||||
`docker.gitea.com/runner-images:ubuntu-latest`, which has docker, git and
|
`docker.gitea.com/runner-images:ubuntu-latest`, which has docker, git and
|
||||||
node 24. Take any yarn off `PATH` first. The run must show that the checks
|
node 24. Take any yarn off `PATH` first.
|
||||||
executed. A sub-second build means nothing ran. So does `CACHED` on a step
|
|
||||||
that lints or tests, one of the `RUN` steps below `ARG CACHEBUST`. Above
|
|
||||||
that line, these steps are expected to show `CACHED`:
|
|
||||||
- the steps that install system packages
|
|
||||||
- the steps that download Go's modules
|
|
||||||
- the step that runs `script/bootstrap` to install a Python `test` phase's
|
|
||||||
packages from `Pipfile.lock`
|
|
||||||
- [ ] A planted lint violation fails both `make lint` and a plain
|
- [ ] A planted lint violation fails both `make lint` and a plain
|
||||||
`docker build .`; revert it afterwards
|
`docker build .`; revert it afterwards
|
||||||
- [ ] Commit and merge fixes before starting your actual task
|
- [ ] Commit and merge fixes before starting your actual task
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: New Repo Checklist
|
title: New Repo Checklist
|
||||||
last_modified: 2026-11-09
|
last_modified: 2026-11-16
|
||||||
---
|
---
|
||||||
|
|
||||||
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
|
||||||
@@ -118,23 +118,8 @@ Template files can be fetched from:
|
|||||||
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
|
||||||
cannot be built unless both passed. Keep the final stage last: a stage
|
cannot be built unless both passed. Keep the final stage last: a stage
|
||||||
nothing depends on is built only when `--target` names it.
|
nothing depends on is built only when `--target` names it.
|
||||||
- In every stage, every step that lints, tests or compiles comes after
|
|
||||||
`ARG CACHEBUST`. `ARG CACHEBUST` comes right after these steps:
|
|
||||||
- the steps that install system packages
|
|
||||||
- the steps that download Go's modules
|
|
||||||
- the step that runs `script/bootstrap` to install a Python `test`
|
|
||||||
phase's packages from `Pipfile.lock`
|
|
||||||
- A stage with none of these steps declares `ARG CACHEBUST` right after
|
|
||||||
`FROM`. A step that also installs anything else comes after
|
|
||||||
`ARG CACHEBUST` too. A `script/bootstrap` that also installs node packages
|
|
||||||
is one. The `script/` builds pass a new `CACHEBUST` value on every build,
|
|
||||||
which reruns every `RUN` step after that line and leaves the layers above
|
|
||||||
it and the cache mounts in place; `--no-cache` would build those layers
|
|
||||||
again and empty the mounts. A stage without the `ARG` line is served from
|
|
||||||
cache on an unchanged tree, so the scripts and every stage's
|
|
||||||
`ARG CACHEBUST` line are added in the same commit.
|
|
||||||
- Go: each Go stage downloads the modules (`COPY go.mod go.sum ./`,
|
- Go: each Go stage downloads the modules (`COPY go.mod go.sum ./`,
|
||||||
`RUN go mod download`) above `ARG CACHEBUST`; the steps that compile
|
`RUN go mod download`) before `COPY . .`; the steps that compile
|
||||||
(`golangci-lint run`, `go test`, `go build`) mount Go's build cache
|
(`golangci-lint run`, `go test`, `go build`) mount Go's build cache
|
||||||
(`--mount=type=cache,target=/root/.cache/go-build`), `golangci-lint run`
|
(`--mount=type=cache,target=/root/.cache/go-build`), `golangci-lint run`
|
||||||
also mounts golangci-lint's
|
also mounts golangci-lint's
|
||||||
@@ -143,7 +128,7 @@ Template files can be fetched from:
|
|||||||
that timed out gets no rerun, as in the canonical Go `Dockerfile` in
|
that timed out gets no rerun, as in the canonical Go `Dockerfile` in
|
||||||
`REPO_POLICIES.md`
|
`REPO_POLICIES.md`
|
||||||
- Python: a `test` phase that installs its packages from `Pipfile.lock` does
|
- Python: a `test` phase that installs its packages from `Pipfile.lock` does
|
||||||
it above `ARG CACHEBUST`, with `COPY script/ script/`,
|
it before `COPY . .`, with `COPY script/ script/`,
|
||||||
`COPY Pipfile Pipfile.lock ./` and `RUN script/bootstrap`. When
|
`COPY Pipfile Pipfile.lock ./` and `RUN script/bootstrap`. When
|
||||||
`script/bootstrap` runs in that step, it installs nothing beyond these:
|
`script/bootstrap` runs in that step, it installs nothing beyond these:
|
||||||
- system packages
|
- system packages
|
||||||
@@ -161,8 +146,7 @@ Template files can be fetched from:
|
|||||||
for the image stops the install. In that step it installs no Python,
|
for the image stops the install. In that step it installs no Python,
|
||||||
because a step above it already did. `Pipfile` names no
|
because a step above it already did. `Pipfile` names no
|
||||||
`python_version`, because `--deploy` stops when the distribution's
|
`python_version`, because `--deploy` stops when the distribution's
|
||||||
Python differs from it. The tests run after `ARG CACHEBUST`, and every
|
Python differs from it. The tests run after `COPY . .`, as in the Python
|
||||||
other stage installs its Python packages after it, as in the Python
|
|
||||||
`test` phase example in `REPO_POLICIES.md`
|
`test` phase example in `REPO_POLICIES.md`
|
||||||
|
|
||||||
- Server: the final stage builds and runs the application
|
- Server: the final stage builds and runs the application
|
||||||
@@ -227,13 +211,12 @@ are thin shims calling them. Model scripts:
|
|||||||
- [ ] `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` —
|
- [ ] `script/test` / `make test` —
|
||||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --target test --output type=cacheonly .`,
|
`docker build --target test --output type=cacheonly .`, which writes no
|
||||||
which writes no image; the phase runs real tests, not a no-op (90-second
|
image; the phase runs real tests, not a no-op (90-second timeout,
|
||||||
timeout, 60-second hard cap on wall time)
|
60-second hard cap on wall time)
|
||||||
- [ ] `script/lint` / `make lint` —
|
- [ ] `script/lint` / `make lint` —
|
||||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --target lint --output type=cacheonly .`,
|
`docker build --target lint --output type=cacheonly .`, which writes no
|
||||||
which writes no image. No lint verdict may come from a host invocation of
|
image. No lint verdict may come from a host invocation of the linter.
|
||||||
the linter.
|
|
||||||
- [ ] `script/fmt` / `make fmt` — formats code (writes; native, never in a
|
- [ ] `script/fmt` / `make fmt` — formats code (writes; native, never in a
|
||||||
container). Go code gets `gofmt`, then `golines -m 77`.
|
container). Go code gets `gofmt`, then `golines -m 77`.
|
||||||
- [ ] `script/fmt-check` / `make fmt-check` — checks formatting (read-only;
|
- [ ] `script/fmt-check` / `make fmt-check` — checks formatting (read-only;
|
||||||
@@ -245,16 +228,15 @@ are thin shims calling them. Model scripts:
|
|||||||
- [ ] `script/projectname` — outputs the project name (used by `script/docker`
|
- [ ] `script/projectname` — outputs the project name (used by `script/docker`
|
||||||
for the image tag)
|
for the image tag)
|
||||||
- [ ] `script/docker` / `make docker` — builds Docker image, tagged via
|
- [ ] `script/docker` / `make docker` — builds Docker image, tagged via
|
||||||
`script/projectname` (byte-identical across repos); a new `CACHEBUST`
|
`script/projectname` (byte-identical across repos), with the version as a
|
||||||
value on every build, plus the version as a build arg
|
build arg
|
||||||
- [ ] `script/cibuild` — cd to repo root, run `script/bootstrap`, run
|
- [ ] `script/cibuild` — cd to repo root, run `script/bootstrap`, run
|
||||||
`script/check`, then
|
`script/check`, then
|
||||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --build-arg VERSION="$version" -t "$tag" .`
|
`docker build --build-arg VERSION="$version" -t "$tag" .` (what CI runs),
|
||||||
(what CI runs), with `$version` from
|
with `$version` from `git describe --tags --always --dirty` (`unknown` if
|
||||||
`git describe --tags --always --dirty` (`unknown` if empty) and `$tag`
|
empty) and `$tag` from `script/projectname`, each assigned on its own line
|
||||||
from `script/projectname`, each assigned on its own line before the build.
|
before the build. The bootstrap is required: CI checks out and runs this
|
||||||
The bootstrap is required: CI checks out and runs this alone, and
|
alone, and `script/fmt-check` runs the formatter on the host.
|
||||||
`script/fmt-check` runs the formatter on the host.
|
|
||||||
- [ ] `script/bootstrap`, `script/fmt` and `script/fmt-check` run yarn by
|
- [ ] `script/bootstrap`, `script/fmt` and `script/fmt-check` run yarn by
|
||||||
whichever name is present: `yarn`, or `yarnpkg` on Debian and Ubuntu. With
|
whichever name is present: `yarn`, or `yarnpkg` on Debian and Ubuntu. With
|
||||||
neither name on `PATH`, `script/fmt` and `script/fmt-check` print one line
|
neither name on `PATH`, `script/fmt` and `script/fmt-check` print one line
|
||||||
@@ -279,14 +261,7 @@ are thin shims calling them. Model scripts:
|
|||||||
- [ ] `script/cibuild` succeeds in a fresh clone on a host carrying what CI has.
|
- [ ] `script/cibuild` succeeds in a fresh clone on a host carrying what CI has.
|
||||||
That host is the runner image
|
That host is the runner image
|
||||||
`docker.gitea.com/runner-images:ubuntu-latest`, which has docker, git and
|
`docker.gitea.com/runner-images:ubuntu-latest`, which has docker, git and
|
||||||
node 24. Take any yarn off `PATH` first. The run must show that the checks
|
node 24. Take any yarn off `PATH` first.
|
||||||
executed. A sub-second build means nothing ran. So does `CACHED` on a step
|
|
||||||
that lints or tests, one of the `RUN` steps below `ARG CACHEBUST`. Above
|
|
||||||
that line, these steps are expected to show `CACHED`:
|
|
||||||
- the steps that install system packages
|
|
||||||
- the steps that download Go's modules
|
|
||||||
- the step that runs `script/bootstrap` to install a Python `test` phase's
|
|
||||||
packages from `Pipfile.lock`
|
|
||||||
- [ ] Plant a lint violation and confirm both `make lint` and a plain
|
- [ ] Plant a lint violation and confirm both `make lint` and a plain
|
||||||
`docker build .` fail on it; revert. A plain build that passes proves the
|
`docker build .` fail on it; revert. A plain build that passes proves the
|
||||||
final stage is missing its `COPY --from=` edge to the gate phases.
|
final stage is missing its `COPY --from=` edge to the gate phases.
|
||||||
|
|||||||
+40
-110
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Repository Policies
|
title: Repository Policies
|
||||||
last_modified: 2026-11-09
|
last_modified: 2026-11-16
|
||||||
---
|
---
|
||||||
|
|
||||||
This document covers repository structure, tooling, and workflow standards. Code
|
This document covers repository structure, tooling, and workflow standards. Code
|
||||||
@@ -254,10 +254,8 @@ style conventions are in separate documents:
|
|||||||
phase and nothing else:
|
phase and nothing else:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
docker build --target lint --output type=cacheonly .
|
||||||
--target lint --output type=cacheonly .
|
docker build --target test --output type=cacheonly .
|
||||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
|
||||||
--target test --output type=cacheonly .
|
|
||||||
```
|
```
|
||||||
|
|
||||||
**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
|
||||||
@@ -275,7 +273,8 @@ style conventions are in separate documents:
|
|||||||
CI runner. `script/cibuild` and `script/docker` build the image that ships
|
CI runner. `script/cibuild` and `script/docker` build the image that ships
|
||||||
and tag it, so each build replaces the previous image. Each script assigns
|
and tag it, so each build replaces the previous image. Each script assigns
|
||||||
the tag on its own line before the build, so `set -e` stops it where
|
the tag on its own line before the build, so `set -e` stops it where
|
||||||
`script/projectname` fails.
|
`script/projectname` fails. `script/check` runs the two gate phases and
|
||||||
|
`script/fmt-check`, and builds no image of its own.
|
||||||
|
|
||||||
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`. The tool is never invoked through `make lint` or
|
`eslint`, `prettier`. The tool is never invoked through `make lint` or
|
||||||
@@ -298,55 +297,6 @@ style conventions are in separate documents:
|
|||||||
- the settings
|
- the settings
|
||||||
- the golangci-lint version
|
- the golangci-lint version
|
||||||
|
|
||||||
- **Any build that runs checks is given a new `CACHEBUST` value.** Docker
|
|
||||||
invalidates a `COPY` layer only when the copied content changes. On an
|
|
||||||
unchanged tree the check `RUN` is therefore served from cache, nothing
|
|
||||||
executes, and the build still exits 0. Every `docker build` in `script/`
|
|
||||||
therefore passes `--build-arg CACHEBUST="$(date +%s)-$$"`, the time and the
|
|
||||||
script's process id. So no two builds share a value, not even the three in one
|
|
||||||
`script/cibuild`. Four scripts do this, and there is no fifth:
|
|
||||||
- `script/lint`
|
|
||||||
- `script/test`
|
|
||||||
- `script/cibuild`
|
|
||||||
- `script/docker`
|
|
||||||
|
|
||||||
`script/check` runs the two gate phases and `script/fmt-check`, and builds
|
|
||||||
no image of its own. In every stage of the `Dockerfile`, every step that
|
|
||||||
lints, tests or compiles comes after `ARG CACHEBUST`. `ARG CACHEBUST` comes
|
|
||||||
right after these steps:
|
|
||||||
- the steps that install system packages
|
|
||||||
- the steps that download Go's modules
|
|
||||||
- the step that runs `script/bootstrap` to install a Python `test` phase's
|
|
||||||
packages from `Pipfile.lock`
|
|
||||||
|
|
||||||
A stage with none of these steps declares `ARG CACHEBUST` right after
|
|
||||||
`FROM`. A step that also installs anything else comes after `ARG CACHEBUST`
|
|
||||||
too. A `script/bootstrap` that also installs node packages is one. A new
|
|
||||||
value reruns every `RUN` step after that line; `COPY` steps are compared by
|
|
||||||
content and need nothing. Docker keeps the layers above the line until one
|
|
||||||
of these changes:
|
|
||||||
- the base image
|
|
||||||
- their own lines
|
|
||||||
- the files they copy
|
|
||||||
|
|
||||||
A stage without the `ARG` line is served from cache on an unchanged tree, so
|
|
||||||
a repository re-vendors the scripts and adds the `ARG` lines in one commit.
|
|
||||||
The scripts do not pass `--no-cache`. That flag reruns every step too, but
|
|
||||||
it also builds the layers above the line again and empties every cache
|
|
||||||
mount. Go's build cache and golangci-lint's would then start empty every
|
|
||||||
time; the canonical Go `Dockerfile` below mounts them so that they survive
|
|
||||||
between check builds. A bare `docker build .` is not evidence that anything
|
|
||||||
ran: a sub-second build reporting success is a cache hit, not a result.
|
|
||||||
Never invalidate by pruning: `docker builder prune` and friends destroy a
|
|
||||||
build cache shared with every other build on the host. When a check is added
|
|
||||||
or changed, prove it works:
|
|
||||||
- plant a defect it must catch
|
|
||||||
- watch the run fail on it
|
|
||||||
- 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
|
||||||
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.
|
||||||
@@ -354,12 +304,8 @@ style conventions are in separate documents:
|
|||||||
`Dockerfile`:
|
`Dockerfile`:
|
||||||
|
|
||||||
```dockerfile
|
```dockerfile
|
||||||
# In every stage ARG CACHEBUST comes right after the steps that install
|
# The steps that install system packages and download Go's modules
|
||||||
# system packages and download Go's modules, or right after FROM in a
|
# come before COPY . ., so a change to the code keeps their layers.
|
||||||
# stage with neither, and every step that lints, tests or compiles
|
|
||||||
# comes after it. script/ passes a new value on every build, which
|
|
||||||
# reruns every RUN step after it. Docker keeps the layers above it
|
|
||||||
# until the base image, their own lines or go.mod and go.sum change.
|
|
||||||
# The steps that compile mount Go's build cache, and golangci-lint run
|
# The steps that compile mount Go's build cache, and golangci-lint run
|
||||||
# also mounts golangci-lint's; both survive from build to build.
|
# also mounts golangci-lint's; both survive from build to build.
|
||||||
|
|
||||||
@@ -369,7 +315,6 @@ style conventions are in separate documents:
|
|||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
ARG CACHEBUST
|
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN --mount=type=cache,target=/root/.cache/go-build \
|
RUN --mount=type=cache,target=/root/.cache/go-build \
|
||||||
--mount=type=cache,target=/root/.cache/golangci-lint \
|
--mount=type=cache,target=/root/.cache/golangci-lint \
|
||||||
@@ -385,7 +330,6 @@ style conventions are in separate documents:
|
|||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
ARG CACHEBUST
|
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN --mount=type=cache,target=/root/.cache/go-build \
|
RUN --mount=type=cache,target=/root/.cache/go-build \
|
||||||
status=0; \
|
status=0; \
|
||||||
@@ -410,7 +354,6 @@ style conventions are in separate documents:
|
|||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
ARG CACHEBUST
|
|
||||||
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
|
||||||
# A tar-stream context keeps the sender's file owners, which git refuses.
|
# A tar-stream context keeps the sender's file owners, which git refuses.
|
||||||
@@ -436,7 +379,6 @@ style conventions are in separate documents:
|
|||||||
|
|
||||||
# Runtime stage, and the last one
|
# Runtime stage, and the last one
|
||||||
FROM alpine@sha256:...
|
FROM alpine@sha256:...
|
||||||
ARG CACHEBUST
|
|
||||||
COPY --from=builder /app /usr/local/bin/app
|
COPY --from=builder /app /usr/local/bin/app
|
||||||
ENTRYPOINT ["app"]
|
ENTRYPOINT ["app"]
|
||||||
```
|
```
|
||||||
@@ -452,15 +394,15 @@ style conventions are in separate documents:
|
|||||||
two copies. A plain `docker build .` builds the last stage's chain and
|
two copies. A plain `docker build .` builds the last stage's chain and
|
||||||
nothing else.
|
nothing else.
|
||||||
- Check builds keep these, and none of them can hand back a stale result:
|
- Check builds keep these, and none of them can hand back a stale result:
|
||||||
- The layers above `ARG CACHEBUST`: the system packages and Go's
|
- The layers of the system packages and Go's modules. Docker installs
|
||||||
modules. Docker installs the packages again when the base image or the
|
the packages again when the base image or the install line changes.
|
||||||
install line changes. Docker downloads the modules again when `go.mod`
|
Docker downloads the modules again when `go.mod` or `go.sum` changes.
|
||||||
or `go.sum` changes. Go checks every module against `go.sum` as it
|
Go checks every module against `go.sum` as it downloads it, and no
|
||||||
downloads it, and no later build can change a kept layer. The modules
|
later build can change a kept layer. The modules are kept in a layer
|
||||||
are kept in a layer rather than a cache mount. A cache mount is shared
|
rather than a cache mount. A cache mount is shared by every build on
|
||||||
by every build on the host, and Go builds from whatever files the
|
the host, and Go builds from whatever files the mount holds without
|
||||||
mount holds without checking them again (only `go mod verify` does). A
|
checking them again (only `go mod verify` does). A file changed there
|
||||||
file changed there would go unnoticed.
|
would go unnoticed.
|
||||||
- Go's build cache (`/root/.cache/go-build`, where Go keeps it for
|
- Go's build cache (`/root/.cache/go-build`, where Go keeps it for
|
||||||
root), mounted on the steps that compile: `golangci-lint run`, both
|
root), mounted on the steps that compile: `golangci-lint run`, both
|
||||||
`go test` runs and `go build`. Go reuses a compiled package only when
|
`go test` runs and `go build`. Go reuses a compiled package only when
|
||||||
@@ -487,8 +429,8 @@ style conventions are in separate documents:
|
|||||||
(`libvips-dev`, where alpine says `vips-dev`), and delete the package
|
(`libvips-dev`, where alpine says `vips-dev`), and delete the package
|
||||||
lists in the same `RUN`, so the layer does not keep them. The test phase,
|
lists in the same `RUN`, so the layer does not keep them. The test phase,
|
||||||
on the Debian Go image, installs the libraries its tests need the same
|
on the Debian Go image, installs the libraries its tests need the same
|
||||||
way. Either install goes right after `FROM`, above `ARG CACHEBUST`, so
|
way. Either install goes right after `FROM`, so Docker keeps it until the
|
||||||
Docker keeps it until the base image or the install line changes:
|
base image or the install line changes:
|
||||||
|
|
||||||
```dockerfile
|
```dockerfile
|
||||||
FROM golangci/golangci-lint@sha256:... AS lint
|
FROM golangci/golangci-lint@sha256:... AS lint
|
||||||
@@ -498,7 +440,6 @@ style conventions are in separate documents:
|
|||||||
WORKDIR /src
|
WORKDIR /src
|
||||||
COPY go.mod go.sum ./
|
COPY go.mod go.sum ./
|
||||||
RUN go mod download
|
RUN go mod download
|
||||||
ARG CACHEBUST
|
|
||||||
```
|
```
|
||||||
|
|
||||||
- `.dockerignore` lets `.git` into the build context. It keeps out every git
|
- `.dockerignore` lets `.git` into the build context. It keeps out every git
|
||||||
@@ -539,21 +480,19 @@ style conventions are in separate documents:
|
|||||||
already do.
|
already do.
|
||||||
|
|
||||||
- **A Python `test` phase that installs its packages from `Pipfile.lock` does it
|
- **A Python `test` phase that installs its packages from `Pipfile.lock` does it
|
||||||
above `ARG CACHEBUST`, so check builds keep them.** The steps are:
|
before `COPY . .`, so check builds keep them.** The steps are:
|
||||||
- `COPY script/ script/`
|
- `COPY script/ script/`
|
||||||
- `COPY Pipfile Pipfile.lock ./`
|
- `COPY Pipfile Pipfile.lock ./`
|
||||||
- `RUN script/bootstrap`
|
- `RUN script/bootstrap`
|
||||||
|
|
||||||
`ARG CACHEBUST` comes right after them. Docker keeps what that `RUN`
|
Docker keeps what that `RUN` installed until one of these changes:
|
||||||
installed until one of these changes:
|
|
||||||
- the base image
|
- the base image
|
||||||
- `script/`
|
- `script/`
|
||||||
- `Pipfile`
|
- `Pipfile`
|
||||||
- `Pipfile.lock`
|
- `Pipfile.lock`
|
||||||
- a line up to and including the `RUN`
|
- a line up to and including the `RUN`
|
||||||
|
|
||||||
The tests run after `ARG CACHEBUST`, on every check build. In every other
|
The tests run after `COPY . .`.
|
||||||
stage, a step that installs Python packages comes after `ARG CACHEBUST`.
|
|
||||||
- When `script/bootstrap` runs in that step, it installs nothing beyond
|
- When `script/bootstrap` runs in that step, it installs nothing beyond
|
||||||
these:
|
these:
|
||||||
- system packages
|
- system packages
|
||||||
@@ -561,8 +500,7 @@ style conventions are in separate documents:
|
|||||||
- the packages from `Pipfile.lock`
|
- the packages from `Pipfile.lock`
|
||||||
|
|
||||||
`script/bootstrap` installs no Python there: the tests use the
|
`script/bootstrap` installs no Python there: the tests use the
|
||||||
distribution's Python, which a step above it installs. If it installs
|
distribution's Python, which a step above it installs.
|
||||||
anything else there, the step goes after `ARG CACHEBUST`.
|
|
||||||
|
|
||||||
- Debian's Python refuses a system-wide `pip install`, so pipenv goes in a
|
- Debian's Python refuses a system-wide `pip install`, so pipenv goes in a
|
||||||
virtual environment at `$HOME/.pipenv`. `script/bootstrap` creates it with
|
virtual environment at `$HOME/.pipenv`. `script/bootstrap` creates it with
|
||||||
@@ -644,7 +582,6 @@ style conventions are in separate documents:
|
|||||||
COPY script/ script/
|
COPY script/ script/
|
||||||
COPY Pipfile Pipfile.lock ./
|
COPY Pipfile Pipfile.lock ./
|
||||||
RUN script/bootstrap
|
RUN script/bootstrap
|
||||||
ARG CACHEBUST
|
|
||||||
COPY . .
|
COPY . .
|
||||||
RUN timeout 90 sh -c 'pipenv run pytest || { \
|
RUN timeout 90 sh -c 'pipenv run pytest || { \
|
||||||
echo "--- Rerunning with -v for details ---"; \
|
echo "--- Rerunning with -v for details ---"; \
|
||||||
@@ -663,20 +600,16 @@ style conventions are in separate documents:
|
|||||||
A new push then cancels the older run on the same branch, queued or running,
|
A new push then 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.
|
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,
|
`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
|
so a successful run means every check passed. The `check` job sets
|
||||||
carry the same guarantee, because its gate phases may come from the cache. The
|
`timeout-minutes: 20`, so a hung build frees the shared runner after 20
|
||||||
image build gets a `CACHEBUST` value of its own and so runs the gate phases a
|
minutes. That allows for the three Docker builds described above, each held to
|
||||||
second time. That is the price of the rule above, and it is worth paying. The
|
the 5-minute Docker build limit below, plus the bootstrap. Those builds are
|
||||||
image that ships is built from a run of its own gates rather than from a cache
|
the test phase, the lint phase, then the image. A separate workflow limited to
|
||||||
entry. The `check` job sets `timeout-minutes: 20`, so a hung build frees the
|
`main` by a `branches` list under `on: push` cannot be checked by review. To
|
||||||
shared runner after 20 minutes. That allows for the three Docker builds
|
try a change to it, add the feature branch to that list and push, then remove
|
||||||
described above, each held to the 5-minute Docker build limit below, plus the
|
the branch from the list again before merging. Keep any job in it that
|
||||||
bootstrap. Those builds are the test phase, the lint phase, then the image. A
|
publishes behind `if: github.ref_name == 'main'`, so the run from the feature
|
||||||
separate workflow limited to `main` by a `branches` list under `on: push`
|
branch publishes nothing.
|
||||||
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:
|
- Use platform-standard formatters:
|
||||||
- `black` for Python
|
- `black` for Python
|
||||||
@@ -781,14 +714,13 @@ style conventions are in separate documents:
|
|||||||
tests. It leaves the build cache alone, so it costs the runtime of the suite
|
tests. It leaves the build cache alone, so it costs the runtime of the suite
|
||||||
and no recompilation.
|
and no recompilation.
|
||||||
|
|
||||||
That cache is Go's own, separate from Docker's layer cache. Go stores a
|
That cache is Go's own. Go stores a passing result in its cache directory
|
||||||
passing result in its cache directory (`GOCACHE`). When the same tests run
|
(`GOCACHE`). When the same tests run again on unchanged code, it prints that
|
||||||
again on unchanged code, it prints that result, marked `(cached)`, without
|
result, marked `(cached)`, without running them. The directory lasts from
|
||||||
running them. The directory lasts from one run to the next on a developer's
|
one run to the next on a developer's machine, where this target runs. The
|
||||||
machine, where this target runs. The directory also lasts in the `test`
|
directory also lasts in the `test` phase of the `Dockerfile`, which mounts
|
||||||
phase of the `Dockerfile`, which mounts it to keep compiled packages between
|
it to keep compiled packages between check builds, so the phase's `go test`
|
||||||
check builds, so the phase's `go test` runs carry `-count=1` too. A new
|
runs carry `-count=1` too.
|
||||||
`CACHEBUST` value (above) is what makes that step run on an unchanged tree.
|
|
||||||
|
|
||||||
Python example:
|
Python example:
|
||||||
|
|
||||||
@@ -891,9 +823,7 @@ style conventions are in separate documents:
|
|||||||
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)"
|
tag="$(script/projectname)"
|
||||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
docker build --build-arg VERSION="$version" -t "$tag" .
|
||||||
--build-arg VERSION="$version" \
|
|
||||||
-t "$tag" .
|
|
||||||
```
|
```
|
||||||
|
|
||||||
`--always` makes an untagged repo yield an abbreviated commit hash rather
|
`--always` makes an untagged repo yield an abbreviated commit hash rather
|
||||||
|
|||||||
+1
-9
@@ -2,12 +2,6 @@
|
|||||||
# script/cibuild: run the CI build. It bootstraps first: a CI runner
|
# script/cibuild: run the CI build. It bootstraps first: a CI runner
|
||||||
# checks out and runs this and nothing else, and script/fmt-check runs
|
# checks out and runs this and nothing else, and script/fmt-check runs
|
||||||
# the formatter on the host, which a pristine checkout cannot do.
|
# the formatter on the host, which a pristine checkout cannot do.
|
||||||
# A new CACHEBUST value reruns every RUN step after the ARG CACHEBUST
|
|
||||||
# line, since a cached gate phase is a check that did not run; unlike
|
|
||||||
# --no-cache, it keeps the layers above that line and the cache mounts.
|
|
||||||
# This relies on every stage of the Dockerfile declaring ARG CACHEBUST
|
|
||||||
# before every step that lints, tests or compiles; a stage without that
|
|
||||||
# line is served from cache on an unchanged tree, with no warning.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
@@ -25,9 +19,7 @@ main() {
|
|||||||
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")"
|
tag="$("$SCRIPT_DIR/projectname")"
|
||||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
docker build --build-arg VERSION="$version" -t "$tag" .
|
||||||
--build-arg VERSION="$version" \
|
|
||||||
-t "$tag" .
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
+1
-9
@@ -1,12 +1,6 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/docker: build the Docker image tagged with the project name.
|
# script/docker: build the Docker image tagged with the project name.
|
||||||
# Identical in all repos; the tag comes from script/projectname.
|
# Identical in all repos; the tag comes from script/projectname.
|
||||||
# A new CACHEBUST value reruns every RUN step after the ARG CACHEBUST
|
|
||||||
# line, since a cached gate phase is a check that did not run; unlike
|
|
||||||
# --no-cache, it keeps the layers above that line and the cache mounts.
|
|
||||||
# This relies on every stage of the Dockerfile declaring ARG CACHEBUST
|
|
||||||
# before every step that lints, tests or compiles; a stage without that
|
|
||||||
# line is served from cache on an unchanged tree, with no warning.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
@@ -22,9 +16,7 @@ main() {
|
|||||||
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")"
|
tag="$("$SCRIPT_DIR/projectname")"
|
||||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
docker build --build-arg VERSION="$version" -t "$tag" .
|
||||||
--build-arg VERSION="$version" \
|
|
||||||
-t "$tag" .
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
+2
-11
@@ -5,14 +5,7 @@
|
|||||||
# make its answer untrustworthy.
|
# make its answer untrustworthy.
|
||||||
#
|
#
|
||||||
# --target builds the lint phase and the stages it depends on, nothing
|
# --target builds the lint phase and the stages it depends on, nothing
|
||||||
# else. A new CACHEBUST value reruns every RUN step after
|
# else. --output type=cacheonly writes no image, since nothing uses one.
|
||||||
# the ARG CACHEBUST line, since a cached lint layer is a lint that did
|
|
||||||
# not run; unlike --no-cache, it keeps the layers above that line and
|
|
||||||
# the cache mounts. This relies on every stage of the Dockerfile
|
|
||||||
# declaring ARG CACHEBUST before every step that lints, tests or
|
|
||||||
# compiles; a stage without that line is served from cache on an
|
|
||||||
# unchanged tree, with no warning.
|
|
||||||
# --output type=cacheonly writes no image, since nothing uses one.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
@@ -20,9 +13,7 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
docker build --target lint --output type=cacheonly .
|
||||||
--target lint \
|
|
||||||
--output type=cacheonly .
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
+3
-10
@@ -2,13 +2,8 @@
|
|||||||
# script/test: run the test suite. Testing is a phase of the Dockerfile
|
# script/test: run the test suite. Testing is a phase of the Dockerfile
|
||||||
# and this builds that phase, on the same terms as script/lint:
|
# and this builds that phase, on the same terms as script/lint:
|
||||||
# --target so that only the test phase and the stages it depends on are
|
# --target so that only the test phase and the stages it depends on are
|
||||||
# built, and a new CACHEBUST value because a cached test layer is a test
|
# built, and --output type=cacheonly so that no image is written, since
|
||||||
# that did not run; unlike --no-cache, it keeps the layers above the ARG
|
# nothing uses one.
|
||||||
# CACHEBUST line and the cache mounts. This relies on every stage of the
|
|
||||||
# Dockerfile declaring ARG CACHEBUST before every step that lints, tests
|
|
||||||
# or compiles; a stage without that line is served from cache on an
|
|
||||||
# unchanged tree, with no warning. --output type=cacheonly writes no
|
|
||||||
# image, since nothing uses one.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
@@ -16,9 +11,7 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
|||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
docker build --target test --output type=cacheonly .
|
||||||
--target test \
|
|
||||||
--output type=cacheonly .
|
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
Reference in new issue
Block a user