Skip to content

Commit 4677db8

Browse files
jpheinclaude
jphein
and
claude
authored
feat(docs): scripts/ship-prep.sh — one-command pre-PR doc render chain (#315)
Closes #312. Before this PR, every fork-ahead branch needed the same hand-driven sequence after a rebase (or any test-count-affecting change): 1. sed-bump README's "<N> tests pass on `main`" phrase 2. python scripts/render-docs.py --target all 3. python scripts/render-llms-full.py 4. python scripts/render-api-docs.py 5. bash scripts/check-docs.sh Five steps, four scripts, one sed. Easy to forget step 4 (API docs) because the failure surfaces only as "website/reference/python-api/ is stale" in CI. Easy to forget the test-count bump because adding or removing tests is incidental to the PR's intent. ship-prep.sh bundles them into one invocation. The pytest-discovery matches scripts/check-docs.sh's fallback chain (#311), so it works from a worktree without an activated venv. The test-count bump is idempotent — it's a no-op when the number is already correct, so re-running after follow-up commits is safe. --no-check skips the trailing check-docs.sh pass when you want to inspect the regenerated diff before re-running checks. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent f753ec4 commit 4677db8

5 files changed

Lines changed: 325 additions & 162 deletions

File tree

‎FORK_CHANGELOG.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,29 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
2424
### Added
2525

2626

27+
- **scripts/ship-prep.sh — one command bumps README test count and runs all three doc renderers (#312)** ([`HEAD`](https://github.com/techempower-org/mempalace/commit/HEAD))
28+
Every fork-ahead PR has needed the same hand-driven dance after a
29+
rebase: bump ``README.md``'s "<N> tests pass on ``main``" phrase,
30+
run ``scripts/render-docs.py --target all``, run
31+
``scripts/render-llms-full.py``, run ``scripts/render-api-docs.py``,
32+
then ``scripts/check-docs.sh`` to verify. Five steps, four scripts,
33+
one ``sed``. ``scripts/ship-prep.sh`` bundles them.
34+
35+
The script's pytest-discovery follows the same fallback chain
36+
``scripts/check-docs.sh`` uses (#311 — repo venv, then main
37+
checkout's venv via ``git rev-parse --git-common-dir``, then
38+
PATH), so it works from a worktree without an activated
39+
environment. The test-count bump is idempotent — no-op if the
40+
number is already correct — so re-running after a follow-up
41+
commit is safe.
42+
43+
``--no-check`` skips the trailing ``check-docs.sh`` verification
44+
for the case where you intentionally want to inspect the
45+
regenerated diff before re-running checks.
46+
47+
*Files:* `scripts/ship-prep.sh`
48+
49+
2750
- **mempalace_search MCP input schema accepts fusion_mode (convex|rrf) and forwards to search_memories (#302)** ([`HEAD`](https://github.com/techempower-org/mempalace/commit/HEAD))
2851
#162 / PR #295 added ``fusion_mode`` to ``search_memories()`` with
2952
``"convex"`` default and ``"rrf"`` opt-in, validated by the

0 commit comments

Comments
 (0)