Compare commits
9
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e34c7bf42d | ||
|
|
d8a4a2733a | ||
|
|
6378311ac5 | ||
|
|
29496c2586 | ||
|
|
47b35661a2 | ||
|
|
630437e620 | ||
|
|
22d08ecd0e | ||
|
|
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,41 +127,23 @@ 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
|
||||||
extension); `make hooks` shims to it
|
extension); `make hooks` shims to it
|
||||||
- `script/update-policy` — fetch the vendored policy files from this repo,
|
- `script/update-policy` — fetch the shared policy files from this repo and
|
||||||
commit them and push (our own extension); it is for the repos that vendor them
|
commit them, without pushing (our own extension); it is for the repos that
|
||||||
and stops when run here
|
carry them and stops when run here
|
||||||
|
|
||||||
`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
|
||||||
@@ -175,7 +155,8 @@ share, and evolve prompts across projects.
|
|||||||
The repository is a collection of Markdown files organized in the `prompts/`
|
The repository is a collection of Markdown files organized in the `prompts/`
|
||||||
subdirectory. Each file contains one or more related prompts or policy
|
subdirectory. Each file contains one or more related prompts or policy
|
||||||
documents. There is no build step or runtime component; the prompts are consumed
|
documents. There is no build step or runtime component; the prompts are consumed
|
||||||
by copying them into other projects or referencing them directly.
|
by copying them into other projects or referencing them directly. `examples/`
|
||||||
|
holds the example `Dockerfile` files that `prompts/REPO_POLICIES.md` links to.
|
||||||
|
|
||||||
## See Also
|
## See Also
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,7 @@
|
|||||||
|
FROM golangci/golangci-lint@sha256:... AS lint
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends libvips-dev \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
@@ -0,0 +1,77 @@
|
|||||||
|
# The steps that install system packages and download Go's modules
|
||||||
|
# come before COPY . ., so a change to the code keeps their layers.
|
||||||
|
# The steps that compile mount Go's build cache, and golangci-lint run
|
||||||
|
# also mounts golangci-lint's; both survive from build to build.
|
||||||
|
|
||||||
|
# Lint phase
|
||||||
|
# golangci/golangci-lint:v2.x.x, YYYY-MM-DD
|
||||||
|
FROM golangci/golangci-lint@sha256:... AS lint
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY . .
|
||||||
|
RUN --mount=type=cache,target=/root/.cache/go-build \
|
||||||
|
--mount=type=cache,target=/root/.cache/golangci-lint \
|
||||||
|
golangci-lint run --config .golangci.yml ./...
|
||||||
|
|
||||||
|
# Test phase. -race needs cgo and so a C compiler, which the Debian Go
|
||||||
|
# image ships and the alpine one does not. -count=1 because the mounted
|
||||||
|
# cache also holds test results, which go test would otherwise replay.
|
||||||
|
# A first run that timed out gets no rerun, because a rerun would only
|
||||||
|
# wait for the same hang.
|
||||||
|
# golang:1.x, YYYY-MM-DD
|
||||||
|
FROM golang@sha256:... AS test
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
COPY . .
|
||||||
|
RUN --mount=type=cache,target=/root/.cache/go-build \
|
||||||
|
status=0; \
|
||||||
|
output=$(go test -count=1 -timeout 90s -race -cover ./... 2>&1) || status=$?; \
|
||||||
|
printf '%s\n' "$output"; \
|
||||||
|
test "$status" -eq 0 && exit 0; \
|
||||||
|
case "$output" in \
|
||||||
|
*"panic: test timed out"*|*"*** Test killed"*) exit 1 ;; \
|
||||||
|
esac; \
|
||||||
|
echo "--- Rerunning with -v for details ---"; \
|
||||||
|
go test -count=1 -timeout 90s -race -v ./...; \
|
||||||
|
exit 1
|
||||||
|
|
||||||
|
# Build stage. Nothing is wanted from either phase above; the copies
|
||||||
|
# are what make BuildKit build them first, so nothing after them can
|
||||||
|
# run unless lint and test passed.
|
||||||
|
# golang:1.x-alpine, YYYY-MM-DD
|
||||||
|
FROM golang@sha256:... AS builder
|
||||||
|
# git comes from the base image's own distribution package index, which
|
||||||
|
# is trusted, so it needs no version and no hash.
|
||||||
|
RUN apk add --no-cache git
|
||||||
|
WORKDIR /src
|
||||||
|
COPY go.mod go.sum ./
|
||||||
|
RUN go mod download
|
||||||
|
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.
|
||||||
|
RUN git config --system --add safe.directory /src
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# The VERSION build arg when one is given, otherwise
|
||||||
|
# `git describe --tags --always` on the .git in the build context. With
|
||||||
|
# .git present, a version that is still empty, dev or unknown fails the
|
||||||
|
# build: git is missing or could not read the checkout.
|
||||||
|
ARG VERSION
|
||||||
|
RUN --mount=type=cache,target=/root/.cache/go-build \
|
||||||
|
VERSION="${VERSION:-$(git describe --tags --always)}"; \
|
||||||
|
if [ -e .git ]; then \
|
||||||
|
case "$VERSION" in ""|dev|unknown) \
|
||||||
|
echo "version is '$VERSION' although .git is present" >&2; \
|
||||||
|
exit 1 ;; \
|
||||||
|
esac; \
|
||||||
|
fi; \
|
||||||
|
CGO_ENABLED=0 go build -trimpath \
|
||||||
|
-ldflags="-s -w -X main.Version=${VERSION}" \
|
||||||
|
-o /app ./cmd/app/
|
||||||
|
|
||||||
|
# Runtime stage, and the last one
|
||||||
|
FROM alpine@sha256:...
|
||||||
|
COPY --from=builder /app /usr/local/bin/app
|
||||||
|
ENTRYPOINT ["app"]
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
# Test phase. Both pytest runs share one 90-second timeout, so a hang
|
||||||
|
# uses it once and gets no rerun.
|
||||||
|
# debian:trixie-slim, YYYY-MM-DD
|
||||||
|
FROM debian@sha256:... AS test
|
||||||
|
# Python, pip and venv come from the distribution, which is trusted, so
|
||||||
|
# they need no version and no hash. make and git are base tools that
|
||||||
|
# script/bootstrap installs when they are missing. Installed here, they
|
||||||
|
# stay in their own layer when script/ changes.
|
||||||
|
RUN apt-get update \
|
||||||
|
&& apt-get install -y --no-install-recommends ca-certificates make git \
|
||||||
|
python3 python3-venv \
|
||||||
|
&& rm -rf /var/lib/apt/lists/*
|
||||||
|
# script/bootstrap installs pipenv in a virtual environment at
|
||||||
|
# $HOME/.pipenv, and the tests below run that pipenv.
|
||||||
|
ENV PATH=/root/.pipenv/bin:$PATH
|
||||||
|
WORKDIR /app
|
||||||
|
COPY script/ script/
|
||||||
|
COPY Pipfile Pipfile.lock ./
|
||||||
|
RUN script/bootstrap
|
||||||
|
COPY . .
|
||||||
|
RUN timeout 90 sh -c 'pipenv run pytest || { \
|
||||||
|
echo "--- Rerunning with -v for details ---"; \
|
||||||
|
pipenv run pytest -v; exit 1; }'
|
||||||
@@ -113,13 +113,7 @@ last_modified: 2026-11-16
|
|||||||
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)
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Existing Repo Checklist
|
title: Existing Repo Checklist
|
||||||
last_modified: 2026-11-09
|
last_modified: 2026-11-18
|
||||||
---
|
---
|
||||||
|
|
||||||
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
|
||||||
@@ -22,7 +22,7 @@ with your task.
|
|||||||
- [ ] `README.md` exists with all required sections (Description, Getting
|
- [ ] `README.md` exists with all required sections (Description, Getting
|
||||||
Started, Rationale, Design, TODO, License, Author)
|
Started, Rationale, Design, TODO, License, Author)
|
||||||
- [ ] `LICENSE` file exists and matches the README
|
- [ ] `LICENSE` file exists and matches the README
|
||||||
- [ ] `REPO_POLICIES.md` exists and version date is current — fetch from
|
- [ ] `docs/REPO_POLICIES.md` exists and version date is current — fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md`
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md`
|
||||||
- [ ] Guidance for coding agents, if the repo has any, is one `AGENTS.md` at the
|
- [ ] Guidance for coding agents, if the repo has any, is one `AGENTS.md` at the
|
||||||
root — never a file or directory named after one agent tool, such as
|
root — never a file or directory named after one agent tool, such as
|
||||||
@@ -49,32 +49,17 @@ 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
|
||||||
(`--mount=type=cache,target=/root/.cache/golangci-lint`), and no step
|
(`--mount=type=cache,target=/root/.cache/golangci-lint`), and no step
|
||||||
mounts anything else; both `go test` runs carry `-count=1`; a first run
|
mounts anything else; both `go test` runs carry `-count=1`; a first run
|
||||||
that timed out gets no rerun, as in the canonical Go `Dockerfile` in
|
that timed out gets no rerun, as in `examples/go.Dockerfile` in the
|
||||||
`REPO_POLICIES.md`
|
`prompts` repo
|
||||||
- [ ] 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
|
||||||
installs its Python packages after it, as in the Python `test` phase example
|
`examples/python-test-phase.Dockerfile` in the `prompts` repo
|
||||||
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
|
||||||
@@ -212,34 +196,25 @@ with your task.
|
|||||||
- [ ] `script/precommit` exists and the pre-commit hook (installed by
|
- [ ] `script/precommit` exists and the pre-commit hook (installed by
|
||||||
`script/install-precommit`, shimmed by `make hooks`) runs it
|
`script/install-precommit`, shimmed by `make hooks`) runs it
|
||||||
- [ ] `script/update-policy` exists, identical to the model script, and
|
- [ ] `script/update-policy` exists, identical to the model script, and
|
||||||
`make update-policy` shims to it. Before its first use, the repo's own
|
`make update-policy` shims to it
|
||||||
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/`
|
- [ ] 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 +302,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-18
|
||||||
---
|
---
|
||||||
|
|
||||||
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
|
||||||
@@ -55,7 +55,7 @@ Template files can be fetched from:
|
|||||||
## Create Project Files
|
## Create Project Files
|
||||||
|
|
||||||
- [ ] `LICENSE` file matching the chosen license
|
- [ ] `LICENSE` file matching the chosen license
|
||||||
- [ ] `REPO_POLICIES.md` — fetch from
|
- [ ] `docs/REPO_POLICIES.md` — fetch from
|
||||||
`https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md`
|
`https://git.eeqj.de/sneak/prompts/raw/branch/main/prompts/REPO_POLICIES.md`
|
||||||
- [ ] Guidance for coding agents, if the repo has any, is one `AGENTS.md` at the
|
- [ ] Guidance for coding agents, if the repo has any, is one `AGENTS.md` at the
|
||||||
root — never a file or directory named after one agent tool, such as
|
root — never a file or directory named after one agent tool, such as
|
||||||
@@ -118,32 +118,17 @@ 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
|
||||||
(`--mount=type=cache,target=/root/.cache/golangci-lint`), and no step
|
(`--mount=type=cache,target=/root/.cache/golangci-lint`), and no step
|
||||||
mounts anything else; both `go test` runs carry `-count=1`; a first run
|
mounts anything else; both `go test` runs carry `-count=1`; a first run
|
||||||
that timed out gets no rerun, as in the canonical Go `Dockerfile` in
|
that timed out gets no rerun, as in `examples/go.Dockerfile` in the
|
||||||
`REPO_POLICIES.md`
|
`prompts` repo
|
||||||
- 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,9 +146,8 @@ 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
|
||||||
other stage installs its Python packages after it, as in the Python
|
`examples/python-test-phase.Dockerfile` in the `prompts` repo
|
||||||
`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
|
||||||
- Non-server: the final stage brings up the dev environment
|
- Non-server: the final stage brings up the dev environment
|
||||||
@@ -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
|
||||||
@@ -266,9 +248,8 @@ are thin shims calling them. Model scripts:
|
|||||||
- [ ] `script/install-precommit` — installs the pre-commit hook that runs
|
- [ ] `script/install-precommit` — installs the pre-commit hook that runs
|
||||||
`script/precommit`
|
`script/precommit`
|
||||||
- [ ] `make hooks` — shims to `script/install-precommit`
|
- [ ] `make hooks` — shims to `script/install-precommit`
|
||||||
- [ ] `script/update-policy` / `make update-policy` — fetches the vendored
|
- [ ] `script/update-policy` / `make update-policy` — fetches the shared policy
|
||||||
policy files from the `prompts` repo, commits them and pushes; identical
|
files from the `prompts` repo and commits them; identical across repos
|
||||||
across repos
|
|
||||||
- [ ] README **Entrypoints** section documents the scripts and links the
|
- [ ] README **Entrypoints** section documents the scripts and links the
|
||||||
standard
|
standard
|
||||||
|
|
||||||
@@ -279,14 +260,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.
|
||||||
|
|||||||
+564
-812
File diff suppressed because it is too large.
Load diff
+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 "$@"
|
||||||
+37
-196
@@ -1,43 +1,17 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/update-policy: replace this repo's vendored policy files with
|
# script/update-policy: replace the files below with their current
|
||||||
# the canonical ones from the prompts repo, commit them and push.
|
# versions from the main branch of the prompts repo, and commit them. It
|
||||||
# Identical in all repos. Our own extension to
|
# does not push. Identical in all repos, and it updates itself.
|
||||||
# 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
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
PROMPTS_URL="https://git.eeqj.de/sneak/prompts"
|
RAW_URL="https://git.eeqj.de/sneak/prompts/raw/branch/main"
|
||||||
|
|
||||||
# Paths in the prompts repo. A file this repo does not carry is skipped.
|
# Each entry is the path in prompts, a colon, then the path in this repo.
|
||||||
VENDORED_FILES="
|
FILES="
|
||||||
.dockerignore
|
prompts/REPO_POLICIES.md:docs/REPO_POLICIES.md
|
||||||
.editorconfig
|
prompts/CODE_STYLEGUIDE.md:docs/CODE_STYLEGUIDE.md
|
||||||
.gitea/workflows/check.yml
|
script/update-policy:script/update-policy
|
||||||
.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() {
|
die() {
|
||||||
@@ -45,178 +19,45 @@ die() {
|
|||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
|
||||||
# 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
|
|
||||||
}
|
|
||||||
|
|
||||||
# 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"
|
|
||||||
}
|
|
||||||
|
|
||||||
# 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"
|
|
||||||
}
|
|
||||||
|
|
||||||
# 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]
|
|
||||||
}
|
|
||||||
|
|
||||||
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() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
|
[ ! -e prompts/REPO_POLICIES.md ] ||
|
||||||
|
die "this is the prompts repo, where these files come from"
|
||||||
|
[ ! -e REPO_POLICIES.md ] ||
|
||||||
|
die "REPO_POLICIES.md is at the root;" \
|
||||||
|
"move it into docs/ with git mv and fix the links to it first"
|
||||||
|
|
||||||
[ "$#" -le 1 ] || die "usage: script/update-policy [full commit hash]"
|
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"
|
||||||
|
|
||||||
project="$(script/projectname)"
|
# Every file is fetched before any is replaced. The temporary
|
||||||
if [ "$project" = "prompts" ]; then
|
# directory is inside the repo so that mv renames: the running script
|
||||||
die "this repo is the source of the policy files"
|
# is replaced by a new file, never rewritten in place.
|
||||||
fi
|
tmp="$(mktemp -d "$ROOT/.update-policy.XXXXXX")"
|
||||||
|
|
||||||
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
|
trap 'rm -rf "$tmp"' EXIT
|
||||||
|
for entry in $FILES; do
|
||||||
git clone --quiet --bare "$PROMPTS_URL.git" "$tmp/prompts.git" ||
|
mkdir -p "$tmp/$(dirname "${entry#*:}")"
|
||||||
die "cannot clone $PROMPTS_URL.git"
|
wget -q -T 60 -O "$tmp/${entry#*:}" "$RAW_URL/${entry%%:*}" ||
|
||||||
|
die "cannot fetch $RAW_URL/${entry%%:*}"
|
||||||
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
|
done
|
||||||
[ -n "$carried" ] || die "this repo carries none of the vendored files"
|
chmod 755 "$tmp/script/update-policy"
|
||||||
|
|
||||||
for path in $carried; do
|
for path in $paths; do
|
||||||
case "$path" in
|
mkdir -p "$(dirname "$path")"
|
||||||
.gitignore | .editorconfig | .dockerignore)
|
mv "$tmp/$path" "$path"
|
||||||
keep_lines_below_last "$tmp/$path" "$path"
|
|
||||||
;;
|
|
||||||
.golangci.yml)
|
|
||||||
keep_deny_entries "$tmp/$path" "$path"
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
done
|
done
|
||||||
|
|
||||||
for path in $carried; do
|
git add -- $paths
|
||||||
cp "$tmp/$path" "$path"
|
if git diff --cached --quiet -- $paths; then
|
||||||
git add -- "$path"
|
echo "update-policy: already current, nothing to commit"
|
||||||
done
|
|
||||||
|
|
||||||
if git diff --cached --quiet -- $carried; then
|
|
||||||
echo "update-policy: already at prompts $commit, nothing to commit"
|
|
||||||
else
|
else
|
||||||
git commit -m "Update policy files from prompts $commit" -- $carried
|
git commit -q -m "Update policy files from prompts" -- $paths
|
||||||
|
echo "update-policy: committed; review it, then push"
|
||||||
fi
|
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 "$@"
|
main "$@"
|
||||||
+77
-542
@@ -1,14 +1,14 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# test/update-policy.sh: test script/update-policy on throwaway repos.
|
# test/update-policy.sh: test script/update-policy on throwaway repos. A
|
||||||
# Each scenario gets one temp directory holding a repo, its local bare
|
# stub wget serves the files from this checkout, or fails for the path
|
||||||
# origin, a local git repository of the canonical files in place of
|
# in WGET_FAIL, so nothing touches the network. Like wget, it writes a
|
||||||
# prompts, and a stub curl that serves them, so nothing touches the
|
# new file without the execute bit, whatever the source's mode.
|
||||||
# network.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
UPDATE_POLICY="$(cd "$(dirname "$0")/.." && pwd -P)/script/update-policy"
|
PROMPTS="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
LISTED="docs/REPO_POLICIES.md docs/CODE_STYLEGUIDE.md script/update-policy"
|
||||||
|
|
||||||
dir=""
|
dir="$(mktemp -d)"
|
||||||
trap 'rm -rf "$dir"' EXIT
|
trap 'rm -rf "$dir"' EXIT
|
||||||
|
|
||||||
fail() {
|
fail() {
|
||||||
@@ -17,551 +17,86 @@ fail() {
|
|||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
|
||||||
write_stub_curl() {
|
mkdir "$dir/bin"
|
||||||
mkdir "$dir/bin"
|
cat > "$dir/bin/wget" << EOF
|
||||||
cat > "$dir/bin/curl" << 'EOF'
|
|
||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
previous=""
|
while [ "\$#" -gt 1 ]; do
|
||||||
fail_flag=""
|
[ "\$1" = "-O" ] && output="\$2"
|
||||||
for argument in "$@"; do
|
shift
|
||||||
[ "$previous" = "--output" ] && output="$argument"
|
|
||||||
[ "$argument" = "--fail" ] && fail_flag=yes
|
|
||||||
previous="$argument"
|
|
||||||
done
|
done
|
||||||
url="$previous"
|
path="\${1#https://git.eeqj.de/sneak/prompts/raw/branch/main/}"
|
||||||
base="https://git.eeqj.de/sneak/prompts/raw/commit/$HASH/"
|
[ "\$path" != "\${WGET_FAIL:-}" ] || exit 1
|
||||||
path="${url#"$base"}"
|
cat "$PROMPTS/\$path" > "\$output"
|
||||||
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
|
EOF
|
||||||
chmod +x "$dir/bin/curl"
|
chmod +x "$dir/bin/wget"
|
||||||
}
|
PATH="$dir/bin:$PATH"
|
||||||
|
export PATH
|
||||||
|
|
||||||
write_canonical_files() {
|
# new_repo: a repo with one commit, holding only an older copy of the
|
||||||
mkdir -p "$dir/canonical/prompts"
|
# script that is shorter than the new one. A run that rewrote the running
|
||||||
cat > "$dir/canonical/.gitignore" << 'EOF'
|
# script in place, instead of replacing it, would then read the new
|
||||||
*.log
|
# file's last lines as commands and fail.
|
||||||
*.tmp
|
new_repo() {
|
||||||
|
|
||||||
# Own entries go below this comment.
|
|
||||||
EOF
|
|
||||||
cat > "$dir/canonical/.dockerignore" << 'EOF'
|
|
||||||
**/*.log
|
|
||||||
**/*.tmp
|
|
||||||
|
|
||||||
# Own entries go below this comment.
|
|
||||||
EOF
|
|
||||||
cat > "$dir/canonical/.editorconfig" << 'EOF'
|
|
||||||
root = true
|
|
||||||
[*]
|
|
||||||
indent_size = 4
|
|
||||||
|
|
||||||
# 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"
|
|
||||||
}
|
|
||||||
|
|
||||||
# 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)"
|
|
||||||
}
|
|
||||||
|
|
||||||
# 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"
|
scenario="$1"
|
||||||
rm -rf "$dir"
|
rm -rf "$dir/repo"
|
||||||
dir="$(mktemp -d)"
|
git init -q "$dir/repo"
|
||||||
: > "$dir/output"
|
cd "$dir/repo"
|
||||||
write_stub_curl
|
git config user.name test
|
||||||
write_canonical_files
|
git config user.email test@example.com
|
||||||
|
mkdir script
|
||||||
# git clone reads no repo's own config, so the setting that points
|
grep -v '^# ' "$PROMPTS/script/update-policy" > script/update-policy
|
||||||
# git at the local canonical repository has to be in this file.
|
chmod +x script/update-policy
|
||||||
export GIT_CONFIG_GLOBAL="$dir/gitconfig"
|
echo own > README.md
|
||||||
git config --global user.name "Test"
|
git add README.md script/update-policy
|
||||||
git config --global user.email "test@example.com"
|
git commit -q -m initial
|
||||||
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
|
new_repo "a first run writes and commits exactly the listed files"
|
||||||
# rest of the outdated files, and record the commit as $before.
|
echo stray > stray.txt
|
||||||
commit_and_push_fixture() {
|
echo staged >> README.md
|
||||||
(
|
git add README.md
|
||||||
cd "$dir/repo"
|
script/update-policy > "$dir/output" 2>&1 || fail "exited non-zero"
|
||||||
git add script "$@"
|
[ "$(git rev-list --count HEAD)" = 2 ] || fail "made no single commit"
|
||||||
git commit -q -m "Fixture"
|
[ "$(git show --name-only --format= HEAD | sort)" = \
|
||||||
git push -q origin HEAD
|
"$(echo "$LISTED" | tr ' ' '\n' | sort)" ] || fail "commit holds other files"
|
||||||
git clean -q -f -x
|
cmp -s docs/REPO_POLICIES.md "$PROMPTS/prompts/REPO_POLICIES.md" ||
|
||||||
)
|
fail "REPO_POLICIES.md differs"
|
||||||
before="$(git -C "$dir/repo" rev-parse HEAD)"
|
[ -x script/update-policy ] || fail "script not executable"
|
||||||
}
|
[ "$(git status --porcelain)" = "$(printf 'M README.md\n?? stray.txt')" ] ||
|
||||||
|
fail "changed files outside the list"
|
||||||
|
|
||||||
run_update_policy() {
|
scenario="a second run commits nothing"
|
||||||
status=0
|
script/update-policy > "$dir/output" 2>&1 || fail "exited non-zero"
|
||||||
(cd "$dir/repo" && PATH="$dir/bin:$PATH" script/update-policy "$@") \
|
[ "$(git rev-list --count HEAD)" = 2 ] || fail "made a commit"
|
||||||
> "$dir/output" 2>&1 || status=$?
|
grep -q "nothing to commit" "$dir/output" || fail "did not say so"
|
||||||
}
|
|
||||||
|
|
||||||
reject_pushes() {
|
new_repo "a failed fetch writes nothing"
|
||||||
printf '#!/bin/sh\nexit 1\n' > "$dir/origin.git/hooks/pre-receive"
|
WGET_FAIL=prompts/CODE_STYLEGUIDE.md script/update-policy > "$dir/output" 2>&1 &&
|
||||||
chmod +x "$dir/origin.git/hooks/pre-receive"
|
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"
|
||||||
|
|
||||||
accept_pushes() {
|
new_repo "an uncommitted change to a listed file stops the script"
|
||||||
rm "$dir/origin.git/hooks/pre-receive"
|
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"
|
||||||
|
|
||||||
head_of_repo() {
|
new_repo "a REPO_POLICIES.md at the root stops the script"
|
||||||
git -C "$dir/repo" rev-parse HEAD
|
echo old > REPO_POLICIES.md
|
||||||
}
|
git add REPO_POLICIES.md
|
||||||
|
git commit -q -m "root policy file"
|
||||||
|
script/update-policy > "$dir/output" 2>&1 && fail "exited zero"
|
||||||
|
grep -q "git mv" "$dir/output" || fail "did not say to move it"
|
||||||
|
[ ! -e docs ] || fail "wrote docs/"
|
||||||
|
[ -z "$(git status --porcelain)" ] || fail "tree changed"
|
||||||
|
[ "$(git rev-list --count HEAD)" = 2 ] || fail "made a commit"
|
||||||
|
|
||||||
head_of_origin() {
|
new_repo "the prompts repo itself is refused"
|
||||||
git -C "$dir/origin.git" rev-parse refs/heads/main
|
mkdir prompts
|
||||||
}
|
echo source > prompts/REPO_POLICIES.md
|
||||||
|
script/update-policy > "$dir/output" 2>&1 && fail "exited zero"
|
||||||
|
[ ! -e docs ] || fail "wrote docs/"
|
||||||
|
|
||||||
expect_success() {
|
echo "update-policy tests passed"
|
||||||
[ "$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