Repository navigation
Releases
cli/v0.25.0
Before you upgrade
A coined property type is now reported
property-type-unknown warns on a type: that nothing reads (#1391). Its values were never checked.
Known types are string, text, ref, date, number, claim, quotation and list.
For entries that are records, declare a list with fields:.
The finding is a warning and does not gate.
What's Changed
- ci: fall back to a non-Canonical Ubuntu mirror when the runner's apt mirror is unreachable by @goedelsoup in #1471
- fix(practice): sample fixed checkpoints so an authored commit rarely owes a regen by @goedelsoup in #1470
- feat(tonpa): pin a path dependency to a commit; check-diff reads dependency classes by @goedelsoup in #1472
- fix(phase): run resolves its plan over the steps it can invoke by @goedelsoup in #1474
- feat(phase): settle drafts an upstream report; cohort counts citations by @goedelsoup in #1475
- fix(run): $YIDAM_GRAPH states each field of a list record by @goedelsoup in #1476
- fix(practice): a phase merge is counted and is never a point, so settling a phase leaves main's block current by @goedelsoup in #1477
- fix(catalog): a new digest supersedes only a record of the same resource by @goedelsoup in #1478
- test(lint): pin #1382 at edge-standing-unheld by @goedelsoup in #1479
- feat(lint): warn on a property type nothing reads (#1391) by @goedelsoup in #1480
- release: cli/v0.25.0 + v0.15.0 by @goedelsoup in #1481
Full Changelog: cli/v0.24.0...cli/v0.25.0
cli/v0.24.0
Before you upgrade
phase settle --merge writes the phase merge, and max_open_proposals is read locally
yidam phase settle --merge writes the merge that settle drafts. It is authored by yidam phase, with you as committer.
It refuses a phase that is not ready, or a baseline that has moved on. It also refuses a checkout that is not the commit.
--summary "<text>" replaces the drafted tally in the merge subject.
Plain yidam phase settle is unchanged and still commits nothing.
[cluster] max_open_proposals is now read by yidam propose and yidam run, against local propose/* branches.
At the cap, neither opens a new proposal branch. A corpus without the key sees no change.
See cli-reference.md and configuration.md.
New derivations may write proposals, where an identity allows it
New derivations ship [serve] act = "when-identity" in .yidam/config.toml.
serve --mcp then serves propose and cycle wherever a git author identity resolves.
Without one, the server still starts, with the read tools only.
It says why at startup and in every refusal of propose or cycle.
An HTTP bind beyond loopback is treated the same way.
An existing repository keeps what its file says.
Write act = "when-identity" under [serve] to adopt the new default.
act = true still refuses to start where a condition fails.
The MCP contract is now 0.32.0.
Sessions now open with the loop's brief
New derivations ship .claude/settings.json with two Claude Code hooks.
The SessionStart hook prints yidam cycle --brief into the session.
The Stop hook records the round and tells you what each turn moved.
Run yidam migrate scaffold to add the hooks to an existing repository.
It creates .claude/settings.json, or adds the hooks to yours.
It refuses a settings file that already declares hooks.
Add the two entries by hand there, as sadhana/root/claude-settings.json does.
yidam doctor warns when a repository with a CLAUDE.md has no hooks.
The hooks run the binary in .yidam/bin, so pin a release that has yidam hook.
An older binary makes the hooks silent, never a failure.
cycle can now say what moved since the last round
yidam cycle --record keeps this round under .yidam/loop/<branch>.json.
yidam cycle --since-last reports what arrived and what left since that record.
It covers findings, due clocks, stale steps, refs in flight and local proposals.
Each branch keeps its own record, and a detached HEAD keeps HEAD.json.
The directory writes its own .gitignore, so nothing in it is ever staged.
No migration is needed.
With no record, since_last is absent and since_last_unread says why.
Never read that as nothing having moved.
yidam cycle --brief prints a short report within a token budget.
The default budget is 500 tokens, and --budget changes it.
It refuses --format json.
Without these flags, cycle prints exactly what it printed before.
cycle acts now say whether a command does them
Each act in cycle's next, and each clock naming a remedy, now carries kind.
It is tool or person.
A tool act carries argv, and running it from the report's root is the act.
A next item also carries targets, naming the nodes, steps or refs it is about.
A loop can now run tool acts without parsing the prose act string.
Treat a missing kind as person, because an older yidam sends none.
The MCP contract is now 0.31.0.
Its cycle notes now also describe stale_steps and stale_steps_unread.
cycle now reports stale manifest steps as owed
yidam cycle now reads .yidam/capabilities.toml the way yidam run --dry-run does.
A step whose receipt does not match the tip is listed under stale_steps.
It adds one yidam run act to next.
cycle --strict now exits nonzero on a stale step, as it does on a due clock.
A scheduled job using --strict may start failing where it passed before.
Run yidam run, or drop --strict if you only wanted the report.
When the steps cannot be planned, stale_steps_unread says why.
A detached HEAD is the common case, so CI checkouts will see it.
cycle now spells an in-flight act in_flight
next[].source for an in-flight phase is "in_flight". It used to be "inflight" (#1439). The schema always declared "in_flight", so a validating consumer rejected any cycle report with a phase in flight.
If you match on source, match "in_flight". This applies to a script or a prompt that reads cycle --format json or the MCP cycle tool. A match on "inflight" will stop finding anything.
What's Changed
- docs: record three backlog decisions (#946, #591, #888) by @goedelsoup in #1437
- fix(cli): cycle spelled an in-flight act "inflight", and the schema it ships says "in_flight" by @goedelsoup in #1445
- docs(rfcs): strike RFC-0026 open question 2, which RFC-0029 settled by @goedelsoup in #1446
- fix(cycle): report stale manifest steps as owed, as cluster admit does by @goedelsoup in #1447
- feat(cycle): say whether a command is the act — kind, argv, targets by @goedelsoup in #1448
- feat(cycle): record a round, report what moved since the last one, and a budgeted brief by @goedelsoup in #1449
- feat(hook): hand every session the loop's brief, and tell the person what a turn moved by @goedelsoup in #1450
- feat(serve): scaffold
act = "when-identity"— the act tier where it can be authored, withheld with a reason where not by @goedelsoup in #1451 - feat(phase): settle --merge writes the phase merge; propose and run read max_open_proposals by @goedelsoup in #1453
- release: cli/v0.24.0 + v0.14.0 by @goedelsoup in #1454
Full Changelog: cli/v0.23.1...cli/v0.24.0
cli/v0.23.1
Before you upgrade
The bootstrap skill is no longer vendored
A re-vendor now removes .yidam/.vendor/prelude/skills/ (#1435). The bootstrap skill made your repository and never runs in it again.
Delete the bootstrap row from .yidam/skills/README.md by hand. It sits under Inherited from prelude, and its link now goes nowhere.
A re-vendor never rewrites that file, so nothing else will remove it.
Delete the whole table if that row was its only entry.
What's Changed
- docs: fix stale and wrong statements in derived-repo context files by @goedelsoup in #1433
- docs: fold the derived CLAUDE.md into AGENTS.md, and lead with what is used by @goedelsoup in #1434
- fix(vendor): drop the bootstrap skill from a derived repository's prelude by @goedelsoup in #1435
- build(deps-dev): Bump the npm-extension group in /yidam/editors/vscode with 3 updates by @dependabot[bot] in #1422
- build(deps): Bump the npm-edit group across 1 directory with 5 updates by @dependabot[bot] in #1424
- build(deps-dev): Bump @huggingface/transformers in /yidam/sdks/typescript by @dependabot[bot] in #1423
- build(deps): Bump the npm-docs group across 1 directory with 7 updates by @dependabot[bot] in #1425
- build(deps): Bump the cargo-cli group across 1 directory with 7 updates by @dependabot[bot] in #1426
- release: cli/v0.23.1 by @goedelsoup in #1436
Full Changelog: cli/v0.23.0...cli/v0.23.1
cli/v0.23.0
Before you upgrade
index-build embeds each record alone
index-build now embeds one record per call (#1428). Each record is embedded the way a query is.
Before, records went in batches of 256. Each vector then depended on the records batched with it.
Rebuild your index with yidam index-build. An old index still works, but its vectors sit slightly apart from its queries.
On one corpus, a record used as a query kept 92% of its top ten.
A shared remote index should be rebuilt by every corpus that pushes to it. Then all its vectors come from one build.
The build is also faster and smaller. One corpus took 23 seconds instead of 43, and 0.2 GB instead of 12 GB.
[index] batch_size restores batching, but its vectors drift from the queries again. See configuration.
What's Changed
- feat(index-build): batch, thread and session knobs, with progress (#1427) by @goedelsoup in #1429
- fix(index-build): embed each record alone, as a query is (#1428) by @goedelsoup in #1430
- release: cli/v0.23.0 by @goedelsoup in #1431
Full Changelog: cli/v0.22.0...cli/v0.23.0
cli/v0.22.0
Before you upgrade
type: list is now a checked type
A property declared type: list is now read (#1391, RFC-0050). Before, list was a coined type and nothing checked it.
Its value must now be a non-empty list.
A single value not wrapped in a list is reported by property-type.
items: and fields: say what each item is. fields: declares a record, closed to keys it does not name.
A misspelled key in a record is now an error.
See configuration for the forms.
A tag inside a property is no longer the node's standing (#1382). Standing is read from top-level type: claim properties only.
To grade each entry, declare the property type: list with a claim field.
claim-property-undeclared now suggests exactly that.
The warehouse contract no longer refuses a list property. It gets no column, as a claim does.
What's Changed
- feat(schema): add a
listproperty type (RFC-0050) by @goedelsoup in #1420 - release: cli/v0.22.0 by @goedelsoup in #1421
Full Changelog: cli/v0.21.0...cli/v0.22.0
cli/v0.21.0
Before you upgrade
Semantic retrieval is in every released binary
vector-read joined the default feature set (#442). Every install channel now carries index-build and semantic retrieve.
yidam --version lists vector-read index among its features.
The binary grows from about 23 MB to 56 MB.
What changes for you: retrieve turns semantic once the corpus has an index.
Run yidam embed && yidam index-build, or yidam vault pull --index where a vault holds one.
A corpus with no index answers by keyword, as before.
Semantic retrieval does not span tonpa dependencies; keyword retrieval does.
On an Intel Mac, install ONNX Runtime 1.24 or newer. brew install onnxruntime provides it.
The Homebrew tap installs it for you.
Elsewhere set ORT_DYLIB_PATH to a libonnxruntime.dylib.
Without it, only commands that embed fail, and each names the fix.
On Linux, the release binaries now need glibc 2.39 or newer. Debian 13 and Ubuntu 24.04 qualify.
Debian 12, Ubuntu 22.04 and RHEL 9 do not, and fail with version GLIBC_2.39 not found.
The cluster image moved to Debian 13 for the same reason.
To keep the old build, install from source. Pass --no-default-features with the other default features.
Installation has the command.
What's Changed
- fix(deps): bump ctutils to 0.4.5 for RUSTSEC-2026-0385 by @goedelsoup in #1414
- build(deps): Bump the cargo-cli group across 1 directory with 10 updates by @dependabot[bot] in #1410
- build(deps): Bump serde_json from 1.0.151 to 1.0.154 in /yidam/tests/harness in the cargo-harness group across 1 directory by @dependabot[bot] in #1383
- build(deps): Bump toml from 1.1.6+spec-1.1.0 to 1.1.8+spec-1.1.0 in /yidam/domains/parity/testkit in the cargo-testkit group across 1 directory by @dependabot[bot] in #1378
- build(deps-dev): Bump vitest in /yidam/domains/causal/typescript by @dependabot[bot] in #1387
- build(deps): Bump the npm-edit group across 1 directory with 8 updates by @dependabot[bot] in #1412
- build(deps): Bump the npm-docs group across 1 directory with 8 updates by @dependabot[bot] in #1413
- build(deps): Bump the cargo-sdk group across 1 directory with 2 updates by @dependabot[bot] in #1385
- build(deps-dev): Bump smol-toml in /yidam/domains/causal/typescript by @dependabot[bot] in #1389
- build(deps-dev): Bump the npm-extension group across 1 directory with 4 updates by @dependabot[bot] in #1411
- feat(cli): put vector-read in the default feature set by @goedelsoup in #1418
- release: cli/v0.21.0 — bump the CLI, repin the install lines, file 1 upgrade note by @goedelsoup in #1419
Full Changelog: cli/v0.20.0...cli/v0.21.0
cli/v0.20.0
Before you upgrade
Export an ontology to BigQuery and TextQL
yidam export --format warehouse writes your ontology as a BigQuery contract (#1394).
It writes one table per class, a link table per edge and a value table per closed set.
The first export writes ddl/bigquery/0001_init.sql.
A later export writes the next numbered migration, and refuses a change that would lose data.
A feed maps a pipeline's landing table onto the contract.
Declare one in .yidam/warehouse/feeds/<feed>.yml, and the export writes a MERGE script per table.
It refuses a feed that maps anything the ontology does not declare.
--with-corpus adds your nodes as rows, and --format textql writes a TextQL Ontology folder.
See From a corpus to a warehouse for the whole route.
What changes for you: nothing, until you run the export.
Never run a snapshot feed over an empty landing table, because it deletes every row that feed wrote.
What's Changed
- fix(template): measure the pin length without opening a Tera comment by @goedelsoup in #1368
- build(deps): Bump jsonschema from 0.58.2 to 0.58.4 in /yidam/cli in the cargo-cli group by @dependabot[bot] in #1371
- build(deps-dev): Bump @types/node from 26.6.3 to 26.6.4 in /yidam/editors/vscode in the npm-extension group by @dependabot[bot] in #1369
- build(deps-dev): Bump @types/node from 26.6.3 to 26.6.4 in /yidam/editors/web in the npm-edit group by @dependabot[bot] in #1372
- build(deps): Bump the npm-docs group in /yidam/web/docs with 2 updates by @dependabot[bot] in #1370
- build(deps-dev): Bump vitest in /yidam/sdks/typescript by @dependabot[bot] in #1373
- build(deps): Bump the npm-edit group in /yidam/editors/web with 4 updates by @dependabot[bot] in #1381
- build(deps): Bump the npm-docs group in /yidam/web/docs with 5 updates by @dependabot[bot] in #1375
- build(deps-dev): Bump oxlint from 1.86.0 to 1.87.0 in /yidam/editors/vscode in the npm-extension group by @dependabot[bot] in #1374
- build(deps-dev): Bump @huggingface/transformers in /yidam/sdks/typescript by @dependabot[bot] in #1379
- docs(rfc): RFC-0049 — the ontology as a warehouse contract, and a textql export by @goedelsoup in #1393
- feat(export): derive a BigQuery warehouse contract from the ontology (#1396) by @goedelsoup in #1403
- feat(export): feed files become BigQuery load SQL (#1397) by @goedelsoup in #1404
- feat(export): --format textql writes the ontology as a TextQL folder (#1398) by @goedelsoup in #1405
- feat(export): evolve the warehouse contract by migration (#1401) by @goedelsoup in #1406
- feat(export): carry the corpus's own nodes as the corpus feed (#1400) by @goedelsoup in #1407
- docs(warehouse): guide, cloud-inventory example with CAI and AWS Config feeds, Airflow example (#1402) by @goedelsoup in #1408
- release: cli/v0.20.0 by @goedelsoup in #1409
Full Changelog: cli/v0.19.0...cli/v0.20.0
cli/v0.19.0
Before you upgrade
catalog-location-malformed reports a url with a # fragment
A url location that names a member with # is now a finding (#1352).
A fragment never reaches the server, so catalog-fetch downloads the whole file.
The entry then reads as if it held only the part the fragment names.
The finding names the file actually fetched.
What changes for you: a corpus holding such a location gets a new warning.
Move the part after # under members: to read one file inside a zip.
See Read a file inside a zip.
A file inside a zip is read as a reading
A location can list members:, paths inside the zip it names (#1351).
catalog-extract unpacks each into the cache and records it under the zip's readings:.
Each such reading carries member: and by: unzip.
See Read a file inside a zip.
Lint refuses a member path that leaves the archive.
catalog-location-malformed names a path with .., a leading /, a drive letter or a backslash.
What changes for you: nothing.
An entry without members: reads as before.
Source packs that pin a mutable identifier
A scheme can pin an identifier that names a moving target (#1343).
Declare [scheme.<name>.pin] with mutable, read, media, value and pinned.
source add asks the read once, and writes the version it answered into the identifier.
See Source packs.
archive 0.2.0 adds github and wikipedia.
github:<owner>/<repo>@<ref>/<path> is pinned to the commit the ref names.
wikipedia:<lang>/<title> is pinned to the article's current revision.
A bare wayback:<url> is pinned to the capture the archive names.
catalog-fetch refuses the mutable form, with how to pin it.
It never asks the read.
The MCP contract is now 0.30.0.
resolve_source returns the pinned identifier in locations, and answered counts the read.
What changes for you: re-pin archive to use the new schemes.
archive@^0.1 does not admit 0.2.0. Change it to archive@^0.2, then run mise run yidam-vendor-update.
Every wayback:<timestamp>/<url> location resolves as before.
Source packs that read a listing or a catalog
A scheme can resolve through a page that lists its files (#1342).
Write resolve = { listing = "…", match = '…' }, or resolve = { dcat = "<host>" } for a DCAT-US data.json.
Use one where a release date or a fresh path in the address defeats a template.
See Source packs.
source add writes the file it picked into the identifier.
The location reads scheme:local-id@<pin>, and catalog-fetch follows only the pin.
An identifier in such a scheme without a pin is skipped, with a message saying how to pin it.
A resolve without template now parses.
A pack with no template, listing or dcat still fails source check, now with that message.
The MCP contract is now 0.29.0.
resolve_source returns the pinned identifier in locations, and answered counts a page read.
What changes for you: nothing.
Every template pack resolves as before.
Source packs that read a paged answer to its end
A scheme can declare paginate (#1341).
Name the offset parameter, the record array, and how to know the last page.
catalog-fetch asks for every page, and records one artifact holding every record.
See Source packs.
catalog-fetch refuses an answer with exceededTransferLimit: true from a scheme without paginate.
The refusal is a finding on the entry, and the run fails.
What changes for you: nothing, unless an entry fetched a cut-short answer.
Such an entry recorded the first page only. Declare paginate on its scheme, and fetch it again.
catalog-location-malformed checks identifiers against your packs
Once you enable a source pack, identifier locations are held to it (#1328).
yidam lint reports a scheme that no enabled pack declares.
It also reports a local id that the scheme's pattern refuses.
When a template pack declares the scheme, the finding names that pack.
For example, wayback: names archive. Pin it under prelude_sources to clear the finding.
What changes for you: nothing, until you pin a pack.
A corpus with no packs is checked for the scheme:local-id shape alone, as before.
doctor checks that your binary was built at the pin
yidam doctor has a new commit check (#1324).
It compares the running binary's build commit with .yidam.toml's commit.
They agree when one hash is a prefix of the other.
What changes for you: a stale .yidam/bin/yidam now fails doctor.
That is the binary a re-vendor leaves behind when nobody rebuilt it.
The finding names both commits. Run mise run yidam-build to repair it.
A repository with no .yidam/bin/yidam gets a warning instead, since another yidam answered.
A binary that records no build commit also warns, because nothing can be compared.
The scholarly and archive source packs
The template ships its first two source packs (#1320).
scholarly reads papers by doi:, pmc: and arxiv:, through Crossref, Europe PMC and arXiv.
archive reads Wayback Machine snapshots and Internet Archive items.
See Source packs.
One source add --fetch doi:… reaches a paper's open-access full text.
The DOI leads to a europepmc: location, and that one to pmc: when Europe PMC holds the text.
catalog-extract then reads the full text as plain text, without the reference list.
scholarly requires YIDAM_CONTACT.
Every request it makes names that contact, and it waits three seconds between requests to one host.
What changes for you: nothing, until you pin a pack.
Add scholarly@^0.1 or archive@^0.1 under prelude_sources, then run mise run yidam-vendor-update.
search_sources and resolve_source over MCP
serve --mcp answers two source-pack questions, and writes nothing (#1319).
search_sources is yidam source search. resolve_source is yidam source add --dry-run.
Both sit at a new sources tier, true where the corpus enables a pack.
The MCP contract is now 0.28.0. See MCP server.
[serve] offline_sources = true answers both from the packs' recorded fixtures.
Each answer says which route it took, in answered.
What changes for you: nothing, until you enable a pack.
A client that pins the contract version sees 0.28.0, with sources in the capability block.
Source pack transforms, and readings: on a catalog artifact
A source pack's scheme may name a describe and an extract transform (#1318).
Each is a .glu file under the pack's transforms/, run in the calculator arm's closed prelude.
The binary parses the response as JSON, XML or CSV and hands the transform the parsed value.
yidam source check admits each transform and runs it over the scheme's fixtures.
Transforms need the source-transforms feature, which is outside the default build.
It implies calculators-gluon, and adds 3 packages and 0.12 MB over it.
A build without it checks the rest of a pack, and says it did not check the transforms.
catalog-extract records a reading under readings:, not text:.
Each reading names its digest, its media type, and what took it in by:.
An artifact fetched from an identifier whose pack declares extract is read by that transform.
A build without source-transforms reports that artifact as skipped.
What changes for you: nothing you must do.
An entry that holds its reading under text: keeps it, and lint and the vault still read it.
A PDF that already has a text: reading is not read again.
catalog-fetch follows identifiers through source packs
catalog-fetch now fetches a kind: identifier location through the pack declaring its scheme (#1317).
An identifier no enabled pack declares is skipped, as before.
See Fetching an identifier.
Every request now names the tool in its User-Agent.
Set YIDAM_CONTACT to an email address or URL to add it there.
A pack with contact = "required" fetches nothing without it.
A refused request now fails the run.
A non-success status is recorded under refused and not retried.
Before, it stopped the whole run with an error.
[transport] auth now names where each credential goes.
Write { env = "VAR", header = "Name" } or { env = "VAR", query = "param" }.
source check now reports a bare variable name as an error.
--archive adds the nearest Wayback capture as a pinned location.
It needs an enabled pack declaring the wayback scheme.
yidam source list, search and add
yidam source add doi:… writes a draft catalog entry from a pack (#1316).
It follows the scheme's then chain and records each identifier as a location.
The entry is obtained: false, and its body is the pack's eight prompts, unanswered.
Each entry is its own catalog: commit. --fetch then runs catalog-fetch on it.
yidam source search <pack> <query> prints the identifiers a pack's search answers with.
A pack declares that endpoint in a new [search] table. source check holds it to the format.
See Source packs.
Set YIDAM_CONTACT before asking a pack that requires a contact.
It goes in the user agent. source list shows what each pack needs and whether it is set.
--offline answers from a pack's recorded fixtures and asks nothing.
What changes for you: nothing, until you enable a pack.
Source packs, prelude_sources, and yidam source check
A source pack names a family of sources by identifier, such as doi: or pmc: (#1315).
It is a directory holding `pack.to...
cli/v0.18.0
Before you upgrade
index-build moves into vector-read and needs no protoc
index-build no longer writes a LanceDB table, so building an index needs no protoc (#1287).
Nothing ever read that table. Every reader decodes corpus.arrow, which index-build now writes directly.
index-build is now in the vector-read build. index is kept as an alias for it.
An install with --features index or --features full still builds, without protoc.
A vector-read build now lists index in yidam --version and the report's features.
A client that read index as "this build needs protoc" should read it as "this build can make an index".
An index built before this upgrade is still read. Its corpus.lance/ directory is no longer used.
The next index-build removes it.
yidam run plans every epistemic step last
A run that both lands and proposes now proposes at the head it leaves (#1237).
Before, a proposal planned between two landings named a head the branch had already passed.
The next run found no propose/<head> for the new tip, and proposed again.
What changes for you: nothing to do. Dependencies still run first. A step's report may list in a new order.
The cluster base creates the executor's token secret
yidam/cluster/base now creates yidam-<corpus>-run.service-account-token (#1237).
Without it, every pod of a generated workflow waited in Init on a mount that never arrived.
What changes for you: move your base reference to this release's tag. An overlay that copies the base needs the secret too.
See cluster-runs.md.
Regenerate a cluster workflow
A workflow from yidam cluster workflow stopped after its first landing (#1237).
Its expressions named hyphenated tasks with a dot, which Argo could not resolve. Nothing failed, and the run waited.
They now name each task in brackets, as tasks['land-x'].
A run not admitted now ends Succeeded, not in Error. Each task waits for the one before to succeed.
A skipped pin used to let the first step start and read an output nothing wrote.
A CronWorkflow now lists its time under spec.schedules. Argo Workflows 4 refuses the old spec.schedule.
Argo 3.6, the oldest version the run supports, reads either form.
What changes for you: regenerate every committed workflow. Run yidam cluster workflow again with the flags you used.
cluster status reports what a run did, from records
yidam cluster status lists a corpus's recent cluster runs (#1236). For each run it gives the admission and its reason.
Each step is landed, proposed, refused with the lander's reason, or not reached. Each gather peer has its outcome.
It reads the records Argo keeps on each Workflow, through kubectl, and never a log.
See cluster-runs.md.
A refused landing now writes a record to --out. The record holds refused and the lander's reason, and the pod still fails.
What changes for you: nothing, until you upgrade the image. A lander from an older image writes no refusal record.
status shows its refusals as failed, pointing at the pod's message.
A push can submit a cluster run, and every run holds a per-corpus mutex
yidam cluster workflow --on-push github writes an Argo Events EventSource and Sensor (#1235).
A push to the branch submits the same run the cron does, and the run asks admit first.
The lander's own push submits a run too, and that run finds nothing owed.
See cluster-runs.md.
Every generated workflow now holds a mutex, yidam-<corpus>. Two runs of one corpus queue instead of racing.
The field is synchronization.mutexes, which needs Argo Workflows 3.6 or later.
What changes for you: regenerate your workflow, on Argo Workflows 3.6 or later. A manifest written before this upgrade still runs, without the mutex.
Running on push is opt-in. It needs Argo Events and the streamflow-on-push overlay's two extra objects.
An S3 vault can assume a role by web identity
A vault can use a role from IRSA instead of a stored key (#1234). The default vault
assumes AWS_ROLE_ARN with the token in AWS_WEB_IDENTITY_TOKEN_FILE. Another vault names its
own with YIDAM_VAULT_<NAME>_ROLE_ARN and …_WEB_IDENTITY_TOKEN_FILE. It never inherits
AWS_ROLE_ARN. The remote index reads YIDAM_INDEX_ROLE_ARN the same way. See
cli-reference.md and
cluster-runs.md.
What changes for you: nothing, unless you opt in. Keys you export for a vault still win over
an injected role. A vault given both its own role and its own keys is now refused. doctor now
says where each vault's credentials come from.
Fenced clusters need STS. Pods that assume a role call STS first. Add its interface
endpoint's addresses to [cluster.egress] sts, then regenerate the policies.
Update the image first. An older binary refuses .yidam/config.toml once it holds
[cluster.egress] sts.
The lander can push as a GitHub App
yidam cluster land can push with a short-lived GitHub App token instead of a deploy key
(#1233). Set [cluster] git_auth = "github-app" and [cluster.github_app] app_id. Put the
App's key in the write secret as private-key.pem. The lander mints a token for the one
repository, with contents: write, and pushes over HTTPS. See
cluster-runs.md.
What changes for you: nothing, unless you opt in. Deploy keys stay the default. To switch,
regenerate your workflow. If you set [cluster.egress] remote, include the GitHub API's
addresses too.
Update the image first. An older binary refuses .yidam/config.toml once it holds
git_auth or [cluster.github_app].
Cluster pods are labelled by what they may reach, and a new command fences them
yidam cluster workflow labels every pod, and yidam cluster network-policy writes the
policies that select them (#1232). Each pod carries yidam.dev/corpus and yidam.dev/egress:
remote, vault or internet. A step pod, where a calculator runs, reaches the vault and
nothing else. catalog-fetch now runs from its own template, step-catalog-fetch.
What changes for you: regenerate your workflow. Then set the API server's addresses in
[cluster.egress] executor and write the policies into your overlay. An s3:// vault also
needs vault. See cluster-runs.md. Without a
CNI that enforces NetworkPolicy, the policies apply and enforce nothing.
Update the image first. An older binary refuses .yidam/config.toml once it holds
[cluster.egress].
Every generated cluster pod is bounded, and every run is cleaned up
yidam cluster workflow now writes resources, a deadline, retries and cleanup (#1231).
Each pod requests 250m CPU and 512Mi memory, is limited at 2 CPU and 2Gi, and fails after an hour.
pin, survey and step retry twice. land never does. Argo deletes a pod that succeeded,
and a workflow a day after it succeeds or a week after it fails.
What changes for you: regenerate your workflow. Set other sizes in [cluster.pod] and
[cluster.cleanup]. A calculator can set its own under [capability.<name>.cluster].
See cluster-runs.md.
Update the image first. The pods read .yidam/config.toml and .yidam/capabilities.toml.
An older binary refuses either file once it holds one of these tables.
Every generated cluster pod meets the restricted Pod Security Standard
yidam cluster workflow now writes a security context on every template (#1230).
Each pod runs as uid 1000, with a read-only root filesystem and no capabilities.
It writes only to two emptyDir volumes, /tmp/yidam and /home/yidam, and a file:// vault.
What changes for you: regenerate your workflow. A manifest written before this upgrade still runs.
It is refused by a namespace that enforces restricted. See cluster-runs.md.
A cluster corpus deploys with one kubectl apply -k
The objects around a generated workflow are now a Kustomize base and overlay (#1229).
The service account, both git secrets and the vault claim come from yidam/cluster/.
What changes for you: docs/cluster/argo-rbac.yml is gone.
Its objects live in the base, which your overlay names by URL at your cli/v* tag.
Copy the streamflow overlay, set its prefix to your corpus, and add your key files.
Then run kubectl apply -k. See cluster-runs.md.
Objects you already created keep working, since the names are unchanged.
Each corpus on a cluster names its own secrets and service account
yidam cluster workflow now names every object for its corpus, as yidam-<corpus>-<role> (#1228).
Two corpora in one namespace used to share yidam-git-write, so either lander could move the other's refs.
What changes for you: a regenerated workflow refers to new names.
Your cluster still holds yidam-run, yidam-git-read, yidam-git-write and yidam-vault.
Recreate each under its new name, and apply the Kustomize overlay in cluster-runs.md.
Or keep the old names by setting them in [cluster.names]. See configuration.md.
Keep old names only when one corpus runs in the namespace.
A gather runs on a cluster, and each peer's answer has a receipt
yidam cluster workflow now adds a gather's tasks for each file in .yidam/gathers/ (#1217).
Each peer is asked in its own pod, and nothing but the lander holds a git credential.
What changes for you: a local yidam gather now commits receipts too.
They land at .yidam/runs/gather/<name>/<peer>.yml, one per peer that answered or came back empty.
A gather branch you ...
cli/v0.17.0
Before you upgrade
An interval's target may seat more than one
interval: accepts capacity:, naming a property on the exclusive_over target (#1205).
Write capacity: seats on a tenure class. Then an office with seats: 3 may have three
holders at once. A target that omits the property holds one. Quoted digits such as "3" count.
A value that is not a whole number of at least one is reported on the target.
interval-overlap now reports each holder once, naming every earlier holder it overlaps. It
used to report once for each overlapping pair.
A class may declare its interval
interval: names an instance's start and end (#1201). Write start: and end:, each a
date property the class declares. Add exclusive_over: with a relationship from edges:.
No two instances may then link one target by it at once.
A new interval-overlap lint check is an error for each overlapping pair, and for an end before
its start. Intervals are half-open. They compare as query orders dates, at the precision both
sides share. So 1893 and 1893-06-01 meet rather than overlap. An absent end is still open.
Nothing changes until a class declares interval:. A declaration with a misspelled key, or no
end:, is a malformed class.
A new version of a source names the nodes that read the old one
yidam catalog-fetch names every node citing an entry when it records a new version (#1200).
A new version is a digest from a location the entry already held a digest from. The report and
the refresh: commit both list the nodes. The JSON row gains a superseded list.
yidam due gains a fifth clock, superseded. It lists each node citing a source that has
changed since the node was last committed. Set [due] superseded_after in days to let it come
due. A commit touching the node discharges it. A new text reading of a PDF is not a new version.
Nothing needs changing. The clock reads undeclared until the key is set, and still reports
what it measured.
F2 rewrites the moved node's own links
An editor rename between classes now re-relativizes the moved node's links (#1193). Before,
F2 moved the file and rewrote inbound links. It dropped every edit to the moved node itself. A
link written as ./sibling.yml was left pointing into the wrong class. yidam rename was not
affected.
What to do. Run yidam lint after any cross-class F2 rename made before this release.
graph-check reports each link it left dangling.
A class rename keeps its instances' ages
yidam migrate class writes moved-from: into every instance it moves (#1192). Before, a
class rename restarted both commit counts for each instance. Every orphan's escalation clock
reset. Every open question dropped off due's overdue list.
The line is the one yidam rename writes, for example moved-from: ../gage/canyon-outlet.yml.
An instance that already declared one has it replaced. The migrate plan lists each line it adds.
The JSON report gains a moved_from list. Class renames made before this release are not
backfilled.
A renamed node keeps its ages
yidam rename writes moved-from: into the node it moves (#1180). Before, a rename
restarted two counts of commits. One is how long nothing has cited a node, which orphan-in
escalates on. The other is how long a question has stood [open], which due reads. A renamed
overdue question dropped out of due entirely, and its clock read Ok.
The new line names the old path the way a target: does, for example
moved-from: ../concept/low-flow.yml. Both counts now carry across the move. A move that also
adds a citation or answers the question still ends that count. F2 in an editor writes the same
line. A second rename replaces it.
A move made without the command still restarts both counts. To keep them, add the line by hand
in the commit that moves the file. Moves made before this release are not backfilled. The
rename JSON report gains a moved_from object.
A quotation of a PDF is checked against a text reading
New command, yidam catalog-extract (#1172). It takes a text reading of each PDF artifact.
It files the reading in the vault cache and records it under the PDF as text:. It commits the
change as extract:.
Lint compares a quotation of a PDF with that reading. Before, every such quotation was
quotation-unchecked. Now a span missing from the reading is quotation-span-drift, an error.
Run catalog-extract on the machine that holds the PDFs, then run yidam lint.
Nothing changes until you run it. A PDF with no reading stays quotation-unchecked. An older
binary ignores the text: key.
yidam rename moves a catalog entry
yidam rename catalog/old new renames a catalog entry (#1159). Before, the command
took corpus nodes only. Renaming an entry by hand left every edge source: naming its old
stem, which edge-source-unresolved then reported.
The command now moves .yidam/catalog/old.md to new.md and rewrites every citation of it.
An edge source: is rewritten in the spelling its author used, stem or path. A markdown link
under .yidam/ that resolved to the entry is re-relativized from the file that holds it. That
covers node prose, other entries, decision records and the catalog README. On the largest
corpus we measured, one rename rewrote 107 citations across 41 files. Lint was identical
before and after.
Anything that names the old file without linking it is reported and not rewritten. The
report's corpus_dir is .yidam for a catalog entry, and from and to read
catalog/<name>.md. --dry-run prints the plan and changes nothing. Nothing changes for a
corpus node rename.
An edge source: counts as a citation
catalog-uncited and verified-unsourced read edge sources (#1158). Before, only a
links: target or a prose link to a catalog entry counted as a citation. An entry cited only
from edge source: values was reported uncited. A node whose [verified] claim rested on such
an edge was reported unsourced. Yet edge-source-unresolved resolved every one of those edges.
Now the resolver every citation count shares reads edge sources too. It admits the same two
catalog spellings: the entry's file stem, or a path written as a target: is. catalog audit
and the MCP claim surface read the same function, so their counts move with the gate's.
Two checks may change on upgrade. catalog-used-by-drift compares an entry's hand-written
used-by list to the nodes citing it. More citations can mean more drift. On the largest corpus
we measured it rose from 79 to 86 findings, all Warn. catalog-unobtained-but-cited is Error and
now fires for an edge resting on an obtained: false entry. No corpus we measured had one.
The graph report says what omitting a property costs
A new field, omission, on each class property in yidam graph --format json (#1155).
Its value is gates, reported or licensed: the verdict missing-property gives when an
instance omits the property. Before, the report carried only required, one bool. A property
marked required: false and one that said nothing both arrived as false. The web
editor labelled a licensed omission reported.
required is unchanged. The web editor reads omission and labels a licensed property
allowed. Against a binary older than the field, it labels a false property does not
gate rather than guessing. Nothing changes for a corpus.
doctor asks whether the ontology ever stated its contract
A new contract check (#1078). It warns when no property in the ontology says required:.
It also warns when no class with edges says edge_policy:. Either way, missing-property or
unlicensed-edge can warn there and never gate.
Writing the key is the answer, whatever its value. required: false counts, and so does
edge_policy: characteristic. One class answering answers for the whole ontology.
It is a warn, so doctor still exits 0. doctor --strict does not. Of 16 derived
ontologies measured, 14 warn.
doctor --only <id> reports only the named checks. yidam-vendor-update runs
doctor --only contract after it re-vendors. A binary that predates the flag prints nothing
there, so the first re-vendor after an upgrade may stay quiet.
Lint warns on a node linked only to its class
only-instance-of is a new warning (#1072). It reports a node whose only link is to its
own .ont.yml. The finding names the relationships its class declares. Add one of them to
the node, or delete the node if it is a stub.
A class the ontology names only as an edge's target is a leaf by design. Its instances are
exempt. The warning never fails the gate.
A quotation property type
A property may be declared type: quotation (#1070, RFC-0046). Its value names a catalog
entry in of: and holds the copied words in span:. Add sha256: when the entry holds more
than one artifact. quotation-span-drift fails when the entry's cached bytes lack the words.
quotation-unresolved fails when of: or the pin names nothing. Where the bytes are not in
this machine's vault cache, or are not text, quotation-unchecked reports it at Info. A CI
runner with no cache sees only Info findings.
Nothing changes until a class declares the type. A corpus that coined quotation for itself
is now checked against this shape. yidam rename rewrites of: with the entry.
A quotation's of: is a citation of its entry (#1174). catalog-uncited and
verified-unsourced count it, as they count an edge source:.
Lint reports a decision or a URL nothing registers
New Info finding, decision-uncited (#1068). It reports a decision record nothing in the
repository refers to. A markdown link to the record counts. So does its path, decisions/<stem>,
named in any file git tracks, code included. A links: target or an edge source: naming its
id: counts. So does a `decision/...