Getting Started with IG Publisher

Overview

This is the code for the HL7 IG publisher: a tool to take a set of inputs and create a standard FHIR IG.

Repository

https://github.com/HL7/fhir-ig-publisher/

This project uses a variety of tools and plugins during its build process. This sometimes requires users to install software and make changes to their IDE so that they can compile.

Prerequisites

Ruby and Jekyll

Ensure you have the latest stable Ruby and Jekyll installed. If you do not have the these installed, please follow the instructions here.

Sushi

Ensure you have the latest stable Sushi installed. If you do not have the Sushi installed, please follow the instructions here

Java

Ensure you have at minimum, the Java 11 JDK installed on your system, and your JAVA_HOME environment variable pointed to the Java SDK. If you do not have the Java JDK installed, please follow the instructions here.

Git

You should clone the project locally using git.

git clone https://github.com/HL7/fhir-ig-publisher.git

You will need a Git CLI or a Git Client installed. A general introduction to Git can be found here

IntelliJ Users

  1. Ensure you have the latest version of Intellij IDEA Community Edition installed. Check the current version on their downloads page.
  2. This project uses lombok annotations to help reduce lines of code in some of the larger classes. You will need to install the lombok plugin. Follow the instructions here.
  3. Follow these steps to import the cloned project:
    • From the main menu, select File -> Open...
    • In the browser dialog pick the fhir-ig-publisher directory (the root of the project)
    • If prompted whether to Trust and Open Project 'fhir-ig-publisher' select Trust Project
    • Select which window you would like to open the project in.

This should enable the building and running of tests in IntelliJ. To verify, in the Maven side panel, right click on HL7 Core Artifacts -> Lifecycle -> clean and select Run Maven Build from the context menu.

Apache NetBeans Users

  1. Follow the steps in the Intellij Users section above.

Eclipse Users

  1. Ensure you have the latest version of Eclipse installed. Check the current version on their downloads page.
  2. This project uses lombok annotations to help reduce lines of code in some of the larger classes. This plugin needs to be manually added to Eclipse. Please follow the instructions on their website to set this up.
  3. Run eclipse and select your Eclipse workspace.
  4. Follow these steps to import the cloned project:
    • From the main menu, select File -> Import...
    • Select Maven -> Existing Maven Projects
    • Click Next
    • Under Select Root Directory, pick the fhir-ig-publisher directory (the root of the project)
    • Click Finish
  5. If you are prompted to install the m2e-connector plugin, or the maven-checkstyle-plugin plugin connector, you should do so, and approve any necessary and valid code signings. You may be asked to restart Eclipse at this point, and you should do so.

This should import the project, and you should be able to build and run of test in the Eclipse IDE. To verify, in the Project drop-down menu, select Clean.... In the Clean window, select the Clean all projects option, and the Start a build immediately and Build the entire workspace options as well. Press Clean to run a full build.

Updated: