torben
9e414319b8
Files changed: - CHANGES.md - VERSION - instructions/page-lifecycle.md - instructions/publish-cycle.md - tools/CONTRACT.md - tools/chemenu/cli.py - tools/chemenu/commands/log_append.py - tools/chemenu/commands/migrate_cmd.py - tools/chemenu/commands/new_page.py - tools/chemenu/commands/page_ops.py - tools/chemenu/corpus_diff.py - tools/chemenu/lint_core.py - tools/chemenu/tests/test_corpus_diff.py - tools/chemenu/tests/test_lint.py - tools/chemenu/tests/test_migrate_cmd.py - tools/chemenu/tests/test_page_ops.py - tools/chemenu/tests/test_type_resolver.py - tools/chemenu/type_resolver.py
1.8 KiB
type, name, description
| type | name | description |
|---|---|---|
| types/instruction.md | publish-cycle | Close out a change to the wiki - rebuild the provenance index and catalog, append the audit entry, and publish. |
Close out a change
Run after any change to pages under kb/, in this order. The order matters: the catalog is
built from page frontmatter, and the audit entry should describe a tree that is already
consistent.
Steps
-
Rebuild the provenance index - after any change to a source page or an inline citation:
tools/wikitool sources rebuild-index -
Rebuild the catalog - after any page was added, removed, renamed, or had its summary/date changed:
tools/wikitool index rebuildThis regenerates
kb/index.mdand everykb/**/INDEX.md. Never edit those by hand. -
Append the audit entry - one per operation:
tools/wikitool log append --op ingest|query|lint|create|update|delete|rename|move \ --title "<what>" --body "<outcome>"This is the one non-idempotent step. If a previous run's outcome is uncertain, read the tail of
kb/log.mdbefore repeating it. -
Publish:
tools/wikitool publish --message "<op>: <description>"
Decision points
- Ten or more files changed?
publishexits 42. Show the user its output and stop; see gates.md. - Query or lint pass? Neither auto-publishes. Run
publishonly if asked to. - Nothing under
kb/changed? Skip steps 1 and 2; a change totools/orinstructions/does not affect the catalog.
Scope
This is the close-out for wiki content. Changes to skills also need
tools/wikitool instructions sync (see bootstrap.md), and changes to the CLI
or a contract need tools/wikitool docs verify.