Compare commits
2
Commits
994c83334a
...
a9c647a13b
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a9c647a13b | ||
|
|
c226ceee01 |
@@ -6,5 +6,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
# actions/checkout v4.2.2, 2026-02-22
|
# actions/checkout v4.2.2, 2026-02-22
|
||||||
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
|
||||||
# script/cibuild builds the image, whose stages run every check.
|
# script/cibuild bootstraps, runs every check and builds the
|
||||||
- run: script/cibuild
|
# image. script/bootstrap links what it installs into
|
||||||
|
# ~/.local/bin, so that has to be on PATH for the rest.
|
||||||
|
- run: PATH="$HOME/.local/bin:$PATH" script/cibuild
|
||||||
|
|||||||
@@ -36,12 +36,12 @@ The Go backend in `backend/` has its own `script/` directory and shim Makefile
|
|||||||
(see [backend/README.md](backend/README.md)). The root scripts cover both
|
(see [backend/README.md](backend/README.md)). The root scripts cover both
|
||||||
halves, so the root `make check` fails if either one is broken. We provide:
|
halves, so the root `make check` fails if either one is broken. We provide:
|
||||||
|
|
||||||
- `script/bootstrap` — install all dependencies (pinned node via nvm if needed,
|
- `script/bootstrap` — install all dependencies (the pinned node via nvm unless
|
||||||
yarn via corepack, `yarn install --frozen-lockfile`, the pinned Go unless one
|
one new enough for the frontend's dependencies is installed, yarn via
|
||||||
at least as new as `backend/go.mod` asks for is installed, and the Go
|
corepack, `yarn install --frozen-lockfile`, the pinned Go unless one at least
|
||||||
modules), linking what it installs itself into `~/.local/bin`, which has to be
|
as new as `backend/go.mod` asks for is installed, and the Go modules), linking
|
||||||
on `PATH`. It installs no Go linter and not Docker: `make lint` runs the
|
what it installs itself into `~/.local/bin`, which has to be on `PATH`. It
|
||||||
linter in Docker
|
installs no Go linter and not Docker: `make lint` runs the linter in Docker
|
||||||
- `script/setup` — make a fresh clone ready for development: bootstrap plus the
|
- `script/setup` — make a fresh clone ready for development: bootstrap plus the
|
||||||
git pre-commit hook
|
git pre-commit hook
|
||||||
- `script/projectname` — print the project name (used for the Docker image tag)
|
- `script/projectname` — print the project name (used for the Docker image tag)
|
||||||
@@ -65,7 +65,8 @@ halves, so the root `make check` fails if either one is broken. We provide:
|
|||||||
`script/check`: it needs Docker and takes minutes.
|
`script/check`: it needs Docker and takes minutes.
|
||||||
- `script/docker` — build the image from `Dockerfile` without the build cache,
|
- `script/docker` — build the image from `Dockerfile` without the build cache,
|
||||||
tagged `netwatch` via `script/projectname`
|
tagged `netwatch` via `script/projectname`
|
||||||
- `script/cibuild` — CI entrypoint: builds the image
|
- `script/cibuild` — CI entrypoint: runs `script/bootstrap` and `script/check`,
|
||||||
|
then builds the image as `script/docker` does, without the build cache
|
||||||
- `script/precommit` — run by the git pre-commit hook; runs `script/check`
|
- `script/precommit` — run by the git pre-commit hook; runs `script/check`
|
||||||
- `script/install-precommit` — install the git pre-commit hook
|
- `script/install-precommit` — install the git pre-commit hook
|
||||||
|
|
||||||
|
|||||||
@@ -23,6 +23,21 @@ latest run passes.
|
|||||||
|
|
||||||
# Completed Steps
|
# Completed Steps
|
||||||
|
|
||||||
|
- 2026-09-29: CI can no longer pass on checks that did not run (issue #37):
|
||||||
|
`script/cibuild` is now the org model, byte for byte. It runs
|
||||||
|
`script/bootstrap` and `script/check`, then builds the image with `--no-cache`
|
||||||
|
and the version from `git describe` as the `VERSION` build argument, where it
|
||||||
|
used to be a plain `docker build .` whose check steps could come from the
|
||||||
|
build cache. The workflow puts `~/.local/bin`, where bootstrap links what it
|
||||||
|
installs, on the step's `PATH`, and bootstrap now installs its pinned node
|
||||||
|
when the installed one is older than the frontend's dependencies need
|
||||||
|
- 2026-09-29: `backend/.golangci.yml` re-vendored from `sneak/prompts` (issue
|
||||||
|
#41): `gomodguard`, deprecated in golangci-lint v2.12.0, is disabled and its
|
||||||
|
successor `gomodguard_v2` enabled with the org block list, so lint runs print
|
||||||
|
no deprecation warning. The new file also turns `depguard` on with its
|
||||||
|
`test-support` rule, which keeps `net/http/httptest` out of non-test code;
|
||||||
|
netwatch adds no entries of its own to that rule. `backend/script/lint` checks
|
||||||
|
the new sha256
|
||||||
- 2026-09-29: nginx sends the security headers `REPO_POLICIES.md` requires on
|
- 2026-09-29: nginx sends the security headers `REPO_POLICIES.md` requires on
|
||||||
every response (issue #18), including errors, `/assets/` and what it passes on
|
every response (issue #18), including errors, `/assets/` and what it passes on
|
||||||
from the backend, whose own copies it drops so each header goes out once. They
|
from the backend, whose own copies it drops so each header goes out once. They
|
||||||
@@ -191,9 +206,3 @@ latest run passes.
|
|||||||
(main always green policy)
|
(main always green policy)
|
||||||
- Decide what to do with untracked resume.sh: commit it, gitignore it, or delete
|
- Decide what to do with untracked resume.sh: commit it, gitignore it, or delete
|
||||||
it
|
it
|
||||||
- Upstream fix needed in `sneak/prompts`: the org-standard `.golangci.yml`
|
|
||||||
enables `gomodguard`, which golangci-lint v2.12.2 reports as deprecated since
|
|
||||||
v2.12.0 and replaced by `gomodguard_v2`, so every backend lint run prints a
|
|
||||||
deprecation warning. The file is standardized and must never be edited in this
|
|
||||||
repo, so nothing can be done here beyond tracking it — tracked at
|
|
||||||
<https://git.eeqj.de/sneak/netwatch/issues/41>
|
|
||||||
|
|||||||
+66
-2
@@ -10,14 +10,20 @@ run:
|
|||||||
|
|
||||||
linters:
|
linters:
|
||||||
default: all
|
default: all
|
||||||
|
enable:
|
||||||
|
# Successor to the deprecated gomodguard. Named explicitly, rather than
|
||||||
|
# left to `default: all`, because it carries the module policy below.
|
||||||
|
- gomodguard_v2
|
||||||
disable:
|
disable:
|
||||||
# Genuinely incompatible with project patterns
|
# Genuinely incompatible with project patterns
|
||||||
- exhaustruct # Requires all struct fields
|
- exhaustruct # Requires all struct fields
|
||||||
- depguard # Dependency allow/block lists
|
|
||||||
- godot # Requires comments to end with periods
|
- godot # Requires comments to end with periods
|
||||||
- wsl # Deprecated, replaced by wsl_v5
|
|
||||||
- wrapcheck # Too verbose for internal packages
|
- wrapcheck # Too verbose for internal packages
|
||||||
- varnamelen # Short names like db, id are idiomatic Go
|
- varnamelen # Short names like db, id are idiomatic Go
|
||||||
|
# Deprecated: the warning is attached to the old name, so it is
|
||||||
|
# silenced by disabling that name, not by enabling the successor.
|
||||||
|
- wsl # Deprecated, replaced by wsl_v5
|
||||||
|
- gomodguard # Deprecated, replaced by gomodguard_v2
|
||||||
settings:
|
settings:
|
||||||
lll:
|
lll:
|
||||||
line-length: 88
|
line-length: 88
|
||||||
@@ -28,6 +34,64 @@ linters:
|
|||||||
max-complexity: 15
|
max-complexity: 15
|
||||||
dupl:
|
dupl:
|
||||||
threshold: 100
|
threshold: 100
|
||||||
|
depguard:
|
||||||
|
# Test-support code must not be compiled into the shipped binary. A
|
||||||
|
# test-support package exists to hand a test privileges the program
|
||||||
|
# itself must never have, so a file that is not a test must not import
|
||||||
|
# one. Test files, and the files inside a package whose directory name
|
||||||
|
# ends in `test`, are where that code belongs, and are exempt.
|
||||||
|
#
|
||||||
|
# The deny list below is the one part of this file a repository is
|
||||||
|
# expected to extend, and the only part it may. depguard matches an
|
||||||
|
# import path against a list of prefixes, so it cannot be told "any path
|
||||||
|
# whose last segment ends in test"; a repository's own test-support
|
||||||
|
# packages have to be named here one at a time, by full import path,
|
||||||
|
# under a module path that differs from repository to repository. Add
|
||||||
|
# them; change nothing else.
|
||||||
|
rules:
|
||||||
|
test-support:
|
||||||
|
list-mode: lax
|
||||||
|
files:
|
||||||
|
- "$all"
|
||||||
|
- "!$test"
|
||||||
|
- "!**/*test/**"
|
||||||
|
deny:
|
||||||
|
- pkg: net/http/httptest
|
||||||
|
desc: >-
|
||||||
|
Test-support code belongs in test files and in packages whose
|
||||||
|
directory name ends in test, not in the shipped binary.
|
||||||
|
# Only decisions already recorded in the Go package defaults are
|
||||||
|
# listed here. Every entry matches the module path exactly.
|
||||||
|
gomodguard_v2:
|
||||||
|
blocked:
|
||||||
|
- module: github.com/rs/zerolog
|
||||||
|
recommendations:
|
||||||
|
- log/slog
|
||||||
|
reason: "Structured logging is stdlib log/slog."
|
||||||
|
# One entry per pre-fork module path, because the later releases
|
||||||
|
# are separate paths. A prefix match would be shorter but would
|
||||||
|
# also reach github.com/go-redis/redismock, the test double for
|
||||||
|
# the successor these entries recommend.
|
||||||
|
- module: github.com/go-redis/redis
|
||||||
|
recommendations:
|
||||||
|
- github.com/redis/go-redis/v9
|
||||||
|
reason: "Pre-fork module; use the maintained go-redis v9."
|
||||||
|
- module: github.com/go-redis/redis/v7
|
||||||
|
recommendations:
|
||||||
|
- github.com/redis/go-redis/v9
|
||||||
|
reason: "Pre-fork module; use the maintained go-redis v9."
|
||||||
|
- module: github.com/go-redis/redis/v8
|
||||||
|
recommendations:
|
||||||
|
- github.com/redis/go-redis/v9
|
||||||
|
reason: "Pre-fork module; use the maintained go-redis v9."
|
||||||
|
- module: github.com/sergi/go-diff
|
||||||
|
recommendations:
|
||||||
|
- github.com/aymanbagabas/go-udiff
|
||||||
|
reason: "No unified diff output; use go-udiff."
|
||||||
|
- module: github.com/hexops/gotextdiff
|
||||||
|
recommendations:
|
||||||
|
- github.com/aymanbagabas/go-udiff
|
||||||
|
reason: "Unmaintained fork; use go-udiff."
|
||||||
|
|
||||||
issues:
|
issues:
|
||||||
max-issues-per-linter: 0
|
max-issues-per-linter: 0
|
||||||
|
|||||||
+1
-1
@@ -14,7 +14,7 @@ set -eu
|
|||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
||||||
|
|
||||||
GOLANGCI_CONFIG_SHA256="021cc83f4e6fc7c31b95b34b846723dfcf20b66b7baeea1dc40406e643346bcb"
|
GOLANGCI_CONFIG_SHA256="a79b63a254602a5318db5d0e9a06bc71b84bf0c1d896305229d8bfed1d1b1776"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
|
|||||||
+25
-7
@@ -3,12 +3,12 @@
|
|||||||
# this repo. Idempotent: every install is guarded by a check so already
|
# this repo. Idempotent: every install is guarded by a check so already
|
||||||
# installed tools are skipped. Base tooling comes from nix, apt, brew,
|
# installed tools are skipped. Base tooling comes from nix, apt, brew,
|
||||||
# or apk (detected in that order); assumes nothing is present. Node is
|
# or apk (detected in that order); assumes nothing is present. Node is
|
||||||
# used directly if installed; otherwise it is installed at a pinned
|
# used directly if it is at least NODE_MIN_VERSION; otherwise it is
|
||||||
# version via nvm (installing nvm itself first, from a hash-verified
|
# installed at a pinned version via nvm (installing nvm itself first,
|
||||||
# release archive, never curl | sh). Go, with its gofmt, is used
|
# from a hash-verified release archive, never curl | sh). Go, with its
|
||||||
# directly if it is at least the version backend/go.mod asks for;
|
# gofmt, is used directly if it is at least the version backend/go.mod
|
||||||
# otherwise the pinned Go release is installed from its hash-verified
|
# asks for; otherwise the pinned Go release is installed from its
|
||||||
# archive.
|
# hash-verified archive.
|
||||||
#
|
#
|
||||||
# What this script installs outside the system package manager lives
|
# What this script installs outside the system package manager lives
|
||||||
# under $HOME and is linked into ~/.local/bin, where make and the git
|
# under $HOME and is linked into ~/.local/bin, where make and the git
|
||||||
@@ -23,6 +23,10 @@ ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
|||||||
|
|
||||||
# Pinned versions, 2026-07-07
|
# Pinned versions, 2026-07-07
|
||||||
NODE_VERSION="22.17.0"
|
NODE_VERSION="22.17.0"
|
||||||
|
# The oldest node the frontend's dependencies accept: the "engines"
|
||||||
|
# field of puppeteer-core 25.5.0, the most demanding of them, asks for
|
||||||
|
# 22.12.0 or newer, 2026-09-29. An older installed node is not used.
|
||||||
|
NODE_MIN_VERSION="22.12.0"
|
||||||
NVM_VERSION="0.40.3"
|
NVM_VERSION="0.40.3"
|
||||||
# sha256 of https://github.com/nvm-sh/nvm/archive/refs/tags/v0.40.3.tar.gz
|
# sha256 of https://github.com/nvm-sh/nvm/archive/refs/tags/v0.40.3.tar.gz
|
||||||
NVM_SHA256="5f4d6aaa04a177dc93c985e31dbc411ab6b8c6e1e21d8015dbc1372625fcd1d0"
|
NVM_SHA256="5f4d6aaa04a177dc93c985e31dbc411ab6b8c6e1e21d8015dbc1372625fcd1d0"
|
||||||
@@ -136,8 +140,22 @@ ensure_nvm() {
|
|||||||
rm -rf "$tmp"
|
rm -rf "$tmp"
|
||||||
}
|
}
|
||||||
|
|
||||||
|
# node_ok: the node on PATH is at least NODE_MIN_VERSION. node itself
|
||||||
|
# compares the two: major, then minor, then patch.
|
||||||
|
node_ok() {
|
||||||
|
if missing node; then return 1; fi
|
||||||
|
node -e '
|
||||||
|
const have = process.versions.node.split(".").map(Number);
|
||||||
|
const want = process.argv[1].split(".").map(Number);
|
||||||
|
for (let i = 0; i < 3; i++) {
|
||||||
|
if (have[i] !== want[i]) process.exit(have[i] > want[i] ? 0 : 1);
|
||||||
|
}
|
||||||
|
' "$NODE_MIN_VERSION"
|
||||||
|
}
|
||||||
|
|
||||||
|
# ensure_node: unless node_ok, install NODE_VERSION and link its node.
|
||||||
ensure_node() {
|
ensure_node() {
|
||||||
if ! missing node; then return 0; fi
|
if node_ok; then return 0; fi
|
||||||
ensure_nvm
|
ensure_nvm
|
||||||
nvm_sh "nvm install $NODE_VERSION"
|
nvm_sh "nvm install $NODE_VERSION"
|
||||||
link_bin "$HOME/.nvm/versions/node/v$NODE_VERSION/bin/node" node
|
link_bin "$HOME/.nvm/versions/node/v$NODE_VERSION/bin/node" node
|
||||||
|
|||||||
+20
-6
@@ -1,15 +1,29 @@
|
|||||||
#!/bin/sh
|
#!/bin/sh
|
||||||
# script/cibuild: run the CI build: build the one image from Dockerfile,
|
# script/cibuild: run the CI build. It bootstraps first: a CI runner
|
||||||
# whose stages run the checks as build steps (the backend's fmt-check,
|
# checks out and runs this and nothing else, and script/fmt-check runs
|
||||||
# lint and tests, and the frontend's test, lint and fmt-check). This is
|
# the formatter on the host, which a pristine checkout cannot do.
|
||||||
# the only build step the Gitea workflow runs.
|
# --no-cache for the same reason as script/docker: the gate phases the
|
||||||
|
# final stage depends on are RUN steps, and a cached one is a check that
|
||||||
|
# did not run.
|
||||||
set -eu
|
set -eu
|
||||||
|
|
||||||
ROOT="$(cd "$(dirname "$0")/.." && pwd -P)"
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd -P)"
|
||||||
|
ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)"
|
||||||
|
|
||||||
main() {
|
main() {
|
||||||
cd "$ROOT"
|
cd "$ROOT"
|
||||||
timeout 300 docker build .
|
"$SCRIPT_DIR/bootstrap"
|
||||||
|
"$SCRIPT_DIR/check"
|
||||||
|
# Own line: a failing command substitution inside an argument does
|
||||||
|
# not trip `set -e`, so the inline form degrades silently to an
|
||||||
|
# empty constant. VERSION is computed here because .dockerignore
|
||||||
|
# excludes .git, so `git describe` in a build stage yields an empty
|
||||||
|
# version without failing.
|
||||||
|
version="$(git describe --tags --always --dirty 2>/dev/null || true)"
|
||||||
|
[ -n "$version" ] || version="unknown"
|
||||||
|
docker build --no-cache \
|
||||||
|
--build-arg VERSION="$version" \
|
||||||
|
-t "$("$SCRIPT_DIR/projectname")" .
|
||||||
}
|
}
|
||||||
|
|
||||||
main "$@"
|
main "$@"
|
||||||
|
|||||||
Reference in New Issue
Block a user