Put the IG Publisher’s QA messages in each language an IG translates into, from the Publisher’s own translations first

Fetches the IG Publisher’s own message bundles (Messages_<lang>.properties in org.hl7.fhir.utilities-<core>.jar, Maven Central) at exactly the core version the AST recorded, and translates each QA message by its message-id: the Publisher’s translation where it has one whose placeholders match the English, else this layer’s catalogue translations/<locale>/publisher/messages.po (machine translation, marked as such), else the English. needs --merge appends to each locale’s catalogue the strings a build lacks, each with an example and deep links to the rows that print it. The site build (ig-qa-page.ts) calls it for every locale the IG translates its pages into and publishes qa-messages.<locale>.json and i18n-usage.json beside the QA report.

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-build-pipeline

The bare FHIR IG pipeline — FSH to SUSHI to the IG Publisher to a pages branch, with no pre-processing and no post-processing. What this layer runs, what it emits, and the list of things it deliberately refuses to know about. Owns the AST cache lifecycle: an IG site is built from the AST on its cache branch, the publish refuses a stale one, and the reusable ig-ast-refresh.yml is the one writer. Owns what an IG reader may read: contentTypes.ig.include in the repository’s index.config.json, and the legacy warning for a repository that declares none. Read before adding anything to fhir-harness, before onboarding, converting or changing the workflows of an IG repository, and before publishing an IG site.

Source: fhir-harness/skills/fhir-ig-base/ig-build-pipeline.md.

Also satisfied by: build-ig-site, fhir-core, ig-artifact-jsonld, ig-ast-refresh, ig-index-build, ig-page-render-qa, ig-pages, ig-repo-site, ig-site-data, ingest-ig-menu, jsonld-vocabularies, logical-model-schemas, stage-ig-sites, strip-library-binaries, strip-library-content, terminology-index, valueset-schemas.

The skill declares no I/O contract (schemas/skills/ig-build-pipeline/{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
incommandTextyesfetch <core-version> <dir>, or needs <qa-messages.json> <bundle-dir> <translations-dir> <locale>....string · A short single-line human string. Not admissible as a command-line argument.
inmergeFlagWith needs: append what each locale lacks to its catalogue.boolean · A boolean switch — projects to a bare flag, with no value word
insiteUrlWith needs: the published site’s URL, so a catalogue’s links open the rendered rows.string · format uri · An absolute http(s) URL
outneedsCountStrings each locale lacks a translation for.integer · 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
An IG site, built from the AST on its cache branchRestore and judge the cached ASTSite build (agent, stage-local)ig-build-pipeline
An IG site, built from the AST on its cache branchBuild and publish the site from the ASTSite build (agent, stage-local)ig-build-pipeline
An IG site, built from the AST on its cache branchDispatch AST refreshPublication manager (owner, or the agent the owner delegates to)ig-build-pipeline
Each IG, composed into a host docs site and rendered with just-the-docsBuild each IG’s artefact indexHost docs site build (CI runner)ig-build-pipeline
Each IG, composed into a host docs site and rendered with just-the-docsGenerate each IG instance’s artefact pagesHost docs site build (CI runner)ig-build-pipeline
Each IG, composed into a host docs site and rendered with just-the-docsClone each IG at its recorded commit and stage itHost docs site build (CI runner)ig-build-pipeline

How it is deployed and reached

  • Command line. From the repository root: bun run fhir-harness/scripts/ig-publisher-i18n.ts.
  • GitHub Actions. No workflow in this checkout runs its command.

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

installnone
runtimebun
networkyes

When a host it reaches is refused:

host / errorremedy
repo1.maven.orgnone: No declared Tool replaces Maven Central for the Publisher’s bundles. Put org.hl7.fhir.utilities-<core>.jar’s Messages*.properties in ~/.fhir/publisher-i18n/<core>/ from a machine that reaches it; without them each message falls back to this layer’s catalogue, then English.
when to choose it
whenWhen an IG’s QA report is built for its translated locales, or to see and fill what a locale’s catalogue lacks.
limitsNeeds curl and unzip and Maven Central for the bundles; without them every message falls back to this layer’s catalogue or English, and the build says why. Never substitutes another core version.
costOne jar download (about 3 MB) per core version, cached under ~/.fhir/publisher-i18n.

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-publisher-i18n.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-publisher-i18n.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-publisher-i18n",
  "title": "Put the IG Publisher's QA messages in each language an IG translates into, from the Publisher's own translations first",
  "description": "Fetches the IG Publisher's own message bundles (`Messages_<lang>.properties` in `org.hl7.fhir.utilities-<core>.jar`, Maven Central) at exactly the core version the AST recorded, and translates each QA message by its `message-id`: the Publisher's translation where it has one whose placeholders match the English, else this layer's catalogue `translations/<locale>/publisher/messages.po` (machine translation, marked as such), else the English. `needs --merge` appends to each locale's catalogue the strings a build lacks, each with an example and deep links to the rows that print it. The site build (`ig-qa-page.ts`) calls it for every locale the IG translates its pages into and publishes `qa-messages.<locale>.json` and `i18n-usage.json` beside the QA report.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "bun run fhir-harness/scripts/ig-publisher-i18n.ts"
  },
  "io": {
    "inputs": [
      {
        "name": "command",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Text",
        "description": "`fetch <core-version> <dir>`, or `needs <qa-messages.json> <bundle-dir> <translations-dir> <locale>...`.",
        "required": true
      },
      {
        "name": "merge",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "description": "With `needs`: append what each locale lacks to its catalogue.",
        "required": false,
        "arg": {
          "flag": "--merge"
        }
      },
      {
        "name": "site",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Url",
        "description": "With `needs`: the published site's URL, so a catalogue's links open the rendered rows.",
        "required": false,
        "arg": {
          "flag": "--site"
        }
      }
    ],
    "outputs": [
      {
        "name": "needs",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Count",
        "description": "Strings each locale lacks a translation for."
      }
    ]
  },
  "satisfies": [
    "ig-build-pipeline"
  ],
  "requirements": {
    "runtime": [
      "bun"
    ],
    "network": true
  },
  "remedies": [
    {
      "host": "repo1.maven.org",
      "none": "No declared Tool replaces Maven Central for the Publisher's bundles. Put `org.hl7.fhir.utilities-<core>.jar`'s `Messages*.properties` in `~/.fhir/publisher-i18n/<core>/` from a machine that reaches it; without them each message falls back to this layer's catalogue, then English."
    }
  ],
  "selection": {
    "when": "When an IG's QA report is built for its translated locales, or to see and fill what a locale's catalogue lacks.",
    "limits": "Needs curl and unzip and Maven Central for the bundles; without them every message falls back to this layer's catalogue or English, and the build says why. Never substitutes another core version.",
    "cost": "One jar download (about 3 MB) per core version, cached under ~/.fhir/publisher-i18n."
  }
}

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