Compare commits
1 Commits
fix/115-ci
...
fix/117-bo
| Author | SHA1 | Date | |
|---|---|---|---|
| db933f32a6 |
21
Dockerfile
21
Dockerfile
@@ -15,25 +15,8 @@ RUN go mod download
|
|||||||
|
|
||||||
COPY . .
|
COPY . .
|
||||||
|
|
||||||
# Run all checks - build fails if any check fails.
|
# Run all checks - build fails if any check fails
|
||||||
#
|
RUN make check
|
||||||
# CHECK_EPOCH is a cache-busting build argument. Without it, an
|
|
||||||
# unchanged tree leaves this layer's cache key identical and Docker
|
|
||||||
# serves the previous verdict instead of re-running the suite, so the
|
|
||||||
# build reports a green it did not earn. A build argument's value
|
|
||||||
# participates in the cache key of later instructions in the stage even
|
|
||||||
# when they do not reference it, so a fresh value busts this layer
|
|
||||||
# either way. It is expanded into the command deliberately: that makes
|
|
||||||
# the invalidation a property of the command string itself rather than
|
|
||||||
# of how a given builder treats unreferenced args, and it surfaces the
|
|
||||||
# epoch in the build log as a diagnostic.
|
|
||||||
#
|
|
||||||
# Placing the ARG here and nowhere earlier keeps everything above it
|
|
||||||
# (toolchain install, go mod download) cached, so only the check and the
|
|
||||||
# steps after it re-run. script/cibuild passes a fresh value per run; a
|
|
||||||
# plain `docker build` without it caches as before.
|
|
||||||
ARG CHECK_EPOCH
|
|
||||||
RUN echo "check epoch: ${CHECK_EPOCH}" && make check
|
|
||||||
|
|
||||||
# Build the binary
|
# Build the binary
|
||||||
RUN make build
|
RUN make build
|
||||||
|
|||||||
@@ -393,10 +393,7 @@ them. We provide:
|
|||||||
- `script/check` — run test, lint, and fmt-check
|
- `script/check` — run test, lint, and fmt-check
|
||||||
- `script/docker` — build the Docker image tagged via
|
- `script/docker` — build the Docker image tagged via
|
||||||
`script/projectname`
|
`script/projectname`
|
||||||
- `script/cibuild` — CI entrypoint: `docker build .` with a fresh
|
- `script/cibuild` — CI entrypoint: plain `docker build .`
|
||||||
`CHECK_EPOCH` build argument, so the Dockerfile's `make check` layer
|
|
||||||
is never served from the cache and a green build always means the
|
|
||||||
checks ran on this invocation
|
|
||||||
- `script/precommit` — run by the git pre-commit hook; `go mod tidy`
|
- `script/precommit` — run by the git pre-commit hook; `go mod tidy`
|
||||||
guard, then `script/check`
|
guard, then `script/check`
|
||||||
- `script/install-precommit` — install the git pre-commit hook
|
- `script/install-precommit` — install the git pre-commit hook
|
||||||
|
|||||||
17
TODO.md
17
TODO.md
@@ -25,16 +25,13 @@ confirm make check still passes.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
- 2026-08-09: `script/cibuild` can no longer report a green it did not
|
- 2026-08-09: `script/bootstrap` now installs the pinned `golangci-lint`
|
||||||
earn. The Dockerfile declares `ARG CHECK_EPOCH` immediately above the
|
and `goimports` unconditionally instead of only when the binary is
|
||||||
check step and expands it into the `RUN` command, and `script/cibuild`
|
absent from `PATH`, so the commit pins actually take effect on
|
||||||
passes a fresh `$(date +%s%N)` per invocation, so the `make check`
|
already-provisioned machines; it also warns when `PATH` resolves
|
||||||
layer is always re-executed while the pinned toolchain install and
|
either tool to a copy outside the directory `go install` writes to.
|
||||||
`go mod download` stay cached. Verified by experiment: before the fix
|
The `missing` presence check is retained for `git`, `make`, and `go`
|
||||||
a second run on an unchanged tree returned in 283 ms with the check
|
(#117)
|
||||||
layer `CACHED`; after it the check runs every time, and a deliberately
|
|
||||||
planted always-failing test made the build fail with exactly that
|
|
||||||
test's message
|
|
||||||
- 2026-08-07: golangci-lint bumped to v2.12.2 (commit-pinned installs
|
- 2026-08-07: golangci-lint bumped to v2.12.2 (commit-pinned installs
|
||||||
in `Dockerfile` and `script/bootstrap`); `.golangci.yml` set to the
|
in `Dockerfile` and `script/bootstrap`); `.golangci.yml` set to the
|
||||||
org-standard v2-schema config used across the org's repos
|
org-standard v2-schema config used across the org's repos
|
||||||
|
|||||||
@@ -1,10 +1,13 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/bootstrap: install all dependencies needed to build and develop
|
# script/bootstrap: install all dependencies needed to build and develop
|
||||||
# this repo. Idempotent: every install is guarded by a check so already
|
# this repo. Base tooling (git, make, go) comes from nix, apt, brew, or
|
||||||
# installed tools are skipped. Base tooling comes from nix, apt, brew,
|
# apk (detected in that order) and is installed only when absent;
|
||||||
# or apk (detected in that order); assumes nothing is present.
|
# assumes nothing is present. golangci-lint and goimports are always
|
||||||
# golangci-lint and goimports are installed via `go install` at the same
|
# (re)installed via `go install` at the same pinned commits the
|
||||||
# pinned commits the Dockerfile uses (never "latest").
|
# Dockerfile uses (never "latest") -- a presence check cannot tell the
|
||||||
|
# pinned build from an arbitrary one already on PATH, so guarding them
|
||||||
|
# would make the pins inert. Idempotent either way: running this twice
|
||||||
|
# succeeds both times and leaves the same result.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
@@ -62,6 +65,31 @@ missing() {
|
|||||||
! command -v "$1" >/dev/null 2>&1
|
! command -v "$1" >/dev/null 2>&1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# go_bin_dir: directory `go install` writes binaries to.
|
||||||
|
go_bin_dir() {
|
||||||
|
gobin="$(go env GOBIN)"
|
||||||
|
if [ -n "$gobin" ]; then
|
||||||
|
echo "$gobin"
|
||||||
|
else
|
||||||
|
echo "$(go env GOPATH)/bin"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
# warn_if_shadowed <tool> <dir>: the pinned build was just installed
|
||||||
|
# into <dir>. If PATH resolves <tool> anywhere else, that other copy is
|
||||||
|
# what `make lint` and `make fmt` will actually run, and it is not the
|
||||||
|
# pinned version. Warn loudly rather than failing, since the fix is the
|
||||||
|
# user's PATH and not anything this script can do.
|
||||||
|
warn_if_shadowed() {
|
||||||
|
resolved="$(command -v "$1" 2>/dev/null || true)"
|
||||||
|
if [ "$resolved" != "$2/$1" ]; then
|
||||||
|
echo "bootstrap: WARNING: installed pinned $1 to $2/$1, but PATH" >&2
|
||||||
|
echo "bootstrap: WARNING: resolves $1 to ${resolved:-(not on PATH)};" >&2
|
||||||
|
echo "bootstrap: WARNING: put $2 first on PATH or lint results will" >&2
|
||||||
|
echo "bootstrap: WARNING: not match CI." >&2
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
|
|
||||||
@@ -69,10 +97,17 @@ main() {
|
|||||||
if missing make; then pkg_install gnumake make make make; fi
|
if missing make; then pkg_install gnumake make make make; fi
|
||||||
if missing go; then pkg_install go golang go go; fi
|
if missing go; then pkg_install go golang go go; fi
|
||||||
|
|
||||||
# Lint/format tools, pinned via go install (installs into
|
# Lint/format tools, pinned via go install. These are installed
|
||||||
# "$(go env GOPATH)/bin"; ensure that is on your PATH).
|
# unconditionally: `command -v` only proves *some* build is on PATH,
|
||||||
if missing golangci-lint; then go install "$GOLANGCI_LINT_REF"; fi
|
# and a wrong golangci-lint either cannot parse our v2-schema
|
||||||
if missing goimports; then go install "$GOIMPORTS_REF"; fi
|
# .golangci.yml at all or silently disagrees with CI. Installing at
|
||||||
|
# a fixed commit ref is idempotent and cheap with a warm module
|
||||||
|
# cache, so there is nothing to save by skipping it.
|
||||||
|
GOBIN_DIR="$(go_bin_dir)"
|
||||||
|
go install "$GOLANGCI_LINT_REF"
|
||||||
|
go install "$GOIMPORTS_REF"
|
||||||
|
warn_if_shadowed golangci-lint "$GOBIN_DIR"
|
||||||
|
warn_if_shadowed goimports "$GOBIN_DIR"
|
||||||
|
|
||||||
go mod download
|
go mod download
|
||||||
|
|
||||||
|
|||||||
@@ -1,18 +1,13 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/cibuild: run the CI build. The Dockerfile runs make check, and
|
# script/cibuild: run the CI build. The Dockerfile runs make check, so
|
||||||
# the CHECK_EPOCH build argument below is fresh on every invocation, so
|
# a successful build implies all checks pass.
|
||||||
# the check layer is never served from the Docker layer cache: a
|
|
||||||
# successful build means the checks were executed and passed on this
|
|
||||||
# run, not on some earlier one. Only the check step and the steps after
|
|
||||||
# it are invalidated; the toolchain install and go mod download stay
|
|
||||||
# cached.
|
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
docker build --build-arg CHECK_EPOCH="$(date +%s%N)" .
|
docker build .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
Reference in New Issue
Block a user