Measure the IG Publisher’s binary outputs on a pages branch

Read a pages branch’s git tree and report the Publisher’s binary outputs (full-ig.zip, package.tgz and variants, package.db, validator packs, the definitions/examples/expansions zips, spreadsheets) by name: copies, bytes, and how much of it sits in branch previews. Reads the tree, never a checkout, so a multi-gigabyte branch costs a depth-1 fetch.

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-binary-artefacts

Where the IG Publisher’s binary outputs go — full-ig.zip, package.tgz and its R4/R4B variants, package.db, validator packs, and the definitions, examples and expansions zips — and why a pages branch is the wrong place for them. Measure a branch with ig-binary-audit before deciding anything. Read before configuring an IG’s deploy or release step, before linking a download from a page, and before a pages branch grows past its size limit.

Source: fhir-harness/skills/fhir-ig-base/ig-binary-artefacts.md.

Also satisfied by: ig-release, ingest-ig-releases.

The skill declares no I/O contract (schemas/skills/ig-binary-artefacts/{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
inrepoFilesystemPathA clone that has the pages branch fetched.string · A filesystem path, possibly outside the repository. Not admissible as a command-line argument.
inrefTextDefault origin/gh-pages.string · A short single-line human string. Not admissible as a command-line argument.
outauditTextA table, or ig-binary-audit/v1 JSON with --json.string · A short single-line human string. Not admissible as a command-line argument.

Processes and tasks

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

processsteplanevia skill
L3 FHIR IG pipelinePublish the IG sitePublication managerig-binary-artefacts
An IG release: the owner tags, a draft is built, the owner publishesTag the IG’s current versionOwner (release authority, a person)ig-binary-artefacts
An IG release: the owner tags, a draft is built, the owner publishesBuild the tag in full and make the draft releaseIG release (GitHub runner: full build, draft release)ig-binary-artefacts
An IG release: the owner tags, a draft is built, the owner publishesPublish the draft releaseOwner (release authority, a person)ig-binary-artefacts
An IG release: the owner tags, a draft is built, the owner publishesCheck the current version’s tag and releaseRelease check (advisory)ig-binary-artefacts
An IG release: the owner tags, a draft is built, the owner publishesRun IG release (draft) by hand for the tagOwner (release authority, a person)ig-binary-artefacts

How it is deployed and reached

  • Command line. From the repository root: bun run fhir-harness/scripts/ig-binary-audit.ts --repo <checkout> [--ref origin/gh-pages] [--previews branches/] [--json].
  • 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, git
networkno
when to choose it
whenBefore configuring an IG’s deploy or release step, when a pages branch nears its size limit, or before linking a download from a page.
limitsCounts only the Publisher’s own binary names; another large file is in total but not itemised. It measures, and deletes nothing.
costOne git ls-tree over the branch; seconds for 64,000 files.

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-binary-audit.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-binary-audit.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-binary-audit",
  "title": "Measure the IG Publisher's binary outputs on a pages branch",
  "description": "Read a pages branch's git tree and report the Publisher's binary outputs (full-ig.zip, package.tgz and variants, package.db, validator packs, the definitions/examples/expansions zips, spreadsheets) by name: copies, bytes, and how much of it sits in branch previews. Reads the tree, never a checkout, so a multi-gigabyte branch costs a depth-1 fetch.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "bun run fhir-harness/scripts/ig-binary-audit.ts --repo <checkout> [--ref origin/gh-pages] [--previews branches/] [--json]"
  },
  "io": {
    "inputs": [
      {
        "name": "repo",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/FilesystemPath",
        "description": "A clone that has the pages branch fetched.",
        "required": false
      },
      {
        "name": "ref",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Text",
        "description": "Default `origin/gh-pages`.",
        "required": false
      }
    ],
    "outputs": [
      {
        "name": "audit",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Text",
        "description": "A table, or `ig-binary-audit/v1` JSON with `--json`."
      }
    ]
  },
  "satisfies": [
    "ig-binary-artefacts"
  ],
  "requirements": {
    "runtime": [
      "bun",
      "git"
    ],
    "network": false
  },
  "selection": {
    "when": "Before configuring an IG's deploy or release step, when a pages branch nears its size limit, or before linking a download from a page.",
    "limits": "Counts only the Publisher's own binary names; another large file is in `total` but not itemised. It measures, and deletes nothing.",
    "cost": "One `git ls-tree` over the branch; seconds for 64,000 files."
  }
}

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