MAI-57 + MAI-59: fix secondary version-files docs and stale code comment#19
Merged
Merged
Conversation
added 2 commits
May 25, 2026 07:26
…ne \n) - document real pipe-separated, colon-delimited file:type:pattern format with correct example - drop MAIASS_VERSION_SECONDARY_TYPES (never read by code); mark not implemented - list the three supported type values (pattern, txt, json) and what each does - add multi-line \n note (double-quoted, pattern type only) with caveat it rewrites in place
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.
Ticket
https://velvary.atlassian.net/browse/MAI-57
Problem
docs/configuration.mddescribedMAIASS_VERSION_SECONDARY_FILESas a comma-separated list and documentedMAIASS_VERSION_SECONDARY_TYPESas a real variable. Both are wrong. The code is authoritative.Facts verified in code
MAIASS_VERSION_SECONDARY_FILESis pipe-separated entries, each colon-delimited asfile:type:pattern. Parser:lib/version-manager.js:807-830(pattern = parts.slice(2).join(':')so colons survive in the pattern;\|escapes a literal pipe). Runtime read:lib/version-manager.js:981. Default declared:lib/maiass-variables.js:36.MAIASS_VERSION_SECONDARY_TYPESis never read by any code — its only occurrence was the doc line being removed. The type is the 2nd colon field of each entry.typevalues (lib/version-manager.js:841-884):pattern— regex-escaped literal text with{version}placeholder matched as semver; replaces the version in an existing matching block (does NOT prepend).txt— linestartsWith(pattern), replaces first semver on that line.json— dot-separated key path.\nescape inside a double-quoted value only. The runtime loader (lib/config.js:65/77/88) uses dotenv, which expands\n→ newline only for double-quoted values (node_modules/dotenv/lib/main.js:38-39).Fix
Rewrote the Version Management section of
docs/configuration.md:file:type:patternformat with a correct example.MAIASS_VERSION_SECONDARY_TYPESand explicitly marks it not implemented; also flags that the variable's built-in "comma-separated" description is stale.typevalues and what each does.\nnote (double-quoted,patterntype only) with the workingreadme.txtexample and the caveat that it rewrites the version in place rather than prepending.Scope note
Docs-only change. The stale
description: 'Secondary version files (comma-separated)'string inlib/maiass-variables.js:36is flagged in the docs as stale but left unchanged (out of scope for this docs ticket).MAI-59 (folded in)
https://velvary.atlassian.net/browse/MAI-59
Fixes the stale code comment flagged above: changed the built-in
descriptionforMAIASS_VERSION_SECONDARY_FILESinlib/maiass-variables.jsfrom'Secondary version files (comma-separated)'to'Secondary version files (pipe-separated file:type:pattern entries)', matching the real parser format documented in MAI-57. Comment/metadata only — no behaviour change.🤖 Generated with Claude Code