diff --git a/.gitea/workflows/check.yml b/.gitea/workflows/check.yml index aca7a51..ee73864 100644 --- a/.gitea/workflows/check.yml +++ b/.gitea/workflows/check.yml @@ -6,4 +6,4 @@ jobs: steps: # actions/checkout v4.2.2, 2026-02-22 - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 - - run: docker build . + - run: script/cibuild diff --git a/Makefile b/Makefile index 62ec399..063870b 100644 --- a/Makefile +++ b/Makefile @@ -1,31 +1,26 @@ .PHONY: test lint fmt fmt-check check docker hooks -# flags are repeated here (also in .prettierrc) so this Makefile works -# standalone when copied as a template -PRETTIER := yarn run prettier +# Makefile targets are thin shims; the implementations live in script/ +# per the scripts-to-rule-them-all pattern (see the Entrypoints section +# of README.md). test: - @echo "No tests defined." + @script/test lint: - @echo "Linting markdown files..." - @$(PRETTIER) --check '**/*.md' --tab-width 4 --prose-wrap always + @script/lint fmt: - @$(PRETTIER) --write '**/*.md' --tab-width 4 --prose-wrap always + @script/fmt fmt-check: - @$(PRETTIER) --check '**/*.md' --tab-width 4 --prose-wrap always + @script/fmt-check -check: test lint fmt-check +check: + @script/check docker: - docker build -t prompts . + @script/docker hooks: - @printf '#!/bin/sh\nset -e\n' > .git/hooks/pre-commit - @if [ -f go.mod ]; then \ - printf 'go mod tidy\ngo fmt ./...\ngit diff --exit-code -- go.mod go.sum || { echo "go mod tidy changed files; please stage and retry"; exit 1; }\n' >> .git/hooks/pre-commit; \ - fi - @printf 'make check\n' >> .git/hooks/pre-commit - @chmod +x .git/hooks/pre-commit + @script/install-precommit diff --git a/README.md b/README.md index 555f01a..45a9535 100644 --- a/README.md +++ b/README.md @@ -102,6 +102,33 @@ cd prompts Prompts are stored as Markdown files in `prompts/`. Copy or reference them as needed in your projects. +## Entrypoints + +This repository adheres to the +[Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all) +standard: normalized scripts in `script/` are the entrypoints for the +development workflow, and the Makefile targets are thin shims that call them. We +provide: + +- `script/projectname` — output the project name (our own extension); used by + `script/docker` for the image tag +- `script/test` — run the test suite (no tests defined here) +- `script/lint` — lint the markdown files with prettier +- `script/fmt` — format all markdown files with prettier (writes) +- `script/fmt-check` — check formatting (read-only) +- `script/check` — run all checks: `test`, `lint`, `fmt-check` (our own + extension) +- `script/docker` — build the Docker image, tagged via `script/projectname` + (byte-identical across repos) +- `script/cibuild` — cd to the repo root and `docker build .` (what CI runs; the + image build runs `script/check`) +- `script/precommit` — run by the git pre-commit hook (our own extension); calls + `script/check` +- `script/install-precommit` — installs the git pre-commit hook (our own + extension); `make hooks` shims to it + +`make hooks` installs the pre-commit hook that runs `script/precommit`. + ## Rationale LLM prompts, especially development policies, benefit from version control and a diff --git a/prompts/EXISTING_REPO_CHECKLIST.md b/prompts/EXISTING_REPO_CHECKLIST.md index b4ae7f0..2f45550 100644 --- a/prompts/EXISTING_REPO_CHECKLIST.md +++ b/prompts/EXISTING_REPO_CHECKLIST.md @@ -1,6 +1,6 @@ --- title: Existing Repo Checklist -last_modified: 2026-03-10 +last_modified: 2026-07-06 --- Use this checklist when beginning work in a repo that may not yet conform to our @@ -45,12 +45,19 @@ with your task. - [ ] Python: `pyproject.toml` - [ ] Docs/writing: `.prettierrc`, `.prettierignore` (same URLs as above) -# Makefile +# Makefile and script/ Entrypoints - [ ] `Makefile` exists in root — reference `https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile` - [ ] Has targets: `test`, `lint`, `fmt`, `fmt-check`, `check`, `docker`, `hooks` +- [ ] Target implementations live in `script/` (scripts-to-rule-them-all); + Makefile targets are thin shims calling them — model scripts at + `https://git.eeqj.de/sneak/prompts/raw/branch/main/script/` +- [ ] `script/precommit` exists and the pre-commit hook (installed by + `script/install-precommit`, shimmed by `make hooks`) runs it +- [ ] README has an **Entrypoints** section documenting the `script/` + entrypoints and linking the standard - [ ] `make check` does not modify any files in the repo - [ ] `make test` has a 30-second timeout - [ ] `make test` runs real tests, not a no-op (at minimum, import/compile diff --git a/prompts/NEW_REPO_CHECKLIST.md b/prompts/NEW_REPO_CHECKLIST.md index 62334e8..34e4577 100644 --- a/prompts/NEW_REPO_CHECKLIST.md +++ b/prompts/NEW_REPO_CHECKLIST.md @@ -1,6 +1,6 @@ --- title: New Repo Checklist -last_modified: 2026-02-22 +last_modified: 2026-07-06 --- Use this checklist when creating a new repository from scratch. Follow the steps @@ -57,7 +57,7 @@ Template files can be fetched from: - Non-server: brings up dev environment and runs `make check` - Image pinned by sha256 hash with version/date comment - [ ] Gitea Actions workflow at `.gitea/workflows/check.yml` that runs - `docker build .` on push — reference + `script/cibuild` on push — reference `https://git.eeqj.de/sneak/prompts/raw/branch/main/.gitea/workflows/check.yml` - [ ] Language-specific: - [ ] Go: `go mod init sneak.berlin/go/`, `.golangci.yml` (fetch from @@ -65,15 +65,30 @@ Template files can be fetched from: - [ ] JS: `yarn init`, `yarn add --dev prettier` - [ ] Python: `pyproject.toml` -## Configure Makefile +## Configure script/ Entrypoints and Makefile -- [ ] `make test` — runs real tests, not a no-op (30-second timeout) -- [ ] `make lint` — runs linter -- [ ] `make fmt` — formats code (writes) -- [ ] `make fmt-check` — checks formatting (read-only) -- [ ] `make check` — prereqs: `test`, `lint`, `fmt-check`; must not modify files -- [ ] `make docker` — builds Docker image -- [ ] `make hooks` — installs pre-commit hook +Implementations live in `script/` (scripts-to-rule-them-all); Makefile targets +are thin shims calling them. Model scripts: +`https://git.eeqj.de/sneak/prompts/raw/branch/main/script/` + +- [ ] `script/test` / `make test` — runs real tests, not a no-op (30-second + timeout) +- [ ] `script/lint` / `make lint` — runs linter +- [ ] `script/fmt` / `make fmt` — formats code (writes) +- [ ] `script/fmt-check` / `make fmt-check` — checks formatting (read-only) +- [ ] `script/check` / `make check` — runs `test`, `lint`, `fmt-check`; must not + modify files +- [ ] `script/projectname` — outputs the project name (used by `script/docker` + for the image tag) +- [ ] `script/docker` / `make docker` — builds Docker image, tagged via + `script/projectname` (byte-identical across repos) +- [ ] `script/cibuild` — cd to repo root, `docker build .` (what CI runs) +- [ ] `script/precommit` — called by the pre-commit hook; runs `script/check` +- [ ] `script/install-precommit` — installs the pre-commit hook that runs + `script/precommit` +- [ ] `make hooks` — shims to `script/install-precommit` +- [ ] README **Entrypoints** section documents the scripts and links the + standard # 4. Verify diff --git a/prompts/REPO_POLICIES.md b/prompts/REPO_POLICIES.md index e644449..58c3753 100644 --- a/prompts/REPO_POLICIES.md +++ b/prompts/REPO_POLICIES.md @@ -1,6 +1,6 @@ --- title: Repository Policies -last_modified: 2026-03-18 +last_modified: 2026-07-06 --- This document covers repository structure, tooling, and workflow standards. Code @@ -35,10 +35,32 @@ style conventions are in separate documents: - Every repo with software must have a root `Makefile` with these targets: `make test`, `make lint`, `make fmt` (writes), `make fmt-check` (read-only), - `make check` (prereqs: `test`, `lint`, `fmt-check`), `make docker`, and + `make check` (runs `test`, `lint`, `fmt-check`), `make docker`, and `make hooks` (installs pre-commit hook). A model Makefile is at `https://git.eeqj.de/sneak/prompts/raw/branch/main/Makefile`. +- Repos follow the + [Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all) + pattern: the implementation of each Makefile target lives in an executable + script in `script/` (`script/test`, `script/lint`, `script/fmt`, + `script/fmt-check`, `script/check`, `script/docker`), and the Makefile targets + are thin shims that call them. `script/cibuild` (a standard + scripts-to-rule-them-all name) runs the CI build: it changes to the repo root + and runs `docker build .`; the Gitea workflow calls it. Four further scripts + are our own extensions to the standard: `script/check` runs `script/test`, + `script/lint`, and `script/fmt-check`; `script/precommit` is what the git + pre-commit hook runs, and it calls `script/check`; `script/install-precommit` + installs the git pre-commit hook (the `make hooks` target shims to it); and + `script/projectname` (literally that filename) simply outputs the project's + name. Scripts that need the name call `script/projectname` — e.g. + `script/docker` assembles its image tag from it — so those scripts stay + byte-identical across all repos. Repo-type-specific pre-commit extras (e.g. + `go mod tidy` verification in Go repos) belong in `script/precommit`, not in + the hook itself. Model scripts are at + `https://git.eeqj.de/sneak/prompts/raw/branch/main/script/`. The README + must document the provided scripts in an **Entrypoints** section (see the + README requirements below). + - Always use Makefile targets (`make fmt`, `make test`, `make lint`, etc.) instead of invoking the underlying tools directly. The Makefile is the single source of truth for how these operations are run. @@ -127,8 +149,9 @@ style conventions are in separate documents: artifacts or heavier dependencies. - Every repo should have a Gitea Actions workflow (`.gitea/workflows/`) that - runs `docker build .` on push. Since the Dockerfile already runs `make check`, - a successful build implies all checks pass. + runs `script/cibuild` (which runs `docker build .`) on push. Since the + Dockerfile already runs `make check`, a successful build implies all checks + pass. - Use platform-standard formatters: `black` for Python, `prettier` for JS/CSS/Markdown/HTML, `go fmt` for Go. Always use default configuration with @@ -136,9 +159,11 @@ style conventions are in separate documents: Markdown (hard-wrap at 80 columns). Documentation and writing repos (Markdown, HTML, CSS) should also have `.prettierrc` and `.prettierignore`. -- Pre-commit hook: `make check` if local testing is possible, otherwise - `make lint && make fmt-check`. The Makefile should provide a `make hooks` - target to install the pre-commit hook. +- Pre-commit hook: runs `script/precommit`, which calls `script/check`. If local + testing is not possible in the repo, `script/precommit` may skip `script/test` + and run only `script/lint` and `script/fmt-check`. The hook is installed by + `script/install-precommit`; the Makefile must provide a `make hooks` target + that shims to it. - All repos with software must have tests that run via the platform-standard test framework (`go test`, `pytest`, `jest`/`vitest`, etc.). If no meaningful @@ -297,6 +322,10 @@ style conventions are in separate documents: "µPaaS is an MIT-licensed Go web application by @sneak that receives git-frontend webhooks and deploys applications via Docker in realtime." - **Getting Started**: Copy-pasteable install/usage code block. + - **Entrypoints**: Opens by stating that the repo adheres to the + [Scripts to Rule Them All](https://github.com/github/scripts-to-rule-them-all) + standard (with that link), then documents each provided `script/` + entrypoint and its purpose. - **Rationale**: Why does this exist? - **Design**: How is the program structured? - **TODO**: Update meticulously, even between commits. When planning, put @@ -351,6 +380,8 @@ style conventions are in separate documents: - `README.md`, `.git`, `.gitignore`, `.editorconfig` - `LICENSE`, `REPO_POLICIES.md` (copy from the `prompts` repo) - `Makefile` + - `script/` entrypoints (`projectname`, `test`, `lint`, `fmt`, `fmt-check`, + `check`, `docker`, `cibuild`, `precommit`, `install-precommit`) - `Dockerfile`, `.dockerignore` - `.gitea/workflows/check.yml` - Go: `go.mod`, `go.sum`, `.golangci.yml` diff --git a/script/check b/script/check new file mode 100755 index 0000000..26ca4bc --- /dev/null +++ b/script/check @@ -0,0 +1,14 @@ +#!/usr/bin/env bash +# script/check: run all checks (test, lint, fmt-check). Our own +# extension to scripts-to-rule-them-all. Must not modify any files. +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)" + +main() { + "$SCRIPT_DIR/test" + "$SCRIPT_DIR/lint" + "$SCRIPT_DIR/fmt-check" +} + +main "$@" diff --git a/script/cibuild b/script/cibuild new file mode 100755 index 0000000..56c96d1 --- /dev/null +++ b/script/cibuild @@ -0,0 +1,13 @@ +#!/usr/bin/env bash +# script/cibuild: run the CI build. The Dockerfile runs script/check, so +# a successful build implies all checks pass. +set -euo pipefail + +ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)" + +main() { + cd "$ROOT" + docker build . +} + +main "$@" diff --git a/script/docker b/script/docker new file mode 100755 index 0000000..59f26aa --- /dev/null +++ b/script/docker @@ -0,0 +1,14 @@ +#!/usr/bin/env bash +# script/docker: build the Docker image tagged with the project name. +# Identical in all repos; the tag comes from script/projectname. +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)" +ROOT="$(cd "$SCRIPT_DIR/.." && pwd -P)" + +main() { + cd "$ROOT" + docker build -t "$("$SCRIPT_DIR/projectname")" . +} + +main "$@" diff --git a/script/fmt b/script/fmt new file mode 100755 index 0000000..999e47b --- /dev/null +++ b/script/fmt @@ -0,0 +1,12 @@ +#!/usr/bin/env bash +# script/fmt: format all files (writes). +set -euo pipefail + +ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)" + +main() { + cd "$ROOT" + yarn run prettier --write '**/*.md' --tab-width 4 --prose-wrap always +} + +main "$@" diff --git a/script/fmt-check b/script/fmt-check new file mode 100755 index 0000000..b9bce49 --- /dev/null +++ b/script/fmt-check @@ -0,0 +1,12 @@ +#!/usr/bin/env bash +# script/fmt-check: check formatting (read-only). +set -euo pipefail + +ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)" + +main() { + cd "$ROOT" + yarn run prettier --check '**/*.md' --tab-width 4 --prose-wrap always +} + +main "$@" diff --git a/script/install-precommit b/script/install-precommit new file mode 100755 index 0000000..9eb0c0d --- /dev/null +++ b/script/install-precommit @@ -0,0 +1,16 @@ +#!/usr/bin/env bash +# script/install-precommit: install the git pre-commit hook that runs +# script/precommit. Our own extension to scripts-to-rule-them-all. +set -euo pipefail + +ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)" + +main() { + cd "$ROOT" + local hook=".git/hooks/pre-commit" + printf '#!/bin/sh\nset -e\nscript/precommit\n' > "$hook" + chmod +x "$hook" + echo "pre-commit hook installed: runs script/precommit" +} + +main "$@" diff --git a/script/lint b/script/lint new file mode 100755 index 0000000..4f4f080 --- /dev/null +++ b/script/lint @@ -0,0 +1,13 @@ +#!/usr/bin/env bash +# script/lint: run the linter. +set -euo pipefail + +ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)" + +main() { + cd "$ROOT" + echo "Linting markdown files..." + yarn run prettier --check '**/*.md' --tab-width 4 --prose-wrap always +} + +main "$@" diff --git a/script/precommit b/script/precommit new file mode 100755 index 0000000..0096fc5 --- /dev/null +++ b/script/precommit @@ -0,0 +1,12 @@ +#!/usr/bin/env bash +# script/precommit: run by the git pre-commit hook; fails the commit if +# checks fail. Our own extension to scripts-to-rule-them-all. +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)" + +main() { + "$SCRIPT_DIR/check" +} + +main "$@" diff --git a/script/projectname b/script/projectname new file mode 100755 index 0000000..90516e0 --- /dev/null +++ b/script/projectname @@ -0,0 +1,12 @@ +#!/usr/bin/env bash +# script/projectname: output the name of this project. Our own +# extension to scripts-to-rule-them-all. Other scripts that need the +# name (e.g. script/docker) call this, so they can stay identical +# across all repos. +set -euo pipefail + +main() { + echo "prompts" +} + +main "$@" diff --git a/script/test b/script/test new file mode 100755 index 0000000..9a2a41c --- /dev/null +++ b/script/test @@ -0,0 +1,12 @@ +#!/usr/bin/env bash +# script/test: run the test suite. +set -euo pipefail + +ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)" + +main() { + cd "$ROOT" + echo "No tests defined." +} + +main "$@"