feat(packages)!: one name for the document-view source — recipe - #515
Merged
Conversation
`skeleton` (document-view-engine), `template` (document-renderer's .ttrs
naming), and the template_id/template_version header fields all named the
same object. It is now `recipe` everywhere in both packages: filenames,
identifiers, comments, package descriptions, and the .ttrs header
(recipe_id/recipe_version). `template` no longer names this object in either
package; contrast usages ("not a template to fill in") are unaffected because
none exist in these packages.
BREAKING: renamed .ttrs header fields template_id/template_version to
recipe_id/recipe_version. Migration recipe: migrations/3.1-to-4.0/ Transform
B, landed ahead of the 4.0.0 cut per CONTRACT.md §10.6, alongside the
pre-staged FGA retirement (Transform A). No adopter .ttrs file exists outside
this repo's own test fixture.
Out of scope: the directive language spec, site copy, and Studio fixtures
(filed separately by the coordinating epic's slicing).
Signed-off-by: transitrix <automation@transitrix.com>
Signed-off-by: transitrix <automation@transitrix.com>
document-renderer-test.yml and document-view-engine-test.yml still ran test_parse_template.mjs / test_parse_skeleton.mjs, which #515 renamed to test_parse_recipe.mjs in each package. document-renderer's step was fixed before this commit; document-view-engine's was missed and failing CI. Signed-off-by: transitrix <automation@transitrix.com>
transitrix
added
the
needs:human-merge
…e-naming Signed-off-by: transitrix <automation@transitrix.com> # Conflicts: # CHANGELOG.md
2 tasks
transitrix
added a commit
that referenced
this pull request
Aug 24, 2026
…e changelog (#520) BREAKING: `notation: fga` / `*.fga.transitrix.yaml` is removed. FGA was deprecated in 2.0.0 (2026-07-12) with removed_in: "4.0.0"; the one-major window (CONTRACT.md §10.6) closed as of 3.0.0, and #515's merged CHANGELOG already stated the retirement was landing "alongside" the recipe-naming change — the actual spec/example deletion and cross-reference cleanup never made it into that commit. This lands it: the FGA spec and example stub are deleted, and every remaining "DGCA / FGA" family reference across notations/, README.md, and patterns/ is updated to name DGCA alone. The migration recipe (Transform A, migrations/3.1-to-4.0/) already covers the adopter-facing side and is unchanged. Signed-off-by: transitrix <automation@transitrix.com>
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
1 participant
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.
From: methodology.
skeleton(document-view-engine),template(document-renderer's.ttrsnaming), and thetemplate_id/template_versionheader fields all named the same object. Renamed torecipeeverywhere in@transitrix/document-view-engineand@transitrix/document-renderer— filenames (parse-template.mjs/parse-skeleton.mjs→parse-recipe.mjs), identifiers (parseSkeleton→parseRecipe), comments, package descriptions, and the.ttrsheader (recipe_id/recipe_version).templateno longer names this object in either package.Breaking change: the
.ttrsheader field rename is a required-field rename underCONTRACT.md§10.2. Migration recipe added as Transform B inmigrations/3.1-to-4.0/, alongside the already-pre-staged FGA retirement (Transform A) — both land ahead of the actual4.0.0cut perCONTRACT.md§10.6. No adopter.ttrsfile exists outside this repo's own test fixture, so the recipe carries nothing real to rewrite today; it ships anyway per the same section.codemod.mjs/validate.mjsextended and verified against newfixtures/before|after/product.mrd.ttrs.CHANGELOG
[Unreleased]states both breaking changes explicitly. Release cutting (the actual MAJOR version bump + tag) is left to the next batched release, matching how recent single-task PRs have landed — this PR only adds the migration recipe and CHANGELOG entry, per the task's acceptance criteria ("shipped as MAJOR, categorised per RELEASING.md").Out of scope, per the task: the directive language spec (
notations/views/documents/), site copy, and Studio fixtures — filed as separate sibling tasks.Verified:
node scripts/check-notations.mjsclean (2 pre-existing unrelated SIZE1 warnings only);node --test packages/document-renderer/tests/*.mjs packages/document-view-engine/tests/*.mjs— 12/12 pass;node --test scripts/check-notations.test.mjs— 92/92 pass. Confirmed no remainingtemplate/skeletonmentions naming this object anywhere in either package.Note for reviewer: while verifying the migration codemod end-to-end I found the pre-existing FGA transform's anchor-insertion regex silently degrades (inserts
view_configat the top instead of aftergenerated_at:) on CRLF-checked-out content — a pre-existing, environment-dependent (Windowsautocrlf=true, no.gitattributespinning this fixture dir to LF) issue unrelated to this task's scope, left unfixed here.Open PR, awaiting merge (Valerii gates).