From 83bde8620746d97b5b0149f6bc54d33bbe5847c0 Mon Sep 17 00:00:00 2001 From: Altay Date: Sun, 25 Oct 2026 16:58:05 +0300 Subject: [PATCH] docs: drop distribution doc; keep release rules in AGENTS.md --- AGENTS.md | 17 ++++++++++++---- CONTRIBUTING.md | 2 -- README.md | 1 - docs/distribution.md | 47 -------------------------------------------- 4 files changed, 13 insertions(+), 54 deletions(-) delete mode 100644 docs/distribution.md diff --git a/AGENTS.md b/AGENTS.md index 76b2acc..90fd248 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -65,8 +65,6 @@ touches, and search `node_modules/effect/src` for anything it does not cover. - Command, env, or output: update [README.md](README.md), CLI tests, and [skills/rokit/](skills/rokit/SKILL.md) agent guardrails. -- CI, release, or publishing: update [docs/distribution.md](docs/distribution.md) - in the same change. ## Checks @@ -102,5 +100,16 @@ Which proof a change needs: ## Delivery -Open a pull request. Release credentials and smoke checks: -[docs/distribution.md](docs/distribution.md). +Open a pull request. Release rules no file enforces: + +- npm Trusted Publishing for `@putdotio/rokit` must trust owner `putdotio`, repository `rokit`, + workflow [`ci.yml`](https://github.com/putdotio/rokit/blob/main/.github/workflows/ci.yml), and Environment `release`. + Renaming any of them breaks publishing until the npm setting matches. +- Keep `effect`, `@effect/platform-node`, and `@effect/platform-node-shared` in + [`package.json`](package.json) on one exact version. A newer shared runtime + can break the pinned Effect. +- The build bundles `jpeg-js` with the patch in [`patches/`](https://github.com/putdotio/rokit/blob/main/patches), + because npm consumers do not inherit pnpm patches. Drop it only when a pinned + upstream release passes the partial-interval and early-end-marker + regressions and installed-package proof. Keep + [docs/third-party-notices.md](docs/third-party-notices.md) in step. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4a18282..6e02b3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,5 +40,3 @@ file. The CLI reads `.rokit/.env`; `live:probe` also reads `.env` and - Keep changes focused. - Add or update tests when command behavior, parsing, output, or public exports change. - Keep app-specific journeys out of `rokit`; they belong in the consuming app repo. - -Release and publishing: [Distribution](./docs/distribution.md). diff --git a/README.md b/README.md index 9ac7b6a..00c3801 100644 --- a/README.md +++ b/README.md @@ -111,7 +111,6 @@ content, app-specific UI nodes, and review artifacts. - [Contributing](./CONTRIBUTING.md) - [Agent guide](./AGENTS.md) -- [Distribution](./docs/distribution.md) - [rokit skill](./skills/rokit/SKILL.md) - [Roku debugging](./skills/rokit/references/debugging.md) - [Security](https://github.com/putdotio/.github/blob/main/SECURITY.md) diff --git a/docs/distribution.md b/docs/distribution.md deleted file mode 100644 index 774c362..0000000 --- a/docs/distribution.md +++ /dev/null @@ -1,47 +0,0 @@ -# Distribution - -`rokit` ships to npm as `@putdotio/rokit`, plus a GitHub Release per version. - -## Release - -On `main`, after `verify` passes, the release job in -[`ci.yml`](https://github.com/putdotio/rokit/blob/main/.github/workflows/ci.yml) -runs the shared -[frontend release workflow](https://github.com/putdotio/.github) with the plugins in -[`.releaserc.json`](https://github.com/putdotio/rokit/blob/main/.releaserc.json). -The Conventional Commit type decides whether a merge publishes. - -## Release Credentials - -The release job runs in the `release` GitHub Environment and needs: - -- `PUTIO_CI_APP_CLIENT_ID`: repository or Environment variable -- `PUTIO_CI_APP_PRIVATE_KEY`: Environment secret - -npm publishes through Trusted Publishing with provenance. On npm, the package -trusts owner `putdotio`, repository `rokit`, workflow `ci.yml`, and Environment -`release`. - -## Package Contents - -`files` in [`package.json`](../package.json) lists what ships: the docs, -consumer skill, and generic live probe, so consumers can read them without -cloning. Packaged docs link files outside the tarball by absolute GitHub URL. - -Keep `effect`, `@effect/platform-node`, and `@effect/platform-node-shared` on -the same exact version. platform-node accepts any compatible shared runtime, -and a newer one can break the pinned Effect. - -The build bundles `jpeg-js` with the patch under `patches/`, because npm -consumers do not inherit pnpm patches. Remove the patch only when a pinned -upstream release passes the partial-interval and early-end-marker regressions -and installed-package proof. Notices: [Third-Party Notices](third-party-notices.md). - -## Release Smoke - -```bash -gh release list --repo putdotio/rokit --limit 5 -npm view @putdotio/rokit version -``` - -Releases need no Roku.