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.
| port | type | required | description | constraint | |
|---|---|---|---|---|---|
| in | repo | FilesystemPath | A clone that has the pages branch fetched. | string · A filesystem path, possibly outside the repository. Not admissible as a command-line argument. | |
| in | ref | Text | Default origin/gh-pages. | string · A short single-line human string. Not admissible as a command-line argument. | |
| out | audit | Text | A 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:
| process | step | lane | via skill |
|---|---|---|---|
| L3 FHIR IG pipeline | Publish the IG site | Publication manager | ig-binary-artefacts |
| An IG release: the owner tags, a draft is built, the owner publishes | Tag the IG’s current version | Owner (release authority, a person) | ig-binary-artefacts |
| An IG release: the owner tags, a draft is built, the owner publishes | Build the tag in full and make the draft release | IG release (GitHub runner: full build, draft release) | ig-binary-artefacts |
| An IG release: the owner tags, a draft is built, the owner publishes | Publish the draft release | Owner (release authority, a person) | ig-binary-artefacts |
| An IG release: the owner tags, a draft is built, the owner publishes | Check the current version’s tag and release | Release check (advisory) | ig-binary-artefacts |
| An IG release: the owner tags, a draft is built, the owner publishes | Run IG release (draft) by hand for the tag | Owner (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.
| install | none |
| runtime | bun, git |
| network | no |
| when to choose it | |
|---|---|
| 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. |
What it is made of
| role | file | |
|---|---|---|
| definition | fhir-harness/tools/ig-binary-audit/ig-binary-audit.ts | |
| script | fhir-harness/scripts/ig-binary-audit.ts |
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."
}
}