firelyteam/Firely.Terminal (GitHub Actions)
Run Firely.Terminal and the offical FHIR Java Validator in a GitHub Actions pipeline
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jun 26, 2026
- License
- MIT
Pinned Snippet
uses: firelyteam/firely-terminal-pipeline@bda77a2f67210e8baa93c400347ffd2d611973f1 # v0.8.15tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| PATH_TO_CONFORMANCE_RESOURCES | Relative paths of the folder(s) containing FHIR Conformance resources (StructureDefinition, ValueSet, CodeSystem) | yes | — |
| PATH_TO_EXAMPLES | Relative paths of the folder(s) containing examples for the FHIR Conformance resources defined by the project | no | — |
| PATH_TO_QUALITY_CONTROL_RULES | Relative path pointing to Quality Control rules. Path MUST not include the .rules.yaml part of the file. Runs minimal.rules.yaml by default. | no | — |
| DOTNET_VALIDATION_ENABLED | Boolean flag to run the .NET validator to validate conformance resources and examples | no | true |
| JAVA_VALIDATION_ENABLED | Boolean flag to run the offical HL7 Java validator to validate conformance resources and examples | no | false |
| EXPECTED_FAILS | Specify which steps in your validation workflow are expected to fail due to possible bugs in the validator(s). Allowed values: VALIDATION_CONFORMANCE_DOTNET, VALIDATION_CONFORMANCE_JAVA, VALIDATION_EXAMPLES_JAVA | no | — |
| JAVA_VALIDATION_OPTIONS | Custom options passed to the Java validator. See https://confluence.hl7.org/display/FHIR/Using+the+FHIR+Validator | no | -output-style compact |
| SIMPLIFIER_USERNAME | Simplifier email address (not username), needed for running Quality Control checks. Please use GitHub Secrets for this variable. | yes | — |
| SIMPLIFIER_PASSWORD | Simplifier password, needed for running Quality Control checks. Please use GitHub Secrets for this variable. | yes | — |
| SUSHI_ENABLED | Boolean flag to run fsh-sushi on the current repository to generated conformance resources based on FHIR shorthand | no | false |
| SUSHI_OPTIONS | Custom options passed to SUSHI. See https://www.npmjs.com/package/fsh-sushi | no | — |
| SUSHI_USE_CONFIG_DEPENDENCIES | When both sushi-config.yaml and package.json exist, set this to true to use sushi-config.yaml as the source-of-truth for dependencies instead of package.json. When false (default), package.json takes precedence if it exists. If only one file exists, that file is used regardless of this setting. | no | false |
| FIRELY_TERMINAL_VERSION | Version of Firely Terminal used for .NET-based validation | yes | 3.5.0 |
| JAVA_VALIDATOR_VERSION | Version of org.hl7.fhir.core library used for Java-based validation | yes | 6.9.12 |
| JAVA_VALIDATOR_DOWNLOAD_LOCATION | URL from which to download the Java validator JAR | — | https://github.com/hapifhir/org.hl7.fhir.core/releases/download/$JAVA_VALIDATOR_VERSION/validator_cli.jar |
| SUSHI_VERSION | Version of SUSHI used for compiling the FSH files | yes | 3.20.0 |
| TERMINOLOGY_SERVICE_BFARM_ENABLED | Enables downloading packages from the central terminology server for Germany (https://terminologien.bfarm.de/fhirpackages.html) | no | false |
| JAVA_SNAPSHOT_ENABLED | Enables creating snapshots for the package dependencies using the Java validator. Snapshots created by Firely Terminal will be disregarded. Does not yet work together with the ZTS_ENABLED setting. | no | false |
| CLOSE_SLICING_FOR_VALIDATION | Constrains all defined element slicings to closed, ensuring that instance elements must conform to one of the declared slices. This strengthens validation by preventing acceptance of elements that do not match the defined slicing discriminators. | no | false |
| FIRELY_TERMINAL_VALIDATOR_ENGINE | Validator engine to use for .NET validation. The new validator engine is used by default since Firely Terminal 3.5.0. Set to "netsdk" to use the old validator engine from pre-3.5.0 versions if needed. Available options: firely, netsdk. | no | — |
Outputs
no outputs