Skip to content

Commit

Permalink
add latest sushi version and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cybernop committed Nov 7, 2023
1 parent d69efa0 commit dccf075
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 10 deletions.
24 changes: 22 additions & 2 deletions .github/workflows/docker.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,17 @@ jobs:
strategy:
matrix:
base: [alpine, ubuntu]
sushi-version: ["2.10.2", "3.0.0", "3.1.0", "3.2.0", "3.3.0"]
sushi-version:
[
"3.5.0",
"3.4.0",
"3.3.3",
"3.3.0",
"3.2.0",
"3.1.0",
"3.0.0",
"2.10.2",
]
permissions:
contents: read
packages: write
Expand Down Expand Up @@ -179,7 +189,17 @@ jobs:
strategy:
matrix:
base: [alpine, ubuntu]
sushi-version: ["2.10.2", "3.0.0", "3.1.0", "3.2.0", "3.3.0"]
sushi-version:
[
"3.5.0",
"3.4.0",
"3.3.3",
"3.3.0",
"3.2.0",
"3.1.0",
"3.0.0",
"2.10.2",
]
permissions:
contents: read
packages: write
Expand Down
58 changes: 50 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,62 @@

Prebuilt VS Code development containers providing tools to build FHIR profiles using FSH sushi and IGs.

A development container can be used is VS Code by creating a file `.devcontainer/devcontainer.json`. For more information see [https://containers.dev/implementors/json_reference/](https://containers.dev/implementors/json_reference/).
## Images and tags

There are images only containing FSH sushi for building FHIR profiles and images containing FSH sushi and the IG publisher to build a FHIR implementation guide to host on a website.
Available images:

The images containing only sushi are named
* only FSH sushi: `ghcr.io/cybernop/vscode-fhir-devcontainer/fsh-sushi`
* FSH sushi and IG publisher: `ghcr.io/cybernop/vscode-fhir-devcontainer/ig-publisher`

Available tags (`<sushi version>-<os base>`):

* `3.5.0-alpine`
* `3.5.0-ubuntu`
* `3.4.0-alpine`
* `3.4.0-ubuntu`
* `3.3.3-alpine`
* `3.3.3-ubuntu`
* `3.3.0-alpine`
* `3.3.0-ubuntu`
* `3.2.0-alpine`
* `3.2.0-ubuntu`
* `3.1.0-alpine`
* `3.1.0-ubuntu`
* `3.0.0-alpine`
* `3.0.0-ubuntu`
* `2.10.2-alpine`
* `2.10.2-ubuntu`

## Usage

### Simple usage

The easiest way using one of the development containers is by creating `.devcontainer/devcontainer.json` in your project root and set

```json
{
"image": "<image>:<tag>"
}
```
ghcr.io/cybernop/vscode-fhir-devcontainer/fsh-sushi:<sushi version>-<os base>
```

images containing sushi and the IG publisher
### Advanced usage

To modify the base image, e.g. for installing other dependencies, one can create your own `Dockerfile` in `.devcontainer` like:

```Dockerfile
FROM <image>:<tag>

# Do stuff
```
ghcr.io/cybernop/vscode-fhir-devcontainer/ig-publisher:<sushi version>-<os base>

and instead of setting the `image` property in `devcontainer.json` set

```json
{
"build": {
"dockerfile": "Dockerfile"
}
}
```

`<os base>` can be `alpine` or `ubuntu`. `<sushi version>` follow the releases FSH sushi versions. Currently the following versions are supported: `2.10.2`, `3.0.0`, `3.1.0`, `3.2.0`, `3.3.0`.
For more information about dev containers, see [https://containers.dev/implementors/json_reference/](https://containers.dev/implementors/json_reference/).

0 comments on commit dccf075

Please sign in to comment.