Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qligier/fhir-ig-action
A GitHub Action for FHIR IGs.
https://github.com/qligier/fhir-ig-action
action actions fhir fhir-ig fhir-implementation-guide github-actions ig-publisher problem-matcher sushi
Last synced: about 1 month ago
JSON representation
A GitHub Action for FHIR IGs.
- Host: GitHub
- URL: https://github.com/qligier/fhir-ig-action
- Owner: qligier
- License: mit
- Created: 2023-04-27T18:54:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-22T17:30:13.000Z (3 months ago)
- Last Synced: 2024-10-10T01:05:49.245Z (2 months ago)
- Topics: action, actions, fhir, fhir-ig, fhir-implementation-guide, github-actions, ig-publisher, problem-matcher, sushi
- Language: Shell
- Homepage: https://github.com/marketplace/actions/fhir-ig-action
- Size: 146 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# fhir-ig-action
[](https://github.com/qligier/fhir-ig-action/blob/main/CHANGELOG.md)
This action provides the following functionality for [GitHub Actions](https://docs.github.com/en/actions) users:
- Build a FHIR® Implementation Guide with the [_IG Publisher_](https://github.com/HL7/fhir-ig-publisher/).
- Use the set versions of the [_IG Publisher_](https://github.com/HL7/fhir-ig-publisher/) and
[_SUSHI_](https://github.com/FHIR/sushi) (if needed).
- Matches _IG Publisher_ and _SUSHI_ errors in _GitHub_, to easily spot issues:
[](.github/problem_matcher.png)
See also the live example of a [failing pull request](https://github.com/qligier/simple-test-ig/pull/1/files).
## Usage
The action can be configured with the following inputs:
- ig-publisher
- The version of the IG Publisher to use. The value can be a full version (i.e. x.y.z) or the
keyword 'latest'. The default value is 'latest'. - sushi
- The version of SUSHI to use. The value can be a partial or full version (i.e. x, x.y or
x.y.z), the keyword 'latest', or the keyword 'false' to disable
SUSHI. The default value is 'false'.
### Examples
The following example will build an Implementation Guide with the latest version of the _IG Publisher_, without
_SUSHI_. The _ig.ini_ file is expected in the top directory of the project.
```yaml
name: Build the IG
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: qligier/[email protected]
```
Another example for a _SUSHI_ Implementation Guide, with specific versions:
```yaml
name: Build the IG
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: qligier/[email protected]
with:
ig-publisher: "1.6.25"
sushi: "3.11.1"
```
To build an Implementation Guide in another directory, you should use the
[working-directory](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun)
configuration:
```yaml
name: Build the IG
on: [push, pull_request]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: qligier/[email protected]
working-directory: ./folder/my-ig # This will use ./folder/my-ig/ig.ini
```
## License
This project is released under the [MIT License](https://github.com/qligier/fhir-ig-action/blob/main/LICENSE.txt).
## Development
Issues and pull requests are very welcome :blue_heart:
Code contributions must pass the code checks: [shfmt](https://github.com/patrickvane/shfmt),
[ShellCheck](https://www.shellcheck.net) and [Prettier](https://prettier.io). See the
[GitHub Action file](https://github.com/qligier/fhir-ig-action/blob/main/.github/workflows/verify.yml) for details.
_FHIR® is the registered trademark of HL7 and is used with the permission of HL7._