Cut an IG release as a GitHub draft that carries its packages and AST, and report a version left untagged or unreleased
Gather a release’s files from a full Publisher build (package.tgz and its R4/R4B variants, and ast-data.zip, the IG’s AST with the Libraries’ ELM), say from sushi-config.yaml whether it is a pre-release, and make or refresh the GitHub DRAFT release for the tag with the files uploaded. The owner publishes the draft; a published release is never changed. check is the catch-up the AST refresh of the default branch runs (advisory): it reports a current version with no v<version> tag, naming the commit that set it for the owner to tag, and a tag with no release, for the owner to run ig-release.yml by hand. It never tags and never releases: the tag is the owner’s governance step (ig-release.bpmn).
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-binary-audit, 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 | output | FilesystemPath | assets: the Publisher’s output/ directory. | string · A filesystem path, possibly outside the repository. Not admissible as a command-line argument. | |
| in | ast | FilesystemPath | assets: the AST directory (its manifest.json). | string · A filesystem path, possibly outside the repository. Not admissible as a command-line argument. | |
| in | tag | Text | draft: the git tag the release is for. | string · A short single-line human string. Not admissible as a command-line argument. | |
| in | ig | FilesystemPath | kind, check: the IG root (its sushi-config.yaml and git history). | string · A filesystem path, possibly outside the repository. Not admissible as a command-line argument. | |
| in | repo | Text | draft, check: the repository (owner/repo) whose releases are read or written. | string · A short single-line human string. Not admissible as a command-line argument. | |
| out | release | Text | The files with size and SHA-256 (assets), prerelease/release (kind), what was done (draft), or what the owner should do (check). | 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-release.ts assets|kind|draft|check …. - GitHub Actions. 4 workflow line(s) run its command:
| workflow | line | |
|---|---|---|
fhir-harness/.github/workflows/ig-ast-refresh.yml | 565 | bun run fhir-harness/scripts/ig-release.ts check --ig . --repo "${{ github.repository }}" \\ |
fhir-harness/.github/workflows/ig-release.yml | 124 | bun run fhir-harness/scripts/ig-release.ts assets --output "$IN/output" --ast "$IN/output-ast" --out "$OUT" |
fhir-harness/.github/workflows/ig-release.yml | 125 | kind=$(bun run fhir-harness/scripts/ig-release.ts kind --ig .) |
fhir-harness/.github/workflows/ig-release.yml | 129 | bun run fhir-harness/scripts/ig-release.ts draft --repo "$GITHUB_REPOSITORY" --tag "$TAG" --dir "$OUT" $flag |
As an API: its operation in the OpenAPI document and the MCP tool list of its layer.
| install | none |
| runtime | bun, zip, gh |
| network | yes |
When a host it reaches is refused:
| host / error | remedy |
|---|---|
github.com | none: The releases and tags ARE GitHub’s; offline, assets and kind still run, and check reports the tag from the local clone and the release as unknown. |
| when to choose it | |
|---|---|
| when | When the owner tags an IG version: the IG’s ig-release.yml caller runs it after a full AST build of the tag. check runs in every AST refresh of the default branch. |
| limits | Makes drafts only; publishing is the owner’s step on GitHub. Needs a token that may write the repository’s releases. |
| cost | One full Publisher build (in the workflow), then a few REST calls and the uploads. |
What it is made of
| role | file | |
|---|---|---|
| definition | fhir-harness/tools/ig-release/ig-release.ts | |
| script | fhir-harness/scripts/ig-release.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-release.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-release.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-release",
"title": "Cut an IG release as a GitHub draft that carries its packages and AST, and report a version left untagged or unreleased",
"description": "Gather a release's files from a full Publisher build (package.tgz and its R4/R4B variants, and ast-data.zip, the IG's AST with the Libraries' ELM), say from sushi-config.yaml whether it is a pre-release, and make or refresh the GitHub DRAFT release for the tag with the files uploaded. The owner publishes the draft; a published release is never changed. `check` is the catch-up the AST refresh of the default branch runs (advisory): it reports a current version with no `v<version>` tag, naming the commit that set it for the owner to tag, and a tag with no release, for the owner to run `ig-release.yml` by hand. It never tags and never releases: the tag is the owner's governance step (`ig-release.bpmn`).",
"install": {
"none": true
},
"invoke": {
"shell": "bun run fhir-harness/scripts/ig-release.ts assets|kind|draft|check …"
},
"io": {
"inputs": [
{
"name": "output",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/FilesystemPath",
"description": "`assets`: the Publisher's output/ directory.",
"required": false
},
{
"name": "ast",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/FilesystemPath",
"description": "`assets`: the AST directory (its manifest.json).",
"required": false
},
{
"name": "tag",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Text",
"description": "`draft`: the git tag the release is for.",
"required": false
},
{
"name": "ig",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/FilesystemPath",
"description": "`kind`, `check`: the IG root (its sushi-config.yaml and git history).",
"required": false
},
{
"name": "repo",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Text",
"description": "`draft`, `check`: the repository (`owner/repo`) whose releases are read or written.",
"required": false
}
],
"outputs": [
{
"name": "release",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Text",
"description": "The files with size and SHA-256 (`assets`), `prerelease`/`release` (`kind`), what was done (`draft`), or what the owner should do (`check`)."
}
]
},
"satisfies": [
"ig-binary-artefacts"
],
"requirements": {
"runtime": [
"bun",
"zip",
"gh"
],
"network": true
},
"remedies": [
{
"host": "github.com",
"none": "The releases and tags ARE GitHub's; offline, `assets` and `kind` still run, and `check` reports the tag from the local clone and the release as unknown."
}
],
"selection": {
"when": "When the owner tags an IG version: the IG's `ig-release.yml` caller runs it after a full AST build of the tag. `check` runs in every AST refresh of the default branch.",
"limits": "Makes drafts only; publishing is the owner's step on GitHub. Needs a token that may write the repository's releases.",
"cost": "One full Publisher build (in the workflow), then a few REST calls and the uploads."
}
}