Skip to content

Use _build script instead of _updatePublisher and _genonce #109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cmoesel merged 1 commit into from
Jun 13, 2026
Merged

Use _build script instead of _updatePublisher and _genonce #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions content/docs/SUSHI/project/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,8 @@ These values are then used to generate a project structure compatible with the F
```text
my-project
├── .gitignore
├── _genonce.bat
├── _genonce.sh
├── _updatePublisher.bat
├── _updatePublisher.sh
├── _build_.bat
├── _build_.sh
├── ig.ini
├── input
| ├── ignoreWarnings.txt
Expand Down
12 changes: 6 additions & 6 deletions content/docs/SUSHI/running/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ SUSHI creates only the **fsh-generated** folder, but some of the files shown abo

### Downloading the IG Publisher Scripts

To run the IG Publisher, we recommend downloading the **\_updatePublisher.bat|sh** and **\_genonce.bat|sh** scripts provided by the sample-ig project. To get these scripts, [download the sample-ig project](https://github.com/FHIR/sample-ig/archive/master.zip), unzip it, and copy _all_ of the **.bat** and **.sh** files to the directory above the **fsh-generated** directory (**my-project** in the example above).
To run the IG Publisher, we recommend downloading the **\_build.bat|sh** scripts. To get these scripts, [download the ig-publisher-scripts project](https://github.com/HL7/ig-publisher-scripts/archive/refs/heads/main.zip), unzip it, and copy the **_build.bat** and **_build.sh** files to the directory above the **fsh-generated** directory (**my-project** in the example above).

If you used `sushi init` then these scripts were already downloaded and added to your project.

Expand All @@ -253,17 +253,17 @@ If you used `sushi init` then these scripts were already downloaded and added to
After copying these, change directories in the command prompt to the directory above the **fsh-generated** directory. At the command prompt, enter:

```shell
{{< windows >}} {{< terminal >}} _updatePublisher
{{< windows >}} {{< terminal >}} _build update
```

```shell
{{< apple >}} {{< terminal >}} ./_updatePublisher.sh
{{< apple >}} {{< terminal >}} ./_build.sh update
```

This will download the latest version of the HL7 FHIR IG Publisher tool into the **/input-cache** directory. _This step can be skipped if you already have the latest version of the IG Publisher tool in **input-cache**._

{{% alert title="Tip" color="success" %}}
If you are blocked by a firewall, or if for any reason `_updatePublisher` fails to execute, download the current IG Publisher jar file [here](https://github.com/HL7/fhir-ig-publisher/releases/latest/download/publisher.jar). When the file has downloaded, move it into the **input-cache** directory (which you may need to create as a _sibling_ to the **input** directory).
If you are blocked by a firewall, or if for any reason `_build` fails to execute, download the current IG Publisher jar file [here](https://github.com/HL7/fhir-ig-publisher/releases/latest/download/publisher.jar). When the file has downloaded, move it into the **input-cache** directory (which you may need to create as a _sibling_ to the **input** directory).
{{% /alert %}}

### Running the IG Publisher
Expand All @@ -275,11 +275,11 @@ If you have never run the IG Publisher, you may need to install Jekyll first. Se
After the IG Publisher has been successfully downloaded, execute the following command to run it:

```shell
{{< windows >}} {{< terminal >}} _genonce
{{< windows >}} {{< terminal >}} _build build
```

```shell
{{< apple >}} {{< terminal >}} ./_genonce.sh
{{< apple >}} {{< terminal >}} ./_build.sh build
```

This will run the HL7 IG Publisher, which may take several minutes to complete. After the publisher is finished, open the file **/output/index.html** in a browser to see the resulting IG.
Expand Down
12 changes: 6 additions & 6 deletions content/docs/SUSHI/tutorial/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,14 +81,14 @@ The files generated by SUSHI are located in the **FishExample/fsh-generated** di
At the command prompt, enter:

```shell
{{< windows >}} {{< terminal >}} _updatePublisher
{{< apple >}} {{< terminal >}} ./_updatePublisher.sh
{{< windows >}} {{< terminal >}} _build
{{< apple >}} {{< terminal >}} ./_build.sh
```

This will download the latest version of the HL7 FHIR IG Publisher tool into **./input-cache**. _This step can be skipped if you already have run the command recently, and have the latest version of the IG Publisher tool._

{{% alert title="Tip" color="success" %}}
If you are blocked by a firewall, or if for any reason `_updatePublisher` fails to execute, download the current IG Publisher jar file [here](https://github.com/HL7/fhir-ig-publisher/releases/latest/download/publisher.jar). When the file has downloaded, move it into the directory **/FishExample/input-cache** (creating the directory if necessary).
If you are blocked by a firewall, or if for any reason `_build` fails to execute, download the current IG Publisher jar file [here](https://github.com/HL7/fhir-ig-publisher/releases/latest/download/publisher.jar). When the file has downloaded, move it into the directory **/FishExample/input-cache** (creating the directory if necessary).
{{% /alert %}}

{{% alert title="Warning" color="warning" %}}
Expand All @@ -98,8 +98,8 @@ Before proceeding to the next command: If you have never run the IG Publisher, y
Now run:

```shell
{{< windows >}} {{< terminal >}} _genonce
{{< apple >}} {{< terminal >}} ./_genonce.sh
{{< windows >}} {{< terminal >}} _build build
{{< apple >}} {{< terminal >}} ./_build.sh build
```

This will run the HL7 FHIR IG generator, which may take several minutes to complete.
Expand Down Expand Up @@ -175,7 +175,7 @@ Description: "Codes describing various species of fish, taken from SNOMED-CT."
The rule in the value set definition above selects all codes from SNOMED-CT that are children of the concept "Fish (organism)".
{{% /alert %}}

Run SUSHI again. The count of ValueSets should now be 1. Try generating the IG by running `_genonce` again. Open the file **/FishExample/output/index.html** to see the resulting IG.
Run SUSHI again. The count of ValueSets should now be 1. Try generating the IG by running the `_build` command again. Open the file **/FishExample/output/index.html** to see the resulting IG.

* Do you see where the FishPatient profile is in the IG?
* Does the differential reflect your changes?
Expand Down
Binary file modified content/docs/SUSHI/tutorial/fsh-tutorial.zip
View file
Open in desktop
Binary file not shown.
Loading