naudachu
1815d91cdf
A discussion leaves behind a directory of markdown somewhere outside this repo, and the only durable home for it is the Gitea wiki. Getting it there by hand means re-deriving the same three things every time: what each file should be called, where it goes, and whether the page already exists. Two skills wrap that, along the split the repo already uses. `skills/page` is domain, offline, stdlib-only, and knows nothing about Gitea. It imports a directory into a space under `tmp/wiki/`, titles every file, records the result in `.pages.json`, and writes the index. `skills/wiki` is the bridge — `wikimap.py` translates, and the transport is `_gitea.py`, the same one the issue side uses. There is no second transport, and `tea` has no wiki subcommand to offer one. The Gitea wiki is flat, and that fact shapes everything There are no directories. A title of `a/b` is stored as one file named `a%2Fb.md`, and Gitea escapes it by rules of its own: space becomes `-`, `/` becomes `%2F`, and a literal `-` forces a trailing `.-` marker so the two stay distinct. `Chain decisions — DC` under two levels of prefix comes back as `Simple-Chains%2FParked%2FChain-decisions-%E2%80%94-DC`. So `sub_url` is the identity, it is read back from whatever the API returned, and it is never constructed. One built by hand that is almost right does not fail — it creates a second page and abandons the first. And a real subdirectory committed into a wiki's git repository is a ghost: the file exists, the API and the web UI do not see it. `folder/page.md` in this repo's own wiki is one. Nothing here clones a wiki repo. A title is a decision, not a derivation Titles come from the first heading, because there is no mechanical route from `03-q-01-do-we-know-the-chain-participant-by-name.md` to `Q-01. Do We Know the Chain Participant by Name`. But they are derived exactly once. A re-import replaces bodies and keeps titles, so editing a heading cannot rename a published page — which would not rename it, it would publish a second one. `--retitle` opts in. It finds the prior entry by `source` rather than by path, because the path is derived from the title and a retitle moves it; looked up by path the page would read as new and the next push would duplicate it. The old file goes, `sub_url` comes along, and `pushed` is cleared — a rename can leave the body byte-identical, and push decides by body hash alone, so a stale hash would skip the rename forever. Ordering is a `NN-` file-name prefix and never reaches the title. `00-` means "this is the directory's own page", and that page is named for the directory, not for its own heading: a child's title has to extend its parent's exactly, and `ideas/00-intro.md` opens with "Ideas for chain business requirements". Path collisions are reported and never resolved. Picking a winner is how a discussion loses a document. The index is navigation, not decoration Nothing draws a tree from flat titles. `page_index.py` writes one as an ordinary page, nested by title depth rather than by manifest path order — those disagree, since on disk `Top/System.md` sorts before `Top/Ideas/Scale.md` while in the hierarchy System is a child and Scale a grandchild. A parent with no page of its own still gets a node, so its children are not hidden. Links use `sub_url` when there is one and Gitea's `[[Title|label]]` syntax when there is not, so the order is push, rebuild, push. The same stances as the issue store, for the same reasons Pull overwrites, push is additive and never deletes, change detection is one hash and there is no drift model. A page with no `sub_url` has never been published, and that is a durable state. Issues gain a `wiki:` field holding page titles — titles, not URLs, so the reference stays in the domain. It already round-trips as a foreign key; this documents it. Verified against a live Gitea 1.26.1: create, update with a message, unchanged-skip, prefix-filtered pull, byte-identical round trip, and the per-page revision history carrying the operator's own words. The probe pages were deleted afterwards. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
128 lines
4.7 KiB
Python
128 lines
4.7 KiB
Python
#!/usr/bin/env python3
|
|
"""
|
|
wiki_pull.py — fetch wiki pages into a local space.
|
|
|
|
wiki_pull.py the whole wiki
|
|
wiki_pull.py --prefix "Simple Chains" a page and everything under it
|
|
wiki_pull.py --repo other/repo --space docs from elsewhere, into a named space
|
|
|
|
The wiki is flat, so "a page and its children" is a prefix test on the title,
|
|
run against one listing call. One GET per page follows. There is no tree
|
|
endpoint to ask for a subtree, and no way to fetch bodies in bulk.
|
|
|
|
Pulling OVERWRITES the local body — a fetch, not a merge, the same stance the
|
|
issue store takes. `sha` and `synced` tell you how old your copy is; re-pull
|
|
when it matters. Nothing tracks drift.
|
|
|
|
Usage:
|
|
wiki_pull.py [--repo owner/repo] [--prefix TITLE] [--space SPACE]
|
|
[--dry-run] [--out DIR]
|
|
"""
|
|
import argparse
|
|
import os
|
|
import sys
|
|
|
|
_HERE = os.path.dirname(os.path.abspath(__file__))
|
|
sys.path.insert(0, _HERE)
|
|
sys.path.insert(0, os.path.join(_HERE, "..", "..", "sync", "scripts"))
|
|
sys.path.insert(0, os.path.join(_HERE, "..", "..", "page", "scripts"))
|
|
import _gitea # noqa: E402
|
|
import page # noqa: E402
|
|
import wikimap # noqa: E402
|
|
|
|
|
|
def main():
|
|
ap = argparse.ArgumentParser()
|
|
ap.add_argument("--repo", help="owner/repo (default: the repo in CWD)")
|
|
ap.add_argument("--prefix", default="", help="only titles at or under this")
|
|
ap.add_argument("--space", help="local space (default: the owner/repo slug)")
|
|
ap.add_argument("--dry-run", action="store_true")
|
|
ap.add_argument("--out", help="wiki cache root (default: <repo>/tmp/wiki)")
|
|
a = ap.parse_args()
|
|
|
|
login = _gitea.require_login()
|
|
base = _gitea.repo_base(a.repo)
|
|
slug = _gitea.repo_slug(login, a.repo)
|
|
space = a.space or slug
|
|
root = a.out or page.WIKI_ROOT
|
|
space_dir = page.space_root(space, root)
|
|
|
|
listing = _gitea.paginate(login, "%s/wiki/pages" % base)
|
|
if not isinstance(listing, list):
|
|
_gitea.die("unexpected listing from %s/wiki/pages" % base)
|
|
|
|
wanted = [p for p in listing
|
|
if wikimap.matches_prefix(p.get("title") or "", a.prefix)]
|
|
if not wanted:
|
|
if a.prefix:
|
|
_gitea.die("no page at or under %r in %s (%d page(s) in the wiki)"
|
|
% (a.prefix, slug, len(listing)))
|
|
_gitea.die("%s has no wiki pages" % slug)
|
|
|
|
manifest = page.load_manifest(space, root)
|
|
|
|
# Two remote titles can land on one local path — Gitea keeps them apart with
|
|
# its `.-` marker, a filesystem does not. Caught before anything is written,
|
|
# because the failure mode otherwise is one page silently overwriting
|
|
# another and the manifest pointing both entries at the survivor.
|
|
seen = {}
|
|
for p in wanted:
|
|
seen.setdefault(page.path_for_title(p["title"]), []).append(p["title"])
|
|
clashes = {k: v for k, v in seen.items() if len(v) > 1}
|
|
for path, titles in sorted(clashes.items()):
|
|
sys.stderr.write("collision: %s <- %s\n" % (path, " | ".join(titles)))
|
|
|
|
created = not os.path.isdir(space_dir)
|
|
n = 0
|
|
for p in sorted(wanted, key=lambda x: x.get("title") or ""):
|
|
title = p["title"]
|
|
relpath = page.path_for_title(title)
|
|
if relpath in clashes:
|
|
continue
|
|
|
|
if a.dry_run:
|
|
print("%-44s %s" % (relpath, title))
|
|
n += 1
|
|
continue
|
|
|
|
full = _gitea.api(login, wikimap.page_endpoint(base, p["sub_url"]))
|
|
if not isinstance(full, dict):
|
|
_gitea.warn("could not read %r; skipped" % title)
|
|
continue
|
|
text = wikimap.decode(full)
|
|
|
|
dest = os.path.join(space_dir, relpath)
|
|
os.makedirs(os.path.dirname(dest), exist_ok=True)
|
|
with open(dest, "w", encoding="utf-8") as f:
|
|
f.write(text)
|
|
|
|
# The prior entry is the base so `order` — a local decision the wiki
|
|
# cannot hold — survives a pull.
|
|
e = dict(manifest["pages"].get(relpath, {}))
|
|
e.update(wikimap.from_payload(full))
|
|
e["synced"] = _gitea.now_iso()
|
|
# What is on disk is now exactly what is published, so push has nothing
|
|
# to do until the file is edited.
|
|
e["pushed"] = page.body_hash(text)
|
|
manifest["pages"][relpath] = e
|
|
print("%-44s %s" % (relpath, title))
|
|
n += 1
|
|
|
|
if a.dry_run:
|
|
print("\ndry run — %d page(s) would be written to %s" % (n, space_dir))
|
|
return 1 if clashes else 0
|
|
|
|
page.save_manifest(manifest, root)
|
|
if created:
|
|
sys.stderr.write("created space %s\n" % space_dir)
|
|
print("\n%d page(s) from %s -> %s" % (n, slug, space_dir))
|
|
if clashes:
|
|
sys.stderr.write("%d collision(s) skipped — rename them in the wiki\n"
|
|
% len(clashes))
|
|
return 1
|
|
return 0
|
|
|
|
|
|
if __name__ == "__main__":
|
|
sys.exit(main())
|