chore: promote the #124 docs into 5.3.1 - #125
Merged
Merged
Conversation
Promote from dev to stable, carrying the documentation half of #124 that the 5.3.1 promotions dropped. `ci: stop reaching into the private dcd repo for the mock-api` (#124) touched six files on dev. The promote PR (#123) carried four of them — `cli-ci.yml`, `scripts/test-runner.mjs`, the `test:unit` script in `package.json`, and eight of the ten changed `CLAUDE.md` lines — and dropped `CONTRIBUTING.md` and `README.md` entirely. Production therefore ships the new CI shape while its docs still describe the old one: * `CONTRIBUTING.md` told contributors `pnpm test` boots a mock API, and that integration tests are "automatically skipped" on fork PRs only. Neither is true: CI runs no integration tests on any PR, and there is no default mock. It also omitted `pnpm test:unit` from the pre-push checklist, though it is now a required check. * `README.md`'s dev-scripts block still showed `pnpm test # build + boot mock API + integration/unit tests`. * `CLAUDE.md`'s Contributing section still described the `DCD_SSH_DEPLOY_KEY` mock-api checkout, which no longer exists. `README.md` is the one with reach beyond this repo: npm always includes it in the tarball regardless of the `files` field, so the stale snippet would render on the npmjs.com page for 5.3.1. Docs only — no source, workflow, script or lockfile change. The three files are now byte-identical to `dev`, leaving release plumbing (both manifests, `CHANGELOG.md`, `package.json` version) as the only remaining divergence, which is release-please's to own. `Release-As: 5.3.1` keeps the pending release PR (#120) on 5.3.1 rather than rolling it to 5.3.2. Release-As: 5.3.1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Promote from dev to stable, carrying the documentation half of #124 that the 5.3.1 promotions dropped.
ci: stop reaching into the private dcd repo for the mock-api(#124) touched six files on dev. The promote PR (#123) carried four of them —cli-ci.yml,scripts/test-runner.mjs, thetest:unitscript inpackage.json, and eight of the ten changedCLAUDE.mdlines — and droppedCONTRIBUTING.mdandREADME.mdentirely. Production therefore ships the new CI shape while its docs still describe the old one:CONTRIBUTING.mdtold contributorspnpm testboots a mock API, and that integration tests are "automatically skipped" on fork PRs only. Neither is true: CI runs no integration tests on any PR, and there is no default mock. It also omittedpnpm test:unitfrom the pre-push checklist, though it is now a required check.README.md's dev-scripts block still showedpnpm test # build + boot mock API + integration/unit tests.CLAUDE.md's Contributing section still described theDCD_SSH_DEPLOY_KEYmock-api checkout, which no longer exists.README.mdis the one with reach beyond this repo: npm always includes it in the tarball regardless of thefilesfield, so the stale snippet would render on the npmjs.com page for 5.3.1.Docs only — no source, workflow, script or lockfile change. The three files are now byte-identical to
dev, leaving release plumbing (both manifests,CHANGELOG.md,package.jsonversion) as the only remaining divergence, which is release-please's to own.Release-As: 5.3.1keeps the pending release PR (#120) on 5.3.1 rather than rolling it to 5.3.2.Release-As: 5.3.1
What & why
Type of change
fix— bug fixfeat— new featureperf— performance improvementrefactor— code change that's neither a fix nor a featuredocs— documentation onlychore/ci/build/test— tooling, no user-facing change!or PR notes aBREAKING CHANGE:)Checklist
pnpm lintpassespnpm typecheckpassespnpm buildpassesCHANGELOG.md(release-please handles this)README.md/STYLE_GUIDE.mdupdated if behaviour or output changedHow to test