From b7c65033f9b779085cbf5d75146022e6935c74ff Mon Sep 17 00:00:00 2001 From: Titus Date: Sun, 22 Nov 2026 03:57:14 +0100 Subject: [PATCH] README and AGENTS.md true to CI: what verify reads, what a pull request runs, who merges README called `npm run verify` offline; several of its checks read onlyworlds.com and say CANNOT SEE when it cannot. It now also says which three workflows a pull request runs and which two checks main requires. AGENTS.md gains the sentence its sibling repositories have: a maintainer merges, never the builder. Co-Authored-By: Claude Opus 5.5 --- AGENTS.md | 2 +- README.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 3afb6648..faa2e298 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -34,7 +34,7 @@ Exit codes across `scripts/`: 0 pass, 1 a finding (FAIL or STALE), 2 BLIND or CA ## How a change reaches main -Make a branch, open a pull request, and wait for the required checks to go green. `main` refuses a direct push; the rule has no bypass. Never push to `main`. Never create or push a tag: the deploy tags itself, and a tag is how a rollback is run. Never edit a file under `.github/workflows/`. Never change a version number, a dependency pin in `package.json`, the dated headings of `src/content/docs/docs/changelog.md`, or the version and changelog lines at the end of `public/assets/ow_llm_guide.txt`, unless the job says so. +Make a branch, open a pull request, and wait for the required checks to go green. `main` refuses a direct push; the rule has no bypass. Never push to `main`. A maintainer merges; you never merge your own pull request. Never create or push a tag: the deploy tags itself, and a tag is how a rollback is run. Never edit a file under `.github/workflows/`. Never change a version number, a dependency pin in `package.json`, the dated headings of `src/content/docs/docs/changelog.md`, or the version and changelog lines at the end of `public/assets/ow_llm_guide.txt`, unless the job says so. ## What must not be hand-edited diff --git a/README.md b/README.md index b5ecc9c9..d8d69e13 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ The Jekyll site this replaced is kept whole on the `jekyll` branch and the `jeky ```bash npm ci npm run build # gen_sdk_ref, gen_errors, astro build, then scripts/postbuild.mjs -npm run verify # the checks package.json lists (figures, workflows, URLs, words, the snapshots, the LLM guide, the TypeScript examples compiled against the pinned SDK; the Python examples are type-checked against PyPI's newest onlyworlds at each deploy, report only, by scripts/verify-examples-py.py), offline, on dist/ and the sources +npm run verify # the checks package.json lists (figures, workflows, URLs, words, the snapshots, the LLM guide, the TypeScript examples compiled against the pinned SDK; the Python examples are type-checked against PyPI's newest onlyworlds at each deploy, report only, by scripts/verify-examples-py.py), on dist/ and the sources; several also read onlyworlds.com (the API document, the demo world) and say CANNOT SEE when it is unreachable node scripts/serve.mjs # dist/ on http://localhost:4321/, resolved the way GitHub Pages resolves it ``` @@ -19,6 +19,8 @@ Pages are Markdown in `src/content/docs/`, at the URL they are served from. The Run `npm run verify` before you push: a workflow file that doesn't parse never runs, and GitHub shows no failed check, only none. +**On a pull request** CI runs three workflows: `ci.yml` (`build`: the build, then `npm run verify`), `generated.yml` (`check`: `node scripts/gen_sdk_ref.mjs --check` and `node scripts/gen_errors.mjs --check`, the TypeScript reference against the pinned SDK and the errors page against `contract/error-codes.json`) and `commits.yml` (`commits`: the words of each commit message). `main` takes a commit only when `build` and `check` passed on it. + ## Keeping it true Docs follow what ships, the same hour, and a weekly sweep catches the rest: `node scripts/sweep.mjs`, then the reading list and the terms in [SWEEP.md](SWEEP.md).