Building the Specification
This project uses the Gradle Wrapper to build. Gradle Wrapper will take care of downloading an appropriate version of Gradle to build with.
- Be sure you have at least 16 GB of RAM
./gradlew publish(Mac or Linux) or
./gradlew.bat publish(Windows) from the command line
- Wait for it to finish (~20 minutes)
See also: FHIR Build Process
Note: If running commands on the terminal is a frightening prospect for you, we provide executable script files for windows (publish.bat) and mac (publish.sh).
Command line parameters
There are multiple options available for publishing:
--offline: use this arg if you are offline and cannot fetch dependencies
-nogen: don’t generate the spec, just run the validation. (to use this, manually fix things in the publication directory, and then migrate the changes back to source when done. this is a hack)
-noarchive: don’t generate the archive. Don’t use this if you’re a core editor
-web: produce the HL7 ready publication form for final upload (only core editors)
-diff: the executable program to use if platform round-tripping doesn’t produce identical content (default: c:\program files (x86)\WinMerge\WinMergeU.exe)
-name: the “name” to go in the title bar of each of the specification
To add any of these options to the publish task, run the command as
./gradlew publish --args"<YOUR ARGS HERE>"
For example, if you wanted to publish without generating the spec, just running the validation, you would run the command
./gradlew publish --args="-nogen"
Publishing to build.fhir.org
Each time a pull request is open, the pull request pipeline runs. If the pipeline successfully publishes, it uploads the build as a separate branch on build.fhir.org/branches, where it can be reviewed to ensure accuracy.
Once merged to master, the master branch pipeline runs. If successful, the published specification is uploaded to the main build.fhir.org webpage.
The only exception to the above is the build for R4B. The R4B pipline detects changes to the R4B branch in github, and publishes any changes from that branch to build.fhir.org/R4B.