Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2318ae1352 |
No files matched your search
+10
-4
@@ -2,14 +2,18 @@
|
||||
# lint` or `script/lint`, which are themselves a docker build and would
|
||||
# recurse into a daemon that does not exist in a build step.
|
||||
#
|
||||
# node and yarn come from the distribution, which is trusted, 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.
|
||||
# In every stage, ARG CACHEBUST comes right after the step that installs
|
||||
# system packages. script/ passes a new value on every build. That value
|
||||
# reruns every RUN step below the ARG line, and the install step keeps
|
||||
# its layer. node and yarn come from the distribution, which is trusted,
|
||||
# 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
|
||||
FROM alpine@sha256:be2656061b536c1883c4034790e21d0a09c5aaaf51968b89368a3c0371ea2c9a AS lint
|
||||
RUN apk add --no-cache git make nodejs-current yarn
|
||||
ARG CACHEBUST
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
@@ -27,6 +31,7 @@ RUN yarn run prettier --check '**/*.md' --tab-width 4 --prose-wrap always
|
||||
# alpine 3.24.3, 2026-11-04
|
||||
FROM alpine@sha256:be2656061b536c1883c4034790e21d0a09c5aaaf51968b89368a3c0371ea2c9a AS test
|
||||
RUN apk add --no-cache git make nodejs-current yarn
|
||||
ARG CACHEBUST
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
@@ -48,6 +53,7 @@ RUN timeout 90 test/update-policy.sh
|
||||
# alpine 3.24.3, 2026-11-04
|
||||
FROM alpine@sha256:be2656061b536c1883c4034790e21d0a09c5aaaf51968b89368a3c0371ea2c9a
|
||||
RUN apk add --no-cache git make nodejs-current yarn
|
||||
ARG CACHEBUST
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
|
||||
@@ -116,10 +116,12 @@ alpine. We provide:
|
||||
`script/bootstrap`, then `script/install-precommit`
|
||||
- `script/projectname` — output the project name (our own extension); used by
|
||||
`script/docker` for the image tag
|
||||
- `script/test` — `docker build --target test --output type=cacheonly .`,
|
||||
- `script/test` —
|
||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --target test --output type=cacheonly .`,
|
||||
building the `test` phase of the `Dockerfile`, which runs
|
||||
`test/update-policy.sh`, without writing an image
|
||||
- `script/lint` — `docker build --target lint --output type=cacheonly .`,
|
||||
- `script/lint` —
|
||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --target lint --output type=cacheonly .`,
|
||||
building the `lint` phase, which runs prettier over the markdown files,
|
||||
without writing an image
|
||||
- `script/fmt` — format all markdown files with prettier (writes; native, not in
|
||||
@@ -127,23 +129,41 @@ alpine. We provide:
|
||||
- `script/fmt-check` — check formatting (read-only; native)
|
||||
- `script/check` — run all checks: `test`, `lint`, `fmt-check` (our own
|
||||
extension); builds no image of its own
|
||||
- `script/docker` — `docker build --build-arg VERSION="$version" -t prompts .`,
|
||||
- `script/docker` —
|
||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --build-arg VERSION="$version" -t prompts .`,
|
||||
the tag coming from `script/projectname` (byte-identical across repos)
|
||||
- `script/cibuild` — cd to the repo root, run `script/bootstrap`, run
|
||||
`script/check`, compute `version` from `git describe`, then
|
||||
`docker build --build-arg VERSION="$version" -t prompts .` (what CI runs; it
|
||||
bootstraps because CI checks out and runs this alone while `script/fmt-check`
|
||||
is native)
|
||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --build-arg VERSION="$version" -t prompts .`
|
||||
(what CI runs; it bootstraps because CI checks out and runs this alone while
|
||||
`script/fmt-check` is native)
|
||||
- `script/precommit` — run by the git pre-commit hook (our own extension); calls
|
||||
`script/check`
|
||||
- `script/install-precommit` — installs the git pre-commit hook (our own
|
||||
extension); `make hooks` shims to it
|
||||
- `script/update-policy` — fetch the shared policy files from this repo and
|
||||
commit them, without pushing (our own extension); it is for the repos that
|
||||
carry them and stops when run here
|
||||
- `script/update-policy` — fetch the vendored policy files from this repo,
|
||||
commit them and push (our own extension); it is for the repos that vendor them
|
||||
and stops when run here
|
||||
|
||||
`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
|
||||
|
||||
LLM prompts, especially development policies, benefit from version control and a
|
||||
|
||||
+10
-120
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Code Styleguide — Go
|
||||
last_modified: 2026-11-16
|
||||
last_modified: 2026-11-07
|
||||
---
|
||||
|
||||
1. Format Go code with `gofmt` and then `golines -m 77`, through `make fmt`.
|
||||
@@ -113,7 +113,13 @@ last_modified: 2026-11-16
|
||||
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
|
||||
both, so a build makes sure the code is in an able-to-be-compiled state,
|
||||
linted, and its tests run.
|
||||
linted, and its tests run. Go through `script/cibuild` or `script/docker`
|
||||
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
|
||||
[Repository Policies](https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md)
|
||||
@@ -170,7 +176,7 @@ last_modified: 2026-11-16
|
||||
them a bit long.
|
||||
|
||||
1. Use descriptive names for modules and filenames. Avoid generic names like
|
||||
`server`. The rules for package names are under Naming, below.
|
||||
`server`. `util` is banned.
|
||||
|
||||
1. Constructors **must** take a `Params` struct (or `ThingParams` when
|
||||
`NewThing()` is used), even for a single argument. Named fields in a Params
|
||||
@@ -215,7 +221,7 @@ last_modified: 2026-11-16
|
||||
...
|
||||
|
||||
if err != nil {
|
||||
SendErrorResponse(w, ErrBadRequest)
|
||||
SendErrorResponse(w, MSGenericError)
|
||||
return
|
||||
}
|
||||
|
||||
@@ -481,122 +487,6 @@ last_modified: 2026-11-16
|
||||
releasable". "Releasable" in this context means that it builds and functions
|
||||
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)
|
||||
|
||||
1. For any internet-facing http server, set appropriate timeouts and limits to
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Existing Repo Checklist
|
||||
last_modified: 2026-11-18
|
||||
last_modified: 2026-11-09
|
||||
---
|
||||
|
||||
Use this checklist when beginning work in a repo that may not yet conform to our
|
||||
@@ -49,8 +49,23 @@ with your task.
|
||||
`--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
|
||||
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 ./`,
|
||||
`RUN go mod download`) before `COPY . .`; the steps that compile
|
||||
`RUN go mod download`) above `ARG CACHEBUST`; the steps that compile
|
||||
(`golangci-lint run`, `go test`, `go build`) mount Go's build cache
|
||||
(`--mount=type=cache,target=/root/.cache/go-build`), `golangci-lint run`
|
||||
also mounts golangci-lint's
|
||||
@@ -59,7 +74,7 @@ with your task.
|
||||
that timed out gets no rerun, as in the canonical Go `Dockerfile` in
|
||||
`REPO_POLICIES.md`
|
||||
- [ ] Python: a `test` phase that installs its packages from `Pipfile.lock` does
|
||||
it before `COPY . .`, with `COPY script/ script/`,
|
||||
it above `ARG CACHEBUST`, with `COPY script/ script/`,
|
||||
`COPY Pipfile Pipfile.lock ./` and `RUN script/bootstrap`. When
|
||||
`script/bootstrap` runs in that step, it installs nothing beyond these:
|
||||
- system packages
|
||||
@@ -76,8 +91,9 @@ with your task.
|
||||
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
|
||||
`python_version`, because `--deploy` stops when the distribution's Python
|
||||
differs from it. The tests run after `COPY . .`, as in the Python `test`
|
||||
phase example in `REPO_POLICIES.md`
|
||||
differs from it. The tests run after `ARG CACHEBUST`, and every other stage
|
||||
installs its Python packages after it, as in the Python `test` phase example
|
||||
in `REPO_POLICIES.md`
|
||||
|
||||
- [ ] The gate phases invoke their tools directly, never through `make lint` or
|
||||
`script/test` — those are themselves a `docker build` and would recurse
|
||||
@@ -196,25 +212,34 @@ with your task.
|
||||
- [ ] `script/precommit` exists and the pre-commit hook (installed by
|
||||
`script/install-precommit`, shimmed by `make hooks`) runs it
|
||||
- [ ] `script/update-policy` exists, identical to the model script, and
|
||||
`make update-policy` shims to it
|
||||
`make update-policy` shims to it. Before its first use, the repo's own
|
||||
entries in `.gitignore`, `.editorconfig` and `.dockerignore` go below the
|
||||
comment that ends each canonical file. An entry above that comment which
|
||||
the canonical file has never held makes the script stop before it writes
|
||||
anything, naming the file and the entry. It stops the same way on a line
|
||||
in `.golangci.yml` that the canonical file has never held, apart from
|
||||
comments and the repo's entries in the `deny` list of the `test-support`
|
||||
rule.
|
||||
- [ ] README has an **Entrypoints** section documenting the `script/`
|
||||
entrypoints and linking the standard
|
||||
- [ ] `script/lint` and `script/test` each run
|
||||
`docker build --target <phase> --output type=cacheonly .`, which builds
|
||||
their phase by name and writes no image, and no host invocation anywhere
|
||||
in the repo can produce a lint verdict — grep for the linter's own name
|
||||
across `script/`, the `Makefile` and CI config, not just `script/lint`. A
|
||||
second path is likeliest here: a `make lint-fast`, an older
|
||||
host-versus-container branch, or a CI step calling the binary directly.
|
||||
`script/fmt` and `script/fmt-check` are expected hits and stay on the
|
||||
host.
|
||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --target <phase> --output type=cacheonly .`,
|
||||
which builds their phase by name and writes no image, and no host
|
||||
invocation anywhere in the repo can produce a lint verdict — grep for the
|
||||
linter's own name across `script/`, the `Makefile` and CI config, not just
|
||||
`script/lint`. A second path is likeliest here: a `make lint-fast`, an
|
||||
older host-versus-container branch, or a CI step calling the binary
|
||||
directly. `script/fmt` and `script/fmt-check` are expected hits and stay
|
||||
on the host.
|
||||
- [ ] No `docker build` in `script/` leaves a dangling image behind:
|
||||
`script/lint` and `script/test` write no image, and `script/docker` and
|
||||
`script/cibuild` tag theirs. A build that writes an untagged image leaves
|
||||
one behind on every run, on every host and CI runner.
|
||||
- [ ] `script/cibuild` runs `script/bootstrap` before `script/check`. Without
|
||||
the bootstrap the CI run dies in `script/fmt-check`, which runs the
|
||||
formatter on the host and finds nothing installed.
|
||||
- [ ] `script/cibuild` runs `script/bootstrap` before `script/check`, and builds
|
||||
the image with a new `CACHEBUST` value on every build, like every
|
||||
`docker build` in `script/`. Without the bootstrap the CI run dies in
|
||||
`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
|
||||
`yarn.lock` is in the tree. node and yarn come from the distribution when
|
||||
they are missing. It installs the node packages with
|
||||
@@ -302,7 +327,14 @@ with your task.
|
||||
- [ ] `script/cibuild` succeeds in a fresh clone on a host carrying what CI has.
|
||||
That host is the runner image
|
||||
`docker.gitea.com/runner-images:ubuntu-latest`, which has docker, git and
|
||||
node 24. Take any yarn off `PATH` first.
|
||||
node 24. Take any yarn off `PATH` first. The run must show that the checks
|
||||
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
|
||||
`docker build .`; revert it afterwards
|
||||
- [ ] Commit and merge fixes before starting your actual task
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: New Repo Checklist
|
||||
last_modified: 2026-11-18
|
||||
last_modified: 2026-11-09
|
||||
---
|
||||
|
||||
Use this checklist when creating a new repository from scratch. Follow the steps
|
||||
@@ -118,8 +118,23 @@ Template files can be fetched from:
|
||||
stage carries a `COPY --from=` of a harmless file from each so the image
|
||||
cannot be built unless both passed. Keep the final stage last: a stage
|
||||
nothing depends on is built only when `--target` names it.
|
||||
- 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 ./`,
|
||||
`RUN go mod download`) before `COPY . .`; the steps that compile
|
||||
`RUN go mod download`) above `ARG CACHEBUST`; the steps that compile
|
||||
(`golangci-lint run`, `go test`, `go build`) mount Go's build cache
|
||||
(`--mount=type=cache,target=/root/.cache/go-build`), `golangci-lint run`
|
||||
also mounts golangci-lint's
|
||||
@@ -128,7 +143,7 @@ Template files can be fetched from:
|
||||
that timed out gets no rerun, as in the canonical Go `Dockerfile` in
|
||||
`REPO_POLICIES.md`
|
||||
- Python: a `test` phase that installs its packages from `Pipfile.lock` does
|
||||
it before `COPY . .`, with `COPY script/ script/`,
|
||||
it above `ARG CACHEBUST`, with `COPY script/ script/`,
|
||||
`COPY Pipfile Pipfile.lock ./` and `RUN script/bootstrap`. When
|
||||
`script/bootstrap` runs in that step, it installs nothing beyond these:
|
||||
- system packages
|
||||
@@ -146,7 +161,8 @@ Template files can be fetched from:
|
||||
for the image stops the install. In that step it installs no Python,
|
||||
because a step above it already did. `Pipfile` names no
|
||||
`python_version`, because `--deploy` stops when the distribution's
|
||||
Python differs from it. The tests run after `COPY . .`, as in the Python
|
||||
Python differs from it. The tests run after `ARG CACHEBUST`, and every
|
||||
other stage installs its Python packages after it, as in the Python
|
||||
`test` phase example in `REPO_POLICIES.md`
|
||||
|
||||
- Server: the final stage builds and runs the application
|
||||
@@ -211,12 +227,13 @@ are thin shims calling them. Model scripts:
|
||||
- [ ] `script/setup` / `make setup` — readies a fresh clone: runs `bootstrap`,
|
||||
then `install-precommit`, plus repo-specific init
|
||||
- [ ] `script/test` / `make test` —
|
||||
`docker build --target test --output type=cacheonly .`, which writes no
|
||||
image; the phase runs real tests, not a no-op (90-second timeout,
|
||||
60-second hard cap on wall time)
|
||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --target test --output type=cacheonly .`,
|
||||
which writes no image; the phase runs real tests, not a no-op (90-second
|
||||
timeout, 60-second hard cap on wall time)
|
||||
- [ ] `script/lint` / `make lint` —
|
||||
`docker build --target lint --output type=cacheonly .`, which writes no
|
||||
image. No lint verdict may come from a host invocation of the linter.
|
||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --target lint --output type=cacheonly .`,
|
||||
which writes no image. No lint verdict may come from a host invocation of
|
||||
the linter.
|
||||
- [ ] `script/fmt` / `make fmt` — formats code (writes; native, never in a
|
||||
container). Go code gets `gofmt`, then `golines -m 77`.
|
||||
- [ ] `script/fmt-check` / `make fmt-check` — checks formatting (read-only;
|
||||
@@ -228,15 +245,16 @@ are thin shims calling them. Model scripts:
|
||||
- [ ] `script/projectname` — outputs the project name (used by `script/docker`
|
||||
for the image tag)
|
||||
- [ ] `script/docker` / `make docker` — builds Docker image, tagged via
|
||||
`script/projectname` (byte-identical across repos), with the version as a
|
||||
build arg
|
||||
`script/projectname` (byte-identical across repos); a new `CACHEBUST`
|
||||
value on every build, plus the version as a build arg
|
||||
- [ ] `script/cibuild` — cd to repo root, run `script/bootstrap`, run
|
||||
`script/check`, then
|
||||
`docker build --build-arg VERSION="$version" -t "$tag" .` (what CI runs),
|
||||
with `$version` from `git describe --tags --always --dirty` (`unknown` if
|
||||
empty) and `$tag` from `script/projectname`, each assigned on its own line
|
||||
before the build. The bootstrap is required: CI checks out and runs this
|
||||
alone, and `script/fmt-check` runs the formatter on the host.
|
||||
`docker build --build-arg CACHEBUST="$(date +%s)-$$" --build-arg VERSION="$version" -t "$tag" .`
|
||||
(what CI runs), with `$version` from
|
||||
`git describe --tags --always --dirty` (`unknown` if empty) and `$tag`
|
||||
from `script/projectname`, each assigned on its own line before the build.
|
||||
The bootstrap is required: CI checks out and runs this alone, and
|
||||
`script/fmt-check` runs the formatter on the host.
|
||||
- [ ] `script/bootstrap`, `script/fmt` and `script/fmt-check` run yarn by
|
||||
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
|
||||
@@ -248,8 +266,9 @@ are thin shims calling them. Model scripts:
|
||||
- [ ] `script/install-precommit` — installs the pre-commit hook that runs
|
||||
`script/precommit`
|
||||
- [ ] `make hooks` — shims to `script/install-precommit`
|
||||
- [ ] `script/update-policy` / `make update-policy` — fetches the shared policy
|
||||
files from the `prompts` repo and commits them; identical across repos
|
||||
- [ ] `script/update-policy` / `make update-policy` — fetches the vendored
|
||||
policy files from the `prompts` repo, commits them and pushes; identical
|
||||
across repos
|
||||
- [ ] README **Entrypoints** section documents the scripts and links the
|
||||
standard
|
||||
|
||||
@@ -260,7 +279,14 @@ are thin shims calling them. Model scripts:
|
||||
- [ ] `script/cibuild` succeeds in a fresh clone on a host carrying what CI has.
|
||||
That host is the runner image
|
||||
`docker.gitea.com/runner-images:ubuntu-latest`, which has docker, git and
|
||||
node 24. Take any yarn off `PATH` first.
|
||||
node 24. Take any yarn off `PATH` first. The run must show that the checks
|
||||
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
|
||||
`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.
|
||||
|
||||
+125
-50
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Repository Policies
|
||||
last_modified: 2026-11-18
|
||||
last_modified: 2026-11-09
|
||||
---
|
||||
|
||||
This document covers repository structure, tooling, and workflow standards. Code
|
||||
@@ -93,7 +93,8 @@ style conventions are in separate documents:
|
||||
- `make check` (runs `test`, `lint`, `fmt-check`)
|
||||
- `make docker`
|
||||
- `make hooks` (installs pre-commit hook)
|
||||
- `make update-policy` (fetches the shared policy files and commits them)
|
||||
- `make update-policy` (fetches the vendored policy files, commits and
|
||||
pushes)
|
||||
|
||||
A model Makefile is at
|
||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile`.
|
||||
@@ -190,8 +191,9 @@ style conventions are in separate documents:
|
||||
`script/check`.
|
||||
- `script/install-precommit` installs the git pre-commit hook. The
|
||||
`make hooks` target shims to it.
|
||||
- `script/update-policy` fetches the shared policy files from the `prompts`
|
||||
repo and commits them. The `make update-policy` target shims to it.
|
||||
- `script/update-policy` fetches the vendored policy files from the
|
||||
`prompts` repo, commits them and pushes. The `make update-policy` target
|
||||
shims to it.
|
||||
- `script/projectname` (literally that filename) simply outputs the
|
||||
project's name.
|
||||
|
||||
@@ -252,8 +254,10 @@ style conventions are in separate documents:
|
||||
phase and nothing else:
|
||||
|
||||
```sh
|
||||
docker build --target lint --output type=cacheonly .
|
||||
docker build --target test --output type=cacheonly .
|
||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
||||
--target lint --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
|
||||
@@ -271,8 +275,7 @@ style conventions are in separate documents:
|
||||
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
|
||||
the tag on its own line before the build, so `set -e` stops it where
|
||||
`script/projectname` fails. `script/check` runs the two gate phases and
|
||||
`script/fmt-check`, and builds no image of its own.
|
||||
`script/projectname` fails.
|
||||
|
||||
Inside a phase the tool is invoked directly: `golangci-lint`, `go test`,
|
||||
`eslint`, `prettier`. The tool is never invoked through `make lint` or
|
||||
@@ -295,6 +298,55 @@ style conventions are in separate documents:
|
||||
- the settings
|
||||
- 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 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.
|
||||
@@ -302,8 +354,12 @@ style conventions are in separate documents:
|
||||
`Dockerfile`:
|
||||
|
||||
```dockerfile
|
||||
# The steps that install system packages and download Go's modules
|
||||
# come before COPY . ., so a change to the code keeps their layers.
|
||||
# In every stage ARG CACHEBUST comes right after the steps that install
|
||||
# system packages and download Go's modules, or right after FROM in a
|
||||
# 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
|
||||
# also mounts golangci-lint's; both survive from build to build.
|
||||
|
||||
@@ -313,6 +369,7 @@ style conventions are in separate documents:
|
||||
WORKDIR /src
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
ARG CACHEBUST
|
||||
COPY . .
|
||||
RUN --mount=type=cache,target=/root/.cache/go-build \
|
||||
--mount=type=cache,target=/root/.cache/golangci-lint \
|
||||
@@ -328,6 +385,7 @@ style conventions are in separate documents:
|
||||
WORKDIR /src
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
ARG CACHEBUST
|
||||
COPY . .
|
||||
RUN --mount=type=cache,target=/root/.cache/go-build \
|
||||
status=0; \
|
||||
@@ -352,6 +410,7 @@ style conventions are in separate documents:
|
||||
WORKDIR /src
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
ARG CACHEBUST
|
||||
COPY --from=lint /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.
|
||||
@@ -377,6 +436,7 @@ style conventions are in separate documents:
|
||||
|
||||
# Runtime stage, and the last one
|
||||
FROM alpine@sha256:...
|
||||
ARG CACHEBUST
|
||||
COPY --from=builder /app /usr/local/bin/app
|
||||
ENTRYPOINT ["app"]
|
||||
```
|
||||
@@ -392,15 +452,15 @@ style conventions are in separate documents:
|
||||
two copies. A plain `docker build .` builds the last stage's chain and
|
||||
nothing else.
|
||||
- Check builds keep these, and none of them can hand back a stale result:
|
||||
- The layers of the system packages and Go's modules. Docker installs
|
||||
the packages again when the base image or the install line changes.
|
||||
Docker downloads the modules again when `go.mod` or `go.sum` changes.
|
||||
Go checks every module against `go.sum` as it downloads it, and no
|
||||
later build can change a kept layer. The modules are kept in a layer
|
||||
rather than a cache mount. A cache mount is shared by every build on
|
||||
the host, and Go builds from whatever files the mount holds without
|
||||
checking them again (only `go mod verify` does). A file changed there
|
||||
would go unnoticed.
|
||||
- The layers above `ARG CACHEBUST`: the system packages and Go's
|
||||
modules. Docker installs the packages again when the base image or the
|
||||
install line changes. Docker downloads the modules again when `go.mod`
|
||||
or `go.sum` changes. Go checks every module against `go.sum` as it
|
||||
downloads it, and no later build can change a kept layer. The modules
|
||||
are kept in a layer rather than a cache mount. A cache mount is shared
|
||||
by every build on the host, and Go builds from whatever files the
|
||||
mount holds without checking them again (only `go mod verify` does). A
|
||||
file changed there would go unnoticed.
|
||||
- Go's build cache (`/root/.cache/go-build`, where Go keeps it for
|
||||
root), mounted on the steps that compile: `golangci-lint run`, both
|
||||
`go test` runs and `go build`. Go reuses a compiled package only when
|
||||
@@ -427,8 +487,8 @@ style conventions are in separate documents:
|
||||
(`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,
|
||||
on the Debian Go image, installs the libraries its tests need the same
|
||||
way. Either install goes right after `FROM`, so Docker keeps it until the
|
||||
base image or the install line changes:
|
||||
way. Either install goes right after `FROM`, above `ARG CACHEBUST`, so
|
||||
Docker keeps it until the base image or the install line changes:
|
||||
|
||||
```dockerfile
|
||||
FROM golangci/golangci-lint@sha256:... AS lint
|
||||
@@ -438,6 +498,7 @@ style conventions are in separate documents:
|
||||
WORKDIR /src
|
||||
COPY go.mod go.sum ./
|
||||
RUN go mod download
|
||||
ARG CACHEBUST
|
||||
```
|
||||
|
||||
- `.dockerignore` lets `.git` into the build context. It keeps out every git
|
||||
@@ -478,19 +539,21 @@ style conventions are in separate documents:
|
||||
already do.
|
||||
|
||||
- **A Python `test` phase that installs its packages from `Pipfile.lock` does it
|
||||
before `COPY . .`, so check builds keep them.** The steps are:
|
||||
above `ARG CACHEBUST`, so check builds keep them.** The steps are:
|
||||
- `COPY script/ script/`
|
||||
- `COPY Pipfile Pipfile.lock ./`
|
||||
- `RUN script/bootstrap`
|
||||
|
||||
Docker keeps what that `RUN` installed until one of these changes:
|
||||
`ARG CACHEBUST` comes right after them. Docker keeps what that `RUN`
|
||||
installed until one of these changes:
|
||||
- the base image
|
||||
- `script/`
|
||||
- `Pipfile`
|
||||
- `Pipfile.lock`
|
||||
- a line up to and including the `RUN`
|
||||
|
||||
The tests run after `COPY . .`.
|
||||
The tests run after `ARG CACHEBUST`, on every check build. In every other
|
||||
stage, a step that installs Python packages comes after `ARG CACHEBUST`.
|
||||
- When `script/bootstrap` runs in that step, it installs nothing beyond
|
||||
these:
|
||||
- system packages
|
||||
@@ -498,7 +561,8 @@ style conventions are in separate documents:
|
||||
- the packages from `Pipfile.lock`
|
||||
|
||||
`script/bootstrap` installs no Python there: the tests use the
|
||||
distribution's Python, which a step above it installs.
|
||||
distribution's Python, which a step above it installs. If 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
|
||||
virtual environment at `$HOME/.pipenv`. `script/bootstrap` creates it with
|
||||
@@ -580,6 +644,7 @@ style conventions are in separate documents:
|
||||
COPY script/ script/
|
||||
COPY Pipfile Pipfile.lock ./
|
||||
RUN script/bootstrap
|
||||
ARG CACHEBUST
|
||||
COPY . .
|
||||
RUN timeout 90 sh -c 'pipenv run pytest || { \
|
||||
echo "--- Rerunning with -v for details ---"; \
|
||||
@@ -598,16 +663,20 @@ style conventions are in separate documents:
|
||||
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.
|
||||
`script/cibuild` bootstraps, runs the gate phases, and then builds the image,
|
||||
so a successful run means every check passed. The `check` job sets
|
||||
`timeout-minutes: 20`, so a hung build frees the shared runner after 20
|
||||
minutes. That allows for the three Docker builds described above, each held to
|
||||
the 5-minute Docker build limit below, plus the bootstrap. Those builds are
|
||||
the test phase, the lint phase, then the image. A separate workflow limited to
|
||||
`main` by a `branches` list under `on: push` cannot be checked by review. To
|
||||
try a change to it, add the feature branch to that list and push, then remove
|
||||
the branch from the list again before merging. Keep any job in it that
|
||||
publishes behind `if: github.ref_name == 'main'`, so the run from the feature
|
||||
branch publishes nothing.
|
||||
so a successful run means every check passed. A bare `docker build .` does not
|
||||
carry the same guarantee, because its gate phases may come from the cache. The
|
||||
image build gets a `CACHEBUST` value of its own and so runs the gate phases a
|
||||
second time. That is the price of the rule above, and it is worth paying. The
|
||||
image that ships is built from a run of its own gates rather than from a cache
|
||||
entry. The `check` job sets `timeout-minutes: 20`, so a hung build frees the
|
||||
shared runner after 20 minutes. That allows for the three Docker builds
|
||||
described above, each held to the 5-minute Docker build limit below, plus the
|
||||
bootstrap. Those builds are the test phase, the lint phase, then the image. A
|
||||
separate workflow limited to `main` by a `branches` list under `on: push`
|
||||
cannot be checked by review. To try a change to it, add the feature branch to
|
||||
that list and push, then remove the branch from the list again before merging.
|
||||
Keep any job in it that publishes behind `if: github.ref_name == 'main'`, so
|
||||
the run from the feature branch publishes nothing.
|
||||
|
||||
- Use platform-standard formatters:
|
||||
- `black` for Python
|
||||
@@ -712,13 +781,14 @@ style conventions are in separate documents:
|
||||
tests. It leaves the build cache alone, so it costs the runtime of the suite
|
||||
and no recompilation.
|
||||
|
||||
That cache is Go's own. Go stores a passing result in its cache directory
|
||||
(`GOCACHE`). When the same tests run again on unchanged code, it prints that
|
||||
result, marked `(cached)`, without running them. The directory lasts from
|
||||
one run to the next on a developer's machine, where this target runs. The
|
||||
directory also lasts in the `test` phase of the `Dockerfile`, which mounts
|
||||
it to keep compiled packages between check builds, so the phase's `go test`
|
||||
runs carry `-count=1` too.
|
||||
That cache is Go's own, separate from Docker's layer cache. Go stores a
|
||||
passing result in its cache directory (`GOCACHE`). When the same tests run
|
||||
again on unchanged code, it prints that result, marked `(cached)`, without
|
||||
running them. The directory lasts from one run to the next on a developer's
|
||||
machine, where this target runs. The directory also lasts in the `test`
|
||||
phase of the `Dockerfile`, which mounts it to keep compiled packages between
|
||||
check builds, so the phase's `go test` runs carry `-count=1` too. A new
|
||||
`CACHEBUST` value (above) is what makes that step run on an unchanged tree.
|
||||
|
||||
Python example:
|
||||
|
||||
@@ -821,7 +891,9 @@ style conventions are in separate documents:
|
||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||
[ -n "$version" ] || version="unknown"
|
||||
tag="$(script/projectname)"
|
||||
docker build --build-arg VERSION="$version" -t "$tag" .
|
||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
||||
--build-arg VERSION="$version" \
|
||||
-t "$tag" .
|
||||
```
|
||||
|
||||
`--always` makes an untagged repo yield an abbreviated commit hash rather
|
||||
@@ -861,13 +933,16 @@ style conventions are in separate documents:
|
||||
- Make all changes on a feature branch. You can do whatever you want on a
|
||||
feature branch.
|
||||
|
||||
- A repo updates its shared policy files with one command: `make update-policy`.
|
||||
It runs `script/update-policy`, which fetches each file from the `main` branch
|
||||
of the `prompts` repo and commits them. It does not push: review the commit,
|
||||
then push it. The script lists the files at its top:
|
||||
- `docs/REPO_POLICIES.md`
|
||||
- `docs/CODE_STYLEGUIDE.md`
|
||||
- `script/update-policy` itself, so the script stays current
|
||||
- A repo updates its policy files with one command: `make update-policy`. It
|
||||
runs `script/update-policy`, which fetches each vendored file the repo carries
|
||||
from the `prompts` repo, commits them and pushes. It uses the head of `main`,
|
||||
or the commit given by a full hash: `script/update-policy <hash>`. The list of
|
||||
vendored files is at the top of that script. The script replaces each file and
|
||||
keeps only the repo's own entries:
|
||||
- in `.gitignore`, `.editorconfig` and `.dockerignore`: the lines below the
|
||||
comment that ends the canonical file
|
||||
- in `.golangci.yml`: the entries the repo added to the `deny` list of the
|
||||
`test-support` depguard rule
|
||||
|
||||
- `.golangci.yml` is standardized. The vendored copy in a consuming repo must
|
||||
_NEVER_ be modified by an agent. Fetch it from
|
||||
|
||||
+9
-1
@@ -2,6 +2,12 @@
|
||||
# script/cibuild: run the CI build. It bootstraps first: a CI runner
|
||||
# checks out and runs this and nothing else, and script/fmt-check runs
|
||||
# the formatter on the host, which a pristine checkout cannot do.
|
||||
# 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
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||
@@ -19,7 +25,9 @@ main() {
|
||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||
[ -n "$version" ] || version="unknown"
|
||||
tag="$("$SCRIPT_DIR/projectname")"
|
||||
docker build --build-arg VERSION="$version" -t "$tag" .
|
||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
||||
--build-arg VERSION="$version" \
|
||||
-t "$tag" .
|
||||
}
|
||||
|
||||
main "$@"
|
||||
+9
-1
@@ -1,6 +1,12 @@
|
||||
#!/bin/sh
|
||||
# script/docker: build the Docker image tagged with the project name.
|
||||
# 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
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||
@@ -16,7 +22,9 @@ main() {
|
||||
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||
[ -n "$version" ] || version="unknown"
|
||||
tag="$("$SCRIPT_DIR/projectname")"
|
||||
docker build --build-arg VERSION="$version" -t "$tag" .
|
||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
||||
--build-arg VERSION="$version" \
|
||||
-t "$tag" .
|
||||
}
|
||||
|
||||
main "$@"
|
||||
+11
-2
@@ -5,7 +5,14 @@
|
||||
# make its answer untrustworthy.
|
||||
#
|
||||
# --target builds the lint phase and the stages it depends on, nothing
|
||||
# else. --output type=cacheonly writes no image, since nothing uses one.
|
||||
# else. A new CACHEBUST value reruns every RUN step after
|
||||
# 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
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||
@@ -13,7 +20,9 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
docker build --target lint --output type=cacheonly .
|
||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
||||
--target lint \
|
||||
--output type=cacheonly .
|
||||
}
|
||||
|
||||
main "$@"
|
||||
+10
-3
@@ -2,8 +2,13 @@
|
||||
# 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:
|
||||
# --target so that only the test phase and the stages it depends on are
|
||||
# built, and --output type=cacheonly so that no image is written, since
|
||||
# nothing uses one.
|
||||
# built, and a new CACHEBUST value because a cached test layer is a test
|
||||
# that did not run; unlike --no-cache, it keeps the layers above the ARG
|
||||
# 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
|
||||
|
||||
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||
@@ -11,7 +16,9 @@ ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
docker build --target test --output type=cacheonly .
|
||||
docker build --build-arg CACHEBUST="$(date +%s)-$$" \
|
||||
--target test \
|
||||
--output type=cacheonly .
|
||||
}
|
||||
|
||||
main "$@"
|
||||
+206
-40
@@ -1,17 +1,43 @@
|
||||
#!/bin/sh
|
||||
# script/update-policy: replace the files below with their current
|
||||
# versions from the main branch of the prompts repo, and commit them. It
|
||||
# does not push. Identical in all repos, and it updates itself.
|
||||
# script/update-policy: replace this repo's vendored policy files with
|
||||
# the canonical ones from the prompts repo, commit them and push.
|
||||
# Identical in all repos. Our own extension to
|
||||
# scripts-to-rule-them-all.
|
||||
#
|
||||
# Usage: script/update-policy [full commit hash of prompts]
|
||||
# Without a hash it uses the head of the prompts main branch.
|
||||
#
|
||||
# The script writes nothing until every file has been fetched and
|
||||
# merged. A repo's own entries are kept:
|
||||
# - .gitignore, .editorconfig, .dockerignore: the lines below the
|
||||
# canonical file's last line. An entry above that line which the
|
||||
# canonical file has never held stops the script.
|
||||
# - .golangci.yml: the entries the repo added to the deny list of the
|
||||
# test-support rule. Any other line the canonical file has never
|
||||
# held stops the script, unless it is blank or a comment.
|
||||
set -eu
|
||||
|
||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
RAW_URL="https://git.eeqj.de/sneak/prompts/raw/branch/main"
|
||||
PROMPTS_URL="https://git.eeqj.de/sneak/prompts"
|
||||
|
||||
# Each entry is the path in prompts, a colon, then the path in this repo.
|
||||
FILES="
|
||||
prompts/REPO_POLICIES.md:docs/REPO_POLICIES.md
|
||||
prompts/CODE_STYLEGUIDE.md:docs/CODE_STYLEGUIDE.md
|
||||
script/update-policy:script/update-policy
|
||||
# Paths in the prompts repo. A file this repo does not carry is skipped.
|
||||
VENDORED_FILES="
|
||||
.dockerignore
|
||||
.editorconfig
|
||||
.gitea/workflows/check.yml
|
||||
.gitignore
|
||||
.golangci.yml
|
||||
.prettierrc
|
||||
prompts/API_POLICIES.md
|
||||
prompts/CODE_STYLEGUIDE.md
|
||||
prompts/CODE_STYLEGUIDE_GO.md
|
||||
prompts/CODE_STYLEGUIDE_JS.md
|
||||
prompts/CODE_STYLEGUIDE_PYTHON.md
|
||||
prompts/EXISTING_REPO_CHECKLIST.md
|
||||
prompts/GO_HTTP_SERVER_CONVENTIONS.md
|
||||
prompts/LLM_PROSE_TELLS.md
|
||||
prompts/NEW_REPO_CHECKLIST.md
|
||||
prompts/REPO_POLICIES.md
|
||||
"
|
||||
|
||||
die() {
|
||||
@@ -19,38 +45,178 @@ die() {
|
||||
exit 1
|
||||
}
|
||||
|
||||
cd "$ROOT"
|
||||
[ ! -e prompts/REPO_POLICIES.md ] ||
|
||||
die "this is the prompts repo, where these files come from"
|
||||
# local_path <path in prompts>: print where this repo keeps the file, or
|
||||
# nothing if git does not track it here. A prompts/NAME.md lands at
|
||||
# docs/NAME.md or NAME.md.
|
||||
local_path() {
|
||||
name="${1#prompts/}"
|
||||
if [ "$name" != "$1" ] && [ -n "$(git ls-files -- "docs/$name")" ]; then
|
||||
echo "docs/$name"
|
||||
elif [ -n "$(git ls-files -- "$name")" ]; then
|
||||
echo "$name"
|
||||
fi
|
||||
}
|
||||
|
||||
paths=""
|
||||
for entry in $FILES; do
|
||||
paths="$paths ${entry#*:}"
|
||||
done
|
||||
[ -z "$(git status --porcelain -- $paths)" ] ||
|
||||
die "commit or discard your changes to these files first:$paths"
|
||||
# local_only_lines <fetched> <local> [end]: print each line of the local
|
||||
# file, above line end if given, that the canonical file has never held:
|
||||
# not in the fetched file or in <fetched>.former, the lines earlier
|
||||
# commits removed from it. Blank lines and comments do not count.
|
||||
local_only_lines() {
|
||||
cat "$1" "$1.former" | awk -v end="${3:-}" '
|
||||
NR == FNR { held[$0]; next }
|
||||
(end == "" || FNR < end) && !/^[ \t]*(#|$)/ && !($0 in held)
|
||||
' - "$2"
|
||||
}
|
||||
|
||||
# Every file is fetched before any is replaced. The temporary directory
|
||||
# is inside the repo so that mv renames: the running script is replaced
|
||||
# by a new file, never rewritten in place.
|
||||
tmp="$(mktemp -d "$ROOT/.update-policy.XXXXXX")"
|
||||
trap 'rm -rf "$tmp"' EXIT
|
||||
for entry in $FILES; do
|
||||
mkdir -p "$tmp/$(dirname "${entry#*:}")"
|
||||
wget -q -T 60 -O "$tmp/${entry#*:}" "$RAW_URL/${entry%%:*}" ||
|
||||
die "cannot fetch $RAW_URL/${entry%%:*}"
|
||||
done
|
||||
chmod 755 "$tmp/script/update-policy"
|
||||
# keep_lines_below_last <fetched> <local>: append to the fetched file
|
||||
# whatever follows its last line in the local file. Stop if the canonical
|
||||
# file has never held a line above that one, unless it is blank or a
|
||||
# comment: replacing the file would delete it.
|
||||
keep_lines_below_last() {
|
||||
last="$(tail -n 1 "$1")"
|
||||
number="$(grep -n -F -x -- "$last" "$2" | head -n 1 | cut -d: -f1)"
|
||||
if [ -z "$last" ] || [ -z "$number" ]; then
|
||||
die "$2 lacks this line; add it and put the repo's own entries below it: $last"
|
||||
fi
|
||||
own="$(local_only_lines "$1" "$2" "$number")"
|
||||
if [ -n "$own" ]; then
|
||||
die "$2 has entries above its last canonical line that the canonical file lacks; move each below that line to keep it, or delete it:
|
||||
$own"
|
||||
fi
|
||||
tail -n "+$((number + 1))" "$2" >> "$1"
|
||||
}
|
||||
|
||||
for path in $paths; do
|
||||
mkdir -p "$(dirname "$path")"
|
||||
mv "$tmp/$path" "$path"
|
||||
done
|
||||
# keep_deny_entries <fetched> <local>: add to the deny list of the
|
||||
# test-support rule in the fetched file the entries only the local file
|
||||
# has. An entry is a "- pkg:" line, the lines under it and any comment
|
||||
# above it. Stop if the local file still has a line that neither the
|
||||
# result nor the canonical file has ever held, unless it is blank or a
|
||||
# comment: replacing the file would delete it.
|
||||
keep_deny_entries() {
|
||||
awk '
|
||||
function indent(line) { return match(line, /[^ ]/) - 1 }
|
||||
function print_local_entries(i) {
|
||||
for (i = 1; i <= count; i++)
|
||||
if (!(pkg[i] in fetched_pkg))
|
||||
printf "%s", entry[i]
|
||||
}
|
||||
|
||||
git add -- $paths
|
||||
if git diff --cached --quiet -- $paths; then
|
||||
echo "update-policy: already current, nothing to commit"
|
||||
else
|
||||
git commit -q -m "Update policy files from prompts" -- $paths
|
||||
echo "update-policy: committed; review it, then push"
|
||||
fi
|
||||
FNR == 1 { in_rule = 0; in_list = 0 }
|
||||
|
||||
in_list && /[^ ]/ && indent($0) <= list_indent {
|
||||
in_list = 0
|
||||
if (FILENAME == ARGV[2]) print_local_entries()
|
||||
}
|
||||
|
||||
in_list {
|
||||
is_entry = ($1 == "-" && $2 == "pkg:")
|
||||
if (FILENAME == ARGV[2]) {
|
||||
if (is_entry) fetched_pkg[$3]
|
||||
print
|
||||
} else if (is_entry) {
|
||||
count++
|
||||
pkg[count] = $3
|
||||
entry[count] = comment $0 "\n"
|
||||
comment = ""
|
||||
} else if (/^ *#/) {
|
||||
comment = comment $0 "\n"
|
||||
} else if (count) {
|
||||
entry[count] = entry[count] $0 "\n"
|
||||
}
|
||||
next
|
||||
}
|
||||
|
||||
in_rule && /^ *[^ #]/ && indent($0) <= rule_indent { in_rule = 0 }
|
||||
/^ *test-support:/ { in_rule = 1; rule_indent = indent($0) }
|
||||
in_rule && /^ *deny:/ {
|
||||
in_rule = 0
|
||||
in_list = 1
|
||||
list_indent = indent($0)
|
||||
if (FILENAME == ARGV[2]) found = 1
|
||||
}
|
||||
FILENAME == ARGV[2] { print }
|
||||
|
||||
END {
|
||||
if (in_list) print_local_entries()
|
||||
exit !found
|
||||
}
|
||||
' "$2" "$1" > "$1.merged" ||
|
||||
die "the fetched $2 has no deny list in its test-support rule"
|
||||
mv "$1.merged" "$1"
|
||||
own="$(local_only_lines "$1" "$2")"
|
||||
if [ -n "$own" ]; then
|
||||
die "$2 has lines the canonical file has never held; only the deny list of the test-support rule may differ from canonical:
|
||||
$own"
|
||||
fi
|
||||
}
|
||||
|
||||
main() {
|
||||
cd "$ROOT"
|
||||
|
||||
[ "$#" -le 1 ] || die "usage: script/update-policy [full commit hash]"
|
||||
|
||||
project="$(script/projectname)"
|
||||
if [ "$project" = "prompts" ]; then
|
||||
die "this repo is the source of the policy files"
|
||||
fi
|
||||
|
||||
commit="${1:-}"
|
||||
if [ -z "$commit" ]; then
|
||||
head_line="$(git ls-remote "$PROMPTS_URL.git" refs/heads/main)"
|
||||
commit="${head_line%%[[:space:]]*}"
|
||||
fi
|
||||
printf '%s\n' "$commit" | grep -Eqx '[0-9a-f]{40}' ||
|
||||
die "not a full commit hash: '$commit'"
|
||||
|
||||
tmp="$(mktemp -d)"
|
||||
trap 'rm -rf "$tmp"' EXIT
|
||||
|
||||
git clone --quiet --bare "$PROMPTS_URL.git" "$tmp/prompts.git" ||
|
||||
die "cannot clone $PROMPTS_URL.git"
|
||||
|
||||
carried=""
|
||||
for file in $VENDORED_FILES; do
|
||||
path="$(local_path "$file")"
|
||||
[ -n "$path" ] || continue
|
||||
if [ -n "$(git status --porcelain -- "$path")" ]; then
|
||||
die "$path has uncommitted changes"
|
||||
fi
|
||||
mkdir -p "$tmp/$(dirname "$path")"
|
||||
curl --fail --silent --show-error --max-time 60 \
|
||||
--output "$tmp/$path" \
|
||||
"$PROMPTS_URL/raw/commit/$commit/$file" ||
|
||||
die "cannot fetch $file at $commit"
|
||||
git -C "$tmp/prompts.git" log -p --format= "$commit" -- "$file" |
|
||||
sed -n 's/^-//p' > "$tmp/$path.former"
|
||||
carried="$carried $path"
|
||||
done
|
||||
[ -n "$carried" ] || die "this repo carries none of the vendored files"
|
||||
|
||||
for path in $carried; do
|
||||
case "$path" in
|
||||
.gitignore | .editorconfig | .dockerignore)
|
||||
keep_lines_below_last "$tmp/$path" "$path"
|
||||
;;
|
||||
.golangci.yml)
|
||||
keep_deny_entries "$tmp/$path" "$path"
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
for path in $carried; do
|
||||
cp "$tmp/$path" "$path"
|
||||
git add -- "$path"
|
||||
done
|
||||
|
||||
if git diff --cached --quiet -- $carried; then
|
||||
echo "update-policy: already at prompts $commit, nothing to commit"
|
||||
else
|
||||
git commit -m "Update policy files from prompts $commit" -- $carried
|
||||
fi
|
||||
|
||||
# Also pushes when there was nothing to commit, so a run after a
|
||||
# failed push delivers the commit that push left behind.
|
||||
git push origin HEAD || die "push failed; fix that and run this again"
|
||||
}
|
||||
|
||||
main "$@"
|
||||
+545
-64
@@ -1,13 +1,14 @@
|
||||
#!/bin/sh
|
||||
# test/update-policy.sh: test script/update-policy on throwaway repos. A
|
||||
# stub wget serves the files from this checkout, or fails for the path
|
||||
# in WGET_FAIL, so nothing touches the network.
|
||||
# test/update-policy.sh: test script/update-policy on throwaway repos.
|
||||
# Each scenario gets one temp directory holding a repo, its local bare
|
||||
# origin, a local git repository of the canonical files in place of
|
||||
# prompts, and a stub curl that serves them, so nothing touches the
|
||||
# network.
|
||||
set -eu
|
||||
|
||||
PROMPTS="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||
LISTED="docs/REPO_POLICIES.md docs/CODE_STYLEGUIDE.md script/update-policy"
|
||||
UPDATE_POLICY="$(cd "$(dirname "$0")/.." && pwd -P)/script/update-policy"
|
||||
|
||||
dir="$(mktemp -d)"
|
||||
dir=""
|
||||
trap 'rm -rf "$dir"' EXIT
|
||||
|
||||
fail() {
|
||||
@@ -16,71 +17,551 @@ fail() {
|
||||
exit 1
|
||||
}
|
||||
|
||||
mkdir "$dir/bin"
|
||||
cat > "$dir/bin/wget" << EOF
|
||||
write_stub_curl() {
|
||||
mkdir "$dir/bin"
|
||||
cat > "$dir/bin/curl" << 'EOF'
|
||||
#!/bin/sh
|
||||
while [ "\$#" -gt 1 ]; do
|
||||
[ "\$1" = "-O" ] && output="\$2"
|
||||
shift
|
||||
previous=""
|
||||
fail_flag=""
|
||||
for argument in "$@"; do
|
||||
[ "$previous" = "--output" ] && output="$argument"
|
||||
[ "$argument" = "--fail" ] && fail_flag=yes
|
||||
previous="$argument"
|
||||
done
|
||||
path="\${1#https://git.eeqj.de/sneak/prompts/raw/branch/main/}"
|
||||
[ "\$path" != "\${WGET_FAIL:-}" ] || exit 1
|
||||
cp "$PROMPTS/\$path" "\$output"
|
||||
url="$previous"
|
||||
base="https://git.eeqj.de/sneak/prompts/raw/commit/$HASH/"
|
||||
path="${url#"$base"}"
|
||||
source="$(dirname "$0")/../canonical/$path"
|
||||
if [ "$path" = "$url" ] || [ ! -f "$source" ]; then
|
||||
[ -n "$fail_flag" ] && exit 22
|
||||
echo "404 page not found" > "$output"
|
||||
exit 0
|
||||
fi
|
||||
cp "$source" "$output"
|
||||
EOF
|
||||
chmod +x "$dir/bin/wget"
|
||||
PATH="$dir/bin:$PATH"
|
||||
export PATH
|
||||
|
||||
# new_repo: a repo with one commit, holding only an older copy of the
|
||||
# script, so that a run must replace the script that is running.
|
||||
new_repo() {
|
||||
scenario="$1"
|
||||
rm -rf "$dir/repo"
|
||||
git init -q "$dir/repo"
|
||||
cd "$dir/repo"
|
||||
git config user.name test
|
||||
git config user.email test@example.com
|
||||
mkdir script
|
||||
cp "$PROMPTS/script/update-policy" script/
|
||||
echo "# older copy" >> script/update-policy
|
||||
echo own > README.md
|
||||
git add README.md script/update-policy
|
||||
git commit -q -m initial
|
||||
chmod +x "$dir/bin/curl"
|
||||
}
|
||||
|
||||
new_repo "a first run writes and commits exactly the listed files"
|
||||
echo stray > stray.txt
|
||||
script/update-policy > "$dir/output" 2>&1 || fail "exited non-zero"
|
||||
[ "$(git rev-list --count HEAD)" = 2 ] || fail "made no single commit"
|
||||
[ "$(git show --name-only --format= HEAD | sort)" = \
|
||||
"$(echo "$LISTED" | tr ' ' '\n' | sort)" ] || fail "commit holds other files"
|
||||
cmp -s docs/REPO_POLICIES.md "$PROMPTS/prompts/REPO_POLICIES.md" ||
|
||||
fail "REPO_POLICIES.md differs"
|
||||
[ -x script/update-policy ] || fail "script not executable"
|
||||
[ "$(git status --porcelain)" = "?? stray.txt" ] || fail "tree not clean"
|
||||
write_canonical_files() {
|
||||
mkdir -p "$dir/canonical/prompts"
|
||||
cat > "$dir/canonical/.gitignore" << 'EOF'
|
||||
*.log
|
||||
*.tmp
|
||||
|
||||
scenario="a second run commits nothing"
|
||||
script/update-policy > "$dir/output" 2>&1 || fail "exited non-zero"
|
||||
[ "$(git rev-list --count HEAD)" = 2 ] || fail "made a commit"
|
||||
grep -q "nothing to commit" "$dir/output" || fail "did not say so"
|
||||
# Own entries go below this comment.
|
||||
EOF
|
||||
cat > "$dir/canonical/.dockerignore" << 'EOF'
|
||||
**/*.log
|
||||
**/*.tmp
|
||||
|
||||
new_repo "a failed fetch writes nothing"
|
||||
WGET_FAIL=prompts/CODE_STYLEGUIDE.md script/update-policy > "$dir/output" 2>&1 &&
|
||||
fail "exited zero"
|
||||
grep -q "cannot fetch" "$dir/output" || fail "did not say cannot fetch"
|
||||
[ ! -e docs ] || fail "wrote docs/"
|
||||
[ -z "$(git status --porcelain)" ] || fail "tree changed"
|
||||
# Own entries go below this comment.
|
||||
EOF
|
||||
cat > "$dir/canonical/.editorconfig" << 'EOF'
|
||||
root = true
|
||||
[*]
|
||||
indent_size = 4
|
||||
|
||||
new_repo "an uncommitted change to a listed file stops the script"
|
||||
mkdir docs
|
||||
echo mine > docs/REPO_POLICIES.md
|
||||
script/update-policy > "$dir/output" 2>&1 && fail "exited zero"
|
||||
[ "$(cat docs/REPO_POLICIES.md)" = mine ] || fail "overwrote the change"
|
||||
# Own sections go below this comment.
|
||||
EOF
|
||||
cat > "$dir/canonical/.golangci.yml" << 'EOF'
|
||||
linters:
|
||||
settings:
|
||||
depguard:
|
||||
rules:
|
||||
test-support:
|
||||
deny:
|
||||
- pkg: net/http/httptest
|
||||
desc: canonical
|
||||
- pkg: net/http/cgi
|
||||
desc: added canonically
|
||||
other:
|
||||
deny:
|
||||
- pkg: example.com/other
|
||||
EOF
|
||||
echo '{ "tabWidth": 4 }' > "$dir/canonical/.prettierrc"
|
||||
echo "new policy" > "$dir/canonical/prompts/REPO_POLICIES.md"
|
||||
echo "new api policy" > "$dir/canonical/prompts/API_POLICIES.md"
|
||||
}
|
||||
|
||||
new_repo "the prompts repo itself is refused"
|
||||
mkdir prompts
|
||||
echo source > prompts/REPO_POLICIES.md
|
||||
script/update-policy > "$dir/output" 2>&1 && fail "exited zero"
|
||||
[ ! -e docs ] || fail "wrote docs/"
|
||||
# commit_canonical: commit the canonical files as they stand. The stub
|
||||
# curl serves only the newest commit; every other commit gets a 404.
|
||||
commit_canonical() {
|
||||
git -C "$dir/canonical" add .gitignore .dockerignore .editorconfig \
|
||||
.golangci.yml .prettierrc prompts
|
||||
git -C "$dir/canonical" commit -q -m "Canonical"
|
||||
HASH="$(git -C "$dir/canonical" rev-parse HEAD)"
|
||||
}
|
||||
|
||||
echo "update-policy tests passed"
|
||||
# write_outdated_files: this repo's files, one canonical version behind,
|
||||
# with the repo's own entries in the places the script keeps them. The
|
||||
# comment above the closing comment in .gitignore is replaced, not kept.
|
||||
write_outdated_files() {
|
||||
cat > "$dir/repo/.gitignore" << 'EOF'
|
||||
*.log
|
||||
|
||||
# An outdated comment.
|
||||
# Own entries go below this comment.
|
||||
/myapp
|
||||
EOF
|
||||
cat > "$dir/repo/.dockerignore" << 'EOF'
|
||||
**/*.log
|
||||
|
||||
# Own entries go below this comment.
|
||||
/myapp
|
||||
EOF
|
||||
cat > "$dir/repo/.editorconfig" << 'EOF'
|
||||
root = true
|
||||
[*]
|
||||
|
||||
# Own sections go below this comment.
|
||||
[*.py]
|
||||
indent_size = 2
|
||||
EOF
|
||||
cat > "$dir/repo/.golangci.yml" << 'EOF'
|
||||
linters:
|
||||
settings:
|
||||
depguard:
|
||||
rules:
|
||||
test-support:
|
||||
deny:
|
||||
- pkg: net/http/httptest
|
||||
desc: canonical
|
||||
# Our own test helpers.
|
||||
- pkg: example.com/app/internal/apptest
|
||||
desc: own entry
|
||||
other:
|
||||
deny:
|
||||
- pkg: example.com/other
|
||||
EOF
|
||||
echo '{ "tabWidth": 2 }' > "$dir/repo/.prettierrc"
|
||||
echo "old policy" > "$dir/repo/REPO_POLICIES.md"
|
||||
}
|
||||
|
||||
# start_scenario <name>: make a new temp directory holding a repo with
|
||||
# the outdated files, not yet committed, and an empty origin.
|
||||
start_scenario() {
|
||||
scenario="$1"
|
||||
rm -rf "$dir"
|
||||
dir="$(mktemp -d)"
|
||||
: > "$dir/output"
|
||||
write_stub_curl
|
||||
write_canonical_files
|
||||
|
||||
# git clone reads no repo's own config, so the setting that points
|
||||
# git at the local canonical repository has to be in this file.
|
||||
export GIT_CONFIG_GLOBAL="$dir/gitconfig"
|
||||
git config --global user.name "Test"
|
||||
git config --global user.email "test@example.com"
|
||||
git config --global "url.$dir/canonical.insteadOf" \
|
||||
"https://git.eeqj.de/sneak/prompts.git"
|
||||
|
||||
git init -q -b main "$dir/canonical"
|
||||
export HASH
|
||||
commit_canonical
|
||||
|
||||
git init -q --bare -b main "$dir/origin.git"
|
||||
git init -q -b main "$dir/repo"
|
||||
git -C "$dir/repo" remote add origin "$dir/origin.git"
|
||||
|
||||
mkdir "$dir/repo/script"
|
||||
cp "$UPDATE_POLICY" "$dir/repo/script/update-policy"
|
||||
printf '#!/bin/sh\necho example\n' > "$dir/repo/script/projectname"
|
||||
chmod +x "$dir/repo/script/projectname"
|
||||
write_outdated_files
|
||||
}
|
||||
|
||||
# commit_and_push_fixture <paths...>: commit those paths, remove the
|
||||
# rest of the outdated files, and record the commit as $before.
|
||||
commit_and_push_fixture() {
|
||||
(
|
||||
cd "$dir/repo"
|
||||
git add script "$@"
|
||||
git commit -q -m "Fixture"
|
||||
git push -q origin HEAD
|
||||
git clean -q -f -x
|
||||
)
|
||||
before="$(git -C "$dir/repo" rev-parse HEAD)"
|
||||
}
|
||||
|
||||
run_update_policy() {
|
||||
status=0
|
||||
(cd "$dir/repo" && PATH="$dir/bin:$PATH" script/update-policy "$@") \
|
||||
> "$dir/output" 2>&1 || status=$?
|
||||
}
|
||||
|
||||
reject_pushes() {
|
||||
printf '#!/bin/sh\nexit 1\n' > "$dir/origin.git/hooks/pre-receive"
|
||||
chmod +x "$dir/origin.git/hooks/pre-receive"
|
||||
}
|
||||
|
||||
accept_pushes() {
|
||||
rm "$dir/origin.git/hooks/pre-receive"
|
||||
}
|
||||
|
||||
head_of_repo() {
|
||||
git -C "$dir/repo" rev-parse HEAD
|
||||
}
|
||||
|
||||
head_of_origin() {
|
||||
git -C "$dir/origin.git" rev-parse refs/heads/main
|
||||
}
|
||||
|
||||
expect_success() {
|
||||
[ "$status" -eq 0 ] || fail "exited $status"
|
||||
}
|
||||
|
||||
expect_failure() {
|
||||
[ "$status" -ne 0 ] || fail "exited 0"
|
||||
}
|
||||
|
||||
expect_output() {
|
||||
grep -q -F -e "$1" "$dir/output" || fail "output lacks: $1"
|
||||
}
|
||||
|
||||
expect_output_without() {
|
||||
if grep -q -F -e "$1" "$dir/output"; then
|
||||
fail "output has: $1"
|
||||
fi
|
||||
}
|
||||
|
||||
# expect_file <path>: the file must equal standard input.
|
||||
expect_file() {
|
||||
cat > "$dir/expected"
|
||||
diff "$dir/expected" "$dir/repo/$1" >&2 || fail "$1 is wrong"
|
||||
}
|
||||
|
||||
expect_absent() {
|
||||
[ ! -e "$dir/repo/$1" ] || fail "$1 exists"
|
||||
}
|
||||
|
||||
expect_nothing_written() {
|
||||
[ -z "$(git -C "$dir/repo" status --porcelain)" ] ||
|
||||
fail "the working tree changed"
|
||||
[ "$(head_of_repo)" = "$before" ] || fail "the repo has a new commit"
|
||||
[ "$(head_of_origin)" = "$before" ] || fail "origin has a new commit"
|
||||
}
|
||||
|
||||
test_own_entries_kept() {
|
||||
start_scenario "own entries kept in all four files"
|
||||
commit_and_push_fixture .gitignore .dockerignore .editorconfig \
|
||||
.golangci.yml .prettierrc REPO_POLICIES.md
|
||||
run_update_policy "$HASH"
|
||||
expect_success
|
||||
|
||||
expect_file .gitignore << 'EOF'
|
||||
*.log
|
||||
*.tmp
|
||||
|
||||
# Own entries go below this comment.
|
||||
/myapp
|
||||
EOF
|
||||
expect_file .dockerignore << 'EOF'
|
||||
**/*.log
|
||||
**/*.tmp
|
||||
|
||||
# Own entries go below this comment.
|
||||
/myapp
|
||||
EOF
|
||||
expect_file .editorconfig << 'EOF'
|
||||
root = true
|
||||
[*]
|
||||
indent_size = 4
|
||||
|
||||
# Own sections go below this comment.
|
||||
[*.py]
|
||||
indent_size = 2
|
||||
EOF
|
||||
expect_file .golangci.yml << 'EOF'
|
||||
linters:
|
||||
settings:
|
||||
depguard:
|
||||
rules:
|
||||
test-support:
|
||||
deny:
|
||||
- pkg: net/http/httptest
|
||||
desc: canonical
|
||||
- pkg: net/http/cgi
|
||||
desc: added canonically
|
||||
# Our own test helpers.
|
||||
- pkg: example.com/app/internal/apptest
|
||||
desc: own entry
|
||||
other:
|
||||
deny:
|
||||
- pkg: example.com/other
|
||||
EOF
|
||||
expect_file .prettierrc << 'EOF'
|
||||
{ "tabWidth": 4 }
|
||||
EOF
|
||||
expect_file REPO_POLICIES.md << 'EOF'
|
||||
new policy
|
||||
EOF
|
||||
|
||||
[ "$(head_of_origin)" = "$(head_of_repo)" ] ||
|
||||
fail "the commit was not pushed"
|
||||
[ "$(head_of_repo)" != "$before" ] || fail "no commit was made"
|
||||
git -C "$dir/repo" log -1 --format=%s | grep -q -F -e "$HASH" ||
|
||||
fail "the commit message does not name the hash"
|
||||
}
|
||||
|
||||
test_files_not_carried_are_skipped() {
|
||||
start_scenario "files the repo does not carry skipped"
|
||||
mkdir "$dir/repo/docs"
|
||||
mv "$dir/repo/REPO_POLICIES.md" "$dir/repo/docs/REPO_POLICIES.md"
|
||||
commit_and_push_fixture docs/REPO_POLICIES.md
|
||||
run_update_policy "$HASH"
|
||||
expect_success
|
||||
|
||||
expect_file docs/REPO_POLICIES.md << 'EOF'
|
||||
new policy
|
||||
EOF
|
||||
expect_absent REPO_POLICIES.md
|
||||
expect_absent API_POLICIES.md
|
||||
expect_absent docs/API_POLICIES.md
|
||||
expect_absent .gitignore
|
||||
expect_absent .dockerignore
|
||||
expect_absent .editorconfig
|
||||
expect_absent .golangci.yml
|
||||
expect_absent .prettierrc
|
||||
[ "$(head_of_origin)" = "$(head_of_repo)" ] ||
|
||||
fail "the commit was not pushed"
|
||||
}
|
||||
|
||||
test_nothing_changed() {
|
||||
start_scenario "nothing changed"
|
||||
cp "$dir/canonical/.prettierrc" "$dir/repo/.prettierrc"
|
||||
commit_and_push_fixture .prettierrc
|
||||
run_update_policy "$HASH"
|
||||
expect_success
|
||||
expect_output "nothing to commit"
|
||||
expect_nothing_written
|
||||
}
|
||||
|
||||
test_bad_commit_hash() {
|
||||
for hash in not-a-hash 0000000000000000000000000000000000000000; do
|
||||
start_scenario "bad commit hash $hash stops with nothing written"
|
||||
commit_and_push_fixture .gitignore .prettierrc REPO_POLICIES.md
|
||||
run_update_policy "$hash"
|
||||
expect_failure
|
||||
expect_nothing_written
|
||||
done
|
||||
# The last hash has the right form, so it is the one that reaches curl.
|
||||
expect_output "cannot fetch"
|
||||
}
|
||||
|
||||
test_push_failure() {
|
||||
start_scenario "push failure exits non-zero"
|
||||
commit_and_push_fixture .prettierrc
|
||||
reject_pushes
|
||||
run_update_policy "$HASH"
|
||||
expect_failure
|
||||
expect_output "push failed"
|
||||
[ "$(head_of_origin)" = "$before" ] || fail "origin has a new commit"
|
||||
}
|
||||
|
||||
# Each of these files, with the repo's own entries above the closing
|
||||
# comment. The comment added with them must not be named.
|
||||
test_own_entry_above_closing_comment() {
|
||||
for file in .gitignore .dockerignore .editorconfig; do
|
||||
start_scenario "own entries above the closing comment of $file stop"
|
||||
{
|
||||
printf '/myapp\n/.tool/\n\n# A comment of our own.\n'
|
||||
cat "$dir/repo/$file"
|
||||
} > "$dir/merged"
|
||||
mv "$dir/merged" "$dir/repo/$file"
|
||||
commit_and_push_fixture .gitignore .dockerignore .editorconfig \
|
||||
.prettierrc REPO_POLICIES.md
|
||||
run_update_policy "$HASH"
|
||||
expect_failure
|
||||
expect_output "$file has entries"
|
||||
expect_output "/myapp"
|
||||
expect_output "/.tool/"
|
||||
expect_output_without "A comment of our own."
|
||||
expect_nothing_written
|
||||
done
|
||||
}
|
||||
|
||||
test_retry_after_failed_push() {
|
||||
start_scenario "a retry after a failed push delivers the commit"
|
||||
commit_and_push_fixture .prettierrc
|
||||
reject_pushes
|
||||
run_update_policy "$HASH"
|
||||
expect_failure
|
||||
committed="$(head_of_repo)"
|
||||
[ "$committed" != "$before" ] || fail "no commit was made"
|
||||
[ "$(head_of_origin)" = "$before" ] || fail "origin has a new commit"
|
||||
|
||||
accept_pushes
|
||||
run_update_policy "$HASH"
|
||||
expect_success
|
||||
[ "$(head_of_repo)" = "$committed" ] || fail "the retry made a new commit"
|
||||
[ "$(head_of_origin)" = "$committed" ] ||
|
||||
fail "the retry did not deliver the commit"
|
||||
}
|
||||
|
||||
test_uncommitted_change_stops() {
|
||||
start_scenario "a carried file with uncommitted changes stops"
|
||||
commit_and_push_fixture .prettierrc REPO_POLICIES.md
|
||||
echo "uncommitted" >> "$dir/repo/REPO_POLICIES.md"
|
||||
run_update_policy "$HASH"
|
||||
expect_failure
|
||||
expect_output "REPO_POLICIES.md has uncommitted changes"
|
||||
expect_file REPO_POLICIES.md << 'EOF'
|
||||
old policy
|
||||
uncommitted
|
||||
EOF
|
||||
[ "$(head_of_repo)" = "$before" ] || fail "the repo has a new commit"
|
||||
[ "$(head_of_origin)" = "$before" ] || fail "origin has a new commit"
|
||||
}
|
||||
|
||||
test_gitignore_lacks_canonical_last_line() {
|
||||
start_scenario ".gitignore lacking the canonical last line stops"
|
||||
printf '*.log\n/myapp\n' > "$dir/repo/.gitignore"
|
||||
commit_and_push_fixture .gitignore .prettierrc
|
||||
run_update_policy "$HASH"
|
||||
expect_failure
|
||||
expect_output ".gitignore lacks this line"
|
||||
expect_nothing_written
|
||||
}
|
||||
|
||||
test_fetched_golangci_without_deny_list() {
|
||||
start_scenario "a fetched .golangci.yml with no deny list stops"
|
||||
cat > "$dir/canonical/.golangci.yml" << 'EOF'
|
||||
linters:
|
||||
settings:
|
||||
depguard:
|
||||
rules:
|
||||
test-support:
|
||||
files:
|
||||
- "**/*.go"
|
||||
other:
|
||||
deny:
|
||||
- pkg: example.com/other
|
||||
EOF
|
||||
commit_and_push_fixture .golangci.yml .prettierrc
|
||||
run_update_policy "$HASH"
|
||||
expect_failure
|
||||
expect_output "no deny list in its test-support rule"
|
||||
expect_nothing_written
|
||||
}
|
||||
|
||||
test_own_golangci_setting_stops() {
|
||||
start_scenario "a .golangci.yml setting the canonical file lacks stops"
|
||||
cat >> "$dir/repo/.golangci.yml" << 'EOF'
|
||||
# A comment of our own.
|
||||
forbidigo:
|
||||
forbid:
|
||||
- pattern: model.Operator
|
||||
EOF
|
||||
commit_and_push_fixture .golangci.yml .prettierrc
|
||||
run_update_policy "$HASH"
|
||||
expect_failure
|
||||
expect_output ".golangci.yml has lines"
|
||||
expect_output "forbidigo:"
|
||||
expect_output "- pattern: model.Operator"
|
||||
expect_output_without "A comment of our own."
|
||||
expect_nothing_written
|
||||
}
|
||||
|
||||
test_source_repo_stops() {
|
||||
start_scenario "the repo the policy files come from stops"
|
||||
printf '#!/bin/sh\necho prompts\n' > "$dir/repo/script/projectname"
|
||||
commit_and_push_fixture .prettierrc REPO_POLICIES.md
|
||||
run_update_policy "$HASH"
|
||||
expect_failure
|
||||
expect_output "this repo is the source of the policy files"
|
||||
expect_nothing_written
|
||||
}
|
||||
|
||||
test_staged_file_stays_out_of_commit() {
|
||||
start_scenario "a file staged before the script starts stays out of its commit"
|
||||
commit_and_push_fixture .prettierrc
|
||||
echo "notes" > "$dir/repo/notes.txt"
|
||||
git -C "$dir/repo" add notes.txt
|
||||
run_update_policy "$HASH"
|
||||
expect_success
|
||||
[ "$(git -C "$dir/repo" show --name-only --format= HEAD)" = ".prettierrc" ] ||
|
||||
fail "the commit holds more than the policy file"
|
||||
[ "$(git -C "$dir/repo" diff --cached --name-only)" = "notes.txt" ] ||
|
||||
fail "notes.txt is no longer staged"
|
||||
}
|
||||
|
||||
test_short_commit_hash_refused() {
|
||||
start_scenario "a hexadecimal hash shorter than 40 characters is refused"
|
||||
commit_and_push_fixture .prettierrc
|
||||
run_update_policy "${HASH%?}"
|
||||
expect_failure
|
||||
expect_output "not a full commit hash"
|
||||
expect_nothing_written
|
||||
}
|
||||
|
||||
# git asks the local canonical repository for the head of main, and the
|
||||
# stub curl serves only that commit.
|
||||
test_no_hash_uses_head_of_main() {
|
||||
start_scenario "with no hash the script uses the head of main"
|
||||
commit_and_push_fixture .prettierrc
|
||||
run_update_policy
|
||||
expect_success
|
||||
expect_file .prettierrc << 'EOF'
|
||||
{ "tabWidth": 4 }
|
||||
EOF
|
||||
git -C "$dir/repo" log -1 --format=%s | grep -q -F -e "$HASH" ||
|
||||
fail "the commit message does not name the head of main"
|
||||
[ "$(head_of_origin)" = "$(head_of_repo)" ] ||
|
||||
fail "the commit was not pushed"
|
||||
}
|
||||
|
||||
# expect_former_canonical_line_replaced <file> <line>: an earlier
|
||||
# canonical commit held the line and the newest does not. This repo's
|
||||
# file still has it, and the script replaces it and pushes.
|
||||
expect_former_canonical_line_replaced() {
|
||||
cp "$dir/canonical/$1" "$dir/newest"
|
||||
{ echo "$2"; cat "$dir/newest"; } > "$dir/canonical/$1"
|
||||
commit_canonical
|
||||
cp "$dir/newest" "$dir/canonical/$1"
|
||||
commit_canonical
|
||||
{ echo "$2"; cat "$dir/repo/$1"; } > "$dir/merged"
|
||||
mv "$dir/merged" "$dir/repo/$1"
|
||||
commit_and_push_fixture "$1" .prettierrc
|
||||
|
||||
run_update_policy "$HASH"
|
||||
expect_success
|
||||
if grep -q -F -x -e "$2" "$dir/repo/$1"; then
|
||||
fail "$1 still has: $2"
|
||||
fi
|
||||
[ "$(head_of_repo)" != "$before" ] || fail "no commit was made"
|
||||
[ "$(head_of_origin)" = "$(head_of_repo)" ] ||
|
||||
fail "the commit was not pushed"
|
||||
}
|
||||
|
||||
test_former_canonical_golangci_line_replaced() {
|
||||
start_scenario "a .golangci.yml line an earlier canonical commit held is replaced"
|
||||
expect_former_canonical_line_replaced .golangci.yml "version: 1"
|
||||
}
|
||||
|
||||
test_former_canonical_gitignore_line_replaced() {
|
||||
start_scenario "a .gitignore line above the closing comment that an earlier canonical commit held is replaced"
|
||||
expect_former_canonical_line_replaced .gitignore "*.old"
|
||||
}
|
||||
|
||||
main() {
|
||||
test_own_entries_kept
|
||||
test_files_not_carried_are_skipped
|
||||
test_nothing_changed
|
||||
test_bad_commit_hash
|
||||
test_push_failure
|
||||
test_own_entry_above_closing_comment
|
||||
test_retry_after_failed_push
|
||||
test_uncommitted_change_stops
|
||||
test_gitignore_lacks_canonical_last_line
|
||||
test_fetched_golangci_without_deny_list
|
||||
test_own_golangci_setting_stops
|
||||
test_source_repo_stops
|
||||
test_staged_file_stays_out_of_commit
|
||||
test_short_commit_hash_refused
|
||||
test_no_hash_uses_head_of_main
|
||||
test_former_canonical_golangci_line_replaced
|
||||
test_former_canonical_gitignore_line_replaced
|
||||
echo "update-policy tests passed"
|
||||
}
|
||||
|
||||
main "$@"
|
||||
Reference in new issue
Block a user