Render a computed IG AST delta as just-the-docs pages

Write the pages for a delta already computed by ig-ast-diff --json: an index that lists, a page per changed resource that shows, every one opening with the provisional mark and with Liquid in values neutralised.

Skills it satisfies

A skill states the capability; this Tool is one way to exercise it. Each skill’s declared input and output contract follows, where it has one.

ig-ast-delta

List and view what changed between two IG ASTs, check whether an AST is still valid for the IG’s current inputs, and render the delta as just-the-docs pages that carry the provisional mark. Read before trusting a cached AST, before reviewing an incremental IG build, and before rendering anything from a cache.

Source: fhir-harness/skills/fhir-ig-base/ig-ast-delta.md.

Also satisfied by: ig-ast-diff, ig-ast-jsonld, ig-ast-list, ig-ast-pages, ig-ast-plan, ig-ast-validity, ig-cache.

The skill declares no I/O contract (schemas/skills/ig-ast-delta/{input,output}.schema.json).

Inputs and outputs

Each port names a shared type by IRI, so two Tools for one skill can be checked for interchangeability.

porttyperequireddescriptionconstraint
indeltaFilesystemPathyesig-ast-delta/v1, from ig-ast-diff --json.string · A filesystem path, possibly outside the repository. Not admissible as a command-line argument.
insiteFilesystemPathyesstring · A filesystem path, possibly outside the repository. Not admissible as a command-line argument.
outpagesCountinteger · A non-negative count — how many of something, or how many to show. Zero is a real answer.

Processes and tasks

Steps this Tool can carry out, because each names a skill it satisfies:

processsteplanevia skill
Is the incremental IG AST what a full build would have produced?Check the base AST against the inputsIncremental build (system)ig-ast-delta
Is the incremental IG AST what a full build would have produced?Diff the two ASTsIncremental build (system)ig-ast-delta
Is the incremental IG AST what a full build would have produced?Read the deltaQC reviewerig-ast-delta
An IG site, built from the AST on its cache branchRestore and judge the cached ASTSite build (agent, stage-local)ig-ast-delta
SMART Guideline end to endReview each L3 asset (before / after if adapted)Human adjudicatorsig-ast-delta

How it is deployed and reached

  • Command line. From the repository root: bun run fhir-harness/scripts/ig-ast.ts render <delta.json> --site <dir>.
  • GitHub Actions. 11 workflow line(s) run its command:
workflowline
fhir-harness/.github/workflows/ig-ast-refresh.yml173bun run fhir-harness/scripts/ig-ast.ts validity output-ast --ig . > "$RUNNER_TEMP/ast-validity.json"
fhir-harness/.github/workflows/ig-ast-refresh.yml177bun run fhir-harness/scripts/ig-ast.ts cache-line output-ast --ig . 2>/dev/null \|\| true
fhir-harness/.github/workflows/ig-ast-refresh.yml199kind=$(bun run fhir-harness/scripts/ig-ast.ts build-kind output-ast 2>/dev/null \|\| echo full)
fhir-harness/.github/workflows/ig-ast-refresh.yml427&& bun run fhir-harness/scripts/ig-ast.ts validity output-ast --ig . > /dev/null; then
fhir-harness/.github/workflows/ig-ast-refresh.yml430kind=$(bun run fhir-harness/scripts/ig-ast.ts build-kind output-ast 2>/dev/null \|\| echo incremental)
fhir-harness/.github/workflows/ig-ast-refresh.yml433bun run fhir-harness/scripts/ig-ast.ts cache-line output-ast --ig . --warm 2>/dev/null \|\| true
fhir-harness/.github/workflows/ig-ast-refresh.yml459source_digest=$(bun run fhir-harness/scripts/ig-ast.ts digest --ig .) \\
fhir-harness/.github/workflows/ig-ast-refresh.yml498now=$(bun run fhir-harness/scripts/ig-ast.ts digest --ig .)
fhir-harness/.github/workflows/ig-ast-refresh.yml501bun run fhir-harness/scripts/ig-ast.ts source-inputs output-ast --digest "$source_digest" --pre-export "$PRE_EXPORT"
fhir-harness/.github/workflows/ig-ast-refresh.yml505bun run fhir-harness/scripts/ig-ast.ts validity output-ast --ig . \\
fhir-harness/.github/workflows/ig-release.yml123bun run fhir-harness/scripts/ig-ast.ts build-kind "$IN/output-ast" --require-full

As an API: its operation in the OpenAPI document and the MCP tool list of its layer.

installnone
runtimebun
networkno
when to choose it
whenRe-rendering a stored delta without the two ASTs, e.g. into a staging site.
limitsShows what the delta records; it cannot add a differential the delta did not compute.
costMilliseconds per page.

What it is made of

Linked data

The Tool is published as its own JSON-LD document at its IRI, https://litlfred.github.io/folio-assistant/fhir-harness/tools/ig-ast-render.jsonld, partOf its layer’s document. The node below is the definition this page was drawn from, and is embedded in the page as application/ld+json.

{
  "@context": "https://litlfred.github.io/folio-assistant/fhir-harness/fhir-harness.context.jsonld",
  "@id": "https://litlfred.github.io/folio-assistant/fhir-harness/tools/ig-ast-render.jsonld",
  "@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
  "partOf": "https://litlfred.github.io/folio-assistant/fhir-harness/fhir-harness.jsonld",
  "name": "ig-ast-render",
  "title": "Render a computed IG AST delta as just-the-docs pages",
  "description": "Write the pages for a delta already computed by `ig-ast-diff --json`: an index that lists, a page per changed resource that shows, every one opening with the provisional mark and with Liquid in values neutralised.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "bun run fhir-harness/scripts/ig-ast.ts render <delta.json> --site <dir>"
  },
  "io": {
    "inputs": [
      {
        "name": "delta",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/FilesystemPath",
        "description": "`ig-ast-delta/v1`, from `ig-ast-diff --json`.",
        "required": true
      },
      {
        "name": "site",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/FilesystemPath",
        "required": true
      }
    ],
    "outputs": [
      {
        "name": "pages",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Count"
      }
    ]
  },
  "satisfies": [
    "ig-ast-delta"
  ],
  "requirements": {
    "runtime": [
      "bun"
    ],
    "network": false
  },
  "selection": {
    "when": "Re-rendering a stored delta without the two ASTs, e.g. into a staging site.",
    "limits": "Shows what the delta records; it cannot add a differential the delta did not compute.",
    "cost": "Milliseconds per page."
  }
}

folio-assistant — code under the Apache License 2.0, documentation under CC BY 3.0. Generated schema and API references are rebuilt from source on every push to main.

deployed dev